blob: cf4210fcf3edf6451f321d9fc5df07d3d3605ed0 (
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XControlInformation.idl,v $
* $Revision: 1.9 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ui_dialogs_XControlInformation_idl__
#define __com_sun_star_ui_dialogs_XControlInformation_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
//=============================================================================
module com { module sun { module star { module ui { module dialogs {
//=============================================================================
/** Interface to query for controls and control properties supported by the
implementing instance.
@since OOo 1.1.2
*/
published interface XControlInformation: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** Query for the supported controls of a service instance.
@returns
a sequence with the names of the supported controls.
*/
sequence<string> getSupportedControls( );
//-------------------------------------------------------------------------
/** Returns whether the specified control is supported or not.
@param aControlName
The name of the control. Common control names are for
instance 'OkButton' or 'CancelButton'.
@returns
<TRUE/> if the specified control is supported.
<FALSE/> if the specified control is not supported.
*/
boolean isControlSupported( [in] string aControlName );
//-------------------------------------------------------------------------
/** Returns a sequence with properties supported by the specified
control.
@param aControlName
The name of the control. Common control names are for
instance 'OkButton' or 'CancelButton'.
@returns
a sequence of control properties supported by the specified control.
@throws com::sun::star::lang::IllegalArgumentException
when the specified control is not supported.
*/
sequence<string> getSupportedControlProperties( [in] string aControlName )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** Returns whether control property is supported by a control.
@param aControlName
The name of the control.
@param aControlProperty
The control property to query for.
@returns
<TRUE/> if the specified control action is supported.
<FALSE/> if the specified control action is not supported.
@throws com::sun::star::lang::IllegalArgumentException
when the specified control is not supported.
*/
boolean isControlPropertySupported( [in] string aControlName, [in] string aControlProperty )
raises( com::sun::star::lang::IllegalArgumentException );
};
}; }; }; }; };
#endif
|