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