1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__
25#define __com_sun_star_ui_ModuleUICommandDescription_idl__
26
27#ifndef __com_sun_star_container_XNameContainer_idl__
28#include <com/sun/star/container/XNameContainer.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module ui {
34
35//=============================================================================
36
37/** a service which provides window based information about user interface
38    elements of a single application module.
39
40    <p>
41    Every OpenOffice.org module has an amout of user interface elements that can
42    be positioned, resized, closed and their style can be changed. This service
43    provides access to the window based information of available user interface
44    elements which are part of a single OpenOffice.org module, like Writer or
45    Calc.
46    </p>
47
48    @since OpenOffice 2.0
49*/
50
51service ModuleWindowStateConfiguration
52{
53    /** provides read/write access to window based information of user interface
54        elements which are part of single installed module.
55
56        <p>
57        An implementation must provide a <type scope="com::sun::star::uno">Sequence</type> which
58        has <type scope="com::sun::star::beans">PropertyValue</type> as entries. The following
59        entries a defined:
60        <ul>
61            <li><b>Docked</b><br>a boolean which specifies if the window is docked or not.</li>
62            <li><b>DockingArea</b><br>a <type scope="com::sun::star::ui">DockingArea</type>
63            which specifies the docking area where the window is docked.</li>
64            <li><b>DockPos</b><br>a <type scope="com::sun::star::awt">Point</type> which specifies the
65            docked position of a window. The X and Y values are interpreted as a row/column number and
66            a pixel position for top/bottom docked windows. For left/right docked windows this is</li>
67            <li><b>DockSize</b><br>a <type scope="com::sun::star::awt">Size</type> which specifies
68            the docked size of the window. This property is currently not used by the layout manager
69            implementation. For future use.</li>
70            <li><b>Locked</b><br>a boolean which specifies if the window is locked or not. This property
71            is only valid for docked windows</li>
72            <li><b>Pos</b><br>a <type scope="com::sun::star::awt">Point</type> which specifies the
73            floating position in pixel of the window.</li>
74            <li><b>Size</b><br>a <type scope="com::sun::star::awt">Size</type> which specifies the
75            floating size in pixel of the window.</li>
76            <li><b>Style</b><br>a long which specifies the style of the window. A toolbar support the
77            following values: 0 = icons, 1 = text, 2 = text+icons.</li>
78            <li><b>UIName</br><br>a localized string which specifies the default window title.</li>
79        </ul>
80        The key to a user interface element is the resource URL which has
81        the following syntax "private:resource/$type/$name". For example "private:resource/toolbar/standardbar"
82        addresses the standard bar of a module.
83        A complete list of all user interface elements is available in the Developers Guide.
84        </p>
85
86        @see com::sun::star::frame::ModuleManager
87    */
88
89    interface com::sun::star::container::XNameContainer;
90};
91
92}; }; }; };
93
94#endif
95