summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ui/WindowStateConfiguration.idl
blob: c5243e4144faed33087e9d4d7d99e1a18faeacab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*************************************************************************
 *
 * 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_ui_WindowStateConfiguration_idl__
#define __com_sun_star_ui_WindowStateConfiguration_idl__

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif

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

module com { module sun { module star { module ui {

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

/** a service which provides window based information about user interface
    elements.

    <p>
    OpenOffice.org has an amout of user interface elements that can be positioned,
    resized, closed and their style can be changed. This service provides access
    to the window based information of available user interface elements which are
    part of OpenOffice.org modules, like Writer or Calc.
    </p>

    @since OOo 2.0.0
*/

service WindowStateConfiguration
{
    /** provides access to window based information about user interface elements
        of all installed application modules.

        <p>
        To access the window based information of a module, a unique module specifier
        must be provided to <member scope="com::sun::star::container">XNameAccess::getByName()</member> function.
        The module specifier can be retrieved from the <type scope="com::sun::star::frame">ModuleManager</type>
        service. The interface provides references to a <type scope="com::sun:star::ui">ModuleWindowStateConfiguration</type>.
        </p>

        @see com::sun::star::frame::ModuleManager
    */

    interface com::sun::star::container::XNameAccess;
};

}; }; }; };

#endif