xref: /aoo42x/main/offapi/com/sun/star/embed/XHatchWindowController.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_embed_XHatchWindowController_idl__
#define __com_sun_star_embed_XHatchWindowController_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_Rectangle_idl__
#include <com/sun/star/awt/Rectangle.idl>
#endif

//============================================================================

 module com {  module sun {  module star {  module embed {

//============================================================================

/** specifies the operations for a hatch window.

	<p>
	A hatch window owner is responsible to handle resize/move requests
	sent by the window. It is also responsible to validate tracking
	rectangle size.
    </p>
 */
published interface XHatchWindowController: com::sun::star::uno::XInterface
{
	//------------------------------------------------------------------------
	/** requests window owner to resize/move the window.

		@param aRect
			the new requested position and size of the window
	 */
	void requestPositioning( [in] com::sun::star::awt::Rectangle aRect );

	//------------------------------------------------------------------------
	/** returns the closest valid rectangle to the provided one.

		@param aRect
			a new selected position and size of the tracking rectangle

		@returns
			the closest valid position and size to the provided one
	 */
	com::sun::star::awt::Rectangle calcAdjustedRectangle(
					[in] com::sun::star::awt::Rectangle aRect );

    void activated();
    void deactivated();
};

//============================================================================

}; }; }; };

#endif