summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ui/theWindowStateConfiguration.idl
blob: b8d257b0c461dff118342ee55a26da82c45e42d8 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_ui_theWindowStateConfiguration_idl__
#define __com_sun_star_ui_theWindowStateConfiguration_idl__

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


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


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

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

    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 com::sun::star::container::XNameAccess::getByName() function.
    The module specifier can be retrieved from the com::sun::star::frame::ModuleManager
    service. The interface provides references to a com::sun:star::ui::ModuleWindowStateConfiguration.
    </p>

    Prior to LibreOffice 4.3, this singleton was only available as a
    (single-instance) WindowStateConfiguration service.

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

    @since LibreOffice 4.3
*/

singleton theWindowStateConfiguration : com::sun::star::container::XNameAccess;

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */