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_XUIElementSettings_idl__
29#define __com_sun_star_ui_XUIElementSettings_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_container_XIndexAccess_idl__
36#include <com/sun/star/container/XIndexAccess.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module ui {
42
43//=============================================================================
44
45/** provides functions to retrieve and change user interface element structure
46    data and to update its visible representation.
47
48    @since OOo 2.0
49*/
50
51published interface XUIElementSettings : com::sun::star::uno::XInterface
52{
53    /** forces the user interface element to retrieve new settings from its
54        configuration source.
55
56        <p>
57        This is not done automatically as configurable user interface elements
58        are controlled by layout managers. It is more efficient to let the
59        responsible layout manager to control the update process in a single
60        task.
61        </p>
62    */
63    void updateSettings();
64
65    /** provides a <type>UIElementSettings</type> instance that provides access
66        to the structure of user interface element if the user interface element
67        type supports it.
68
69        @param bWriteable
70            must be <TRUE/> if the retrieved settings should be a writeable.
71            Otherwise <FALSE/> should be provided to get a shareable reference
72            to the settings data.
73
74        @return
75            the current settings of the user interface element.
76    */
77    com::sun::star::container::XIndexAccess getSettings( [in] boolean bWriteable );
78
79    /** set changes to the structure of the user interface element.
80
81        @param UISettings
82            new data settings for the configurable user interface element.
83
84
85        <p>
86        User interface elements cannot be changed directly. The changed structure
87        data has to be set again. This speeds up the configuration process if many
88        changes have to be made on the structure. The persistence of changes are
89        controlled by the boolean property <member>Persistent</member>.
90
91        </p>
92
93        @see com::sun::star::ui::UIElementSettings
94    */
95    void setSettings( [in] com::sun::star::container::XIndexAccess UISettings );
96};
97
98}; }; }; };
99
100//=============================================================================
101
102#endif
103