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_XControlInformation_idl__
25#define __com_sun_star_ui_dialogs_XControlInformation_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/** Interface to query for controls and control properties supported by the
41    implementing instance.
42
43    @since OpenOffice 1.1.2
44*/
45published interface XControlInformation: com::sun::star::uno::XInterface
46{
47//-------------------------------------------------------------------------
48/** Query for the supported controls of a service instance.
49
50    @returns
51        a sequence with the names of the supported controls.
52*/
53sequence<string> getSupportedControls( );
54
55//-------------------------------------------------------------------------
56/** Returns whether the specified control is supported or not.
57
58    @param aControlName
59        The name of the control. Common control names are for
60        instance 'OkButton' or 'CancelButton'.
61
62    @returns
63        <TRUE/> if the specified control is supported.
64        <FALSE/> if the specified control is not supported.
65*/
66boolean isControlSupported( [in] string aControlName );
67
68//-------------------------------------------------------------------------
69/** Returns a sequence with properties supported by the specified
70    control.
71
72    @param aControlName
73        The name of the control. Common control names are for
74        instance 'OkButton' or 'CancelButton'.
75
76    @returns
77        a sequence of control properties supported by the specified control.
78
79    @throws com::sun::star::lang::IllegalArgumentException
80        when the specified control is not supported.
81*/
82sequence<string> getSupportedControlProperties( [in] string aControlName )
83    raises( com::sun::star::lang::IllegalArgumentException );
84
85//-------------------------------------------------------------------------
86/** Returns whether control property is supported by a control.
87
88    @param aControlName
89       The name of the control.
90
91    @param aControlProperty
92        The control property to query for.
93
94    @returns
95        <TRUE/> if the specified control action is supported.
96        <FALSE/> if the specified control action is not supported.
97
98    @throws com::sun::star::lang::IllegalArgumentException
99        when the specified control is not supported.
100*/
101boolean isControlPropertySupported( [in] string aControlName, [in] string aControlProperty )
102    raises( com::sun::star::lang::IllegalArgumentException );
103};
104
105}; }; }; }; };
106
107#endif
108