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_dialogs_XControlAccess_idl__
25#define __com_sun_star_ui_dialogs_XControlAccess_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_lang_IllegalArgumentException_idl__
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module ui { module dialogs {
38
39//=============================================================================
40/** Generic control access interface.
41
42	<p>Use this interface to access user interface controls supported
43        by the implementing service. The supported controls, control
44        properties and the appropriate values are documented in the
45        decription of the implementing service.</p>
46
47    @see com::sun::star::ui::dialogs::FilePicker
48    @see com::sun::star::ui::dialogs::FilePicker
49
50    @since OpenOffice 1.1.2
51*/
52published interface XControlAccess: com::sun::star::uno::XInterface
53{
54//-------------------------------------------------------------------------
55/** Change a control property.
56
57    @param aControlName
58        The name of the control. Common control names are for
59        instance 'OkButton' or 'CancelButton'.
60
61    @param aControlProperty
62        The control property to manipulate. Common control properties
63        are for instance 'Label' or 'State'.
64
65    @param aValue
66        A value appropriated for the property.
67
68    @throws com::sun::star::lang::IllegalArgumentException
69        when the control is not supported, the control property is invalid or
70        the value fits not the control action.
71*/
72void setControlProperty( [in] string aControlName, [in] string aControlProperty, [in] any aValue )
73    raises( com::sun::star::lang::IllegalArgumentException );
74
75//-------------------------------------------------------------------------
76/** Query for a control property.
77
78    @param aControlName
79       The name of the control. Common control names are for
80        instance 'OkButton' or 'CancelButton'.
81
82    @param aControlProperty
83        The requested control property. Common control properties
84        are for instance 'Label' or 'State'.
85
86    @returns
87        the requested value.
88
89    @throws com::sun::star::lang::IllegalArgumentException
90        when the control is not supported or the control property is invalid.
91*/
92any getControlProperty( [in] string aControlName, [in] string aControlProperty )
93    raises( com::sun::star::lang::IllegalArgumentException );
94};
95
96//=============================================================================
97
98}; }; }; }; };
99
100#endif
101
102