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
28#ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__
29#define __com_sun_star_ui_ModuleUICommandDescription_idl__
30
31#ifndef __com_sun_star_container_XNameContainer_idl__
32#include <com/sun/star/container/XNameContainer.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module ui {
38
39//=============================================================================
40
41/** a service which provides window based information about user interface
42    elements of a single application module.
43
44    <p>
45    Every OpenOffice.org module has an amout of user interface elements that can
46    be positioned, resized, closed and their style can be changed. This service
47    provides access to the window based information of available user interface
48    elements which are part of a single OpenOffice.org module, like Writer or
49    Calc.
50    </p>
51
52    @since OOo 2.0
53*/
54
55service ModuleWindowStateConfiguration
56{
57    /** provides read/write access to window based information of user interface
58        elements which are part of single installed module.
59
60        <p>
61        An implementation must provide a <type scope="com::sun::star::uno">Sequence</type> which
62        has <type scope="com::sun::star::beans">PropertyValue</type> as entries. The following
63        entries a defined:
64        <ul>
65            <li><b>Docked</b><br>a boolean which specifies if the window is docked or not.</li>
66            <li><b>DockingArea</b><br>a <type scope="com::sun::star::ui">DockingArea</type>
67            which specifies the docking area where the window is docked.</li>
68            <li><b>DockPos</b><br>a <type scope="com::sun::star::awt">Point</type> which specifies the
69            docked position of a window. The X and Y values are interpreted as a row/column number and
70            a pixel position for top/bottom docked windows. For left/right docked windows this is</li>
71            <li><b>DockSize</b><br>a <type scope="com::sun::star::awt">Size</type> which specifies
72            the docked size of the window. This property is currently not used by the layout manager
73            implementation. For future use.</li>
74            <li><b>Locked</b><br>a boolean which specifies if the window is locked or not. This property
75            is only valid for docked windows</li>
76            <li><b>Pos</b><br>a <type scope="com::sun::star::awt">Point</type> which specifies the
77            floating position in pixel of the window.</li>
78            <li><b>Size</b><br>a <type scope="com::sun::star::awt">Size</type> which specifies the
79            floating size in pixel of the window.</li>
80            <li><b>Style</b><br>a long which specifies the style of the window. A toolbar support the
81            following values: 0 = icons, 1 = text, 2 = text+icons.</li>
82            <li><b>UIName</br><br>a localized string which specifies the default window title.</li>
83        </ul>
84        The key to a user interface element is the resource URL which has
85        the following syntax "private:resource/$type/$name". For example "private:resource/toolbar/standardbar"
86        addresses the standard bar of a module.
87        A complete list of all user interface elements is available in the Developers Guide.
88        </p>
89
90        @see com::sun::star::frame::ModuleManager
91    */
92
93    interface com::sun::star::container::XNameContainer;
94};
95
96}; }; }; };
97
98#endif
99