xref: /trunk/main/offapi/com/sun/star/embed/XHatchWindowController.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_embed_XHatchWindowController_idl__
28#define __com_sun_star_embed_XHatchWindowController_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_awt_Rectangle_idl__
35#include <com/sun/star/awt/Rectangle.idl>
36#endif
37
38//============================================================================
39
40 module com {  module sun {  module star {  module embed {
41
42//============================================================================
43
44/** specifies the operations for a hatch window.
45
46    <p>
47    A hatch window owner is responsible to handle resize/move requests
48    sent by the window. It is also responsible to validate tracking
49    rectangle size.
50    </p>
51 */
52published interface XHatchWindowController: com::sun::star::uno::XInterface
53{
54    //------------------------------------------------------------------------
55    /** requests window owner to resize/move the window.
56
57        @param aRect
58            the new requested position and size of the window
59     */
60    void requestPositioning( [in] com::sun::star::awt::Rectangle aRect );
61
62    //------------------------------------------------------------------------
63    /** returns the closest valid rectangle to the provided one.
64
65        @param aRect
66            a new selected position and size of the tracking rectangle
67
68        @returns
69            the closest valid position and size to the provided one
70     */
71    com::sun::star::awt::Rectangle calcAdjustedRectangle(
72                    [in] com::sun::star::awt::Rectangle aRect );
73
74    void activated();
75    void deactivated();
76};
77
78//============================================================================
79
80}; }; }; };
81
82#endif
83
84