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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*************************************************************************
*
* $RCSfile: XFilePickerControlAccess.idl,v $
*
* $Revision: 1.3 $
*
* last change: $Author: tra $ $Date: 2001-12-12 11:10:11 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__
#define __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__
#ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__
#include <com/sun/star/ui/dialogs/XFilePicker.idl>
#endif
//=============================================================================
module com { module sun { module star { module ui { module dialogs {
//=============================================================================
/** Specifies extension of a file picker.
<p> A FilePicker may contain additional elements according to the needs
of the different applications. These additional elements can be
addresed by this interface.</p>
*/
interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker
{
//-------------------------------------------------------------------------
/** Set the value of an additional element within a FilePicker.
@param ControlId
Identifies the element which value is to be set.
@param aControlAction
Specifies an action to perform with the given value.
aControlAction has to be one of the values defined in <type>ControlActions</type>.
Not all of the values are valid for all controls.
To add a new filter to the FilePicker use the interface XFilterManager, but
optionally an implementation may also support adding new filter using this
method.
@param aValue
The value to set. For checkboxes aValue should be a boolean, which
should be true if the checkbox should be checked else false.
@see ControlActions
*/
void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue );
//-------------------------------------------------------------------------
/** Get the value of an additional element within a FilePicker
@param aControlId
Identifies the element which value is to set.
@param aControlAction
Specifies which value to retrieve.
aControlAction has to be one of the values defined in <type>ControlActions</type>.
Not all of the values are valid for all controls.
To get the currently selected filter of the FilePicker use the interface
XFilterManager, but optionally an implementation may also return the currently
selected filter through this method.
@returns
The value of the specified element. If the specified control
is a checkbox the returned value is a boolean, which is true
if the checkbox is checked else false.
If the specified element doesn't exist or the specified element
doesn't support the specidfied control action an empty any will be
returned.
*/
any getValue( [in] short aControlId, [in] short aControlAction );
//-------------------------------------------------------------------------
/** Set the label of the specified element. If the specified element
doesn't support setting a label, this method has no effect.
*/
void setLabel( [in] short aControlId, [in] string aLabel );
//-------------------------------------------------------------------------
/** Returns the lable of the specified element.
@returns
The label of the specified element or an empty string if
the specified element has no or supports no label or the
specified element doesn't exist.
*/
string getLabel( [in] short aControlId );
//-------------------------------------------------------------------------
/** Enables or disables a control.
@param ControlId
Identifies the control.
@param bEnable
If true the specified control will be enabled.
If false the specified control will be disabled.
*/
void enableControl( [in] short aControlId, [in] boolean bEnable );
};
//=============================================================================
}; }; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.2 2001/10/26 08:47:39 fs
#92988# get/setValue now using ControlActions instead of ListboxControlActions
Revision 1.1 2001/08/30 10:20:44 tra
#88584#moved from drafts
Revision 1.4 2001/07/02 08:05:54 tra
removed IllegalArgumentException specification from interface methods
Revision 1.3 2001/06/08 09:06:31 tra
*** empty log message ***
Revision 1.2 2001/06/07 14:04:30 tra
*** empty log message ***
Revision 1.1 2001/06/06 15:01:02 tra
new dialogs interfaces
Revision 1.1 2001/04/10 06:43:06 tra
replacement for XExtendedFilePicker
Revision 1.4 2001/03/16 16:41:51 jsc
remove interfaceheader with uik and remove [const] in method definitions
Revision 1.3 2000/11/08 12:45:14 mi
moved from api
Revision 1.2 2000/10/20 07:58:15 tra
minor changed and improvment of the documentation
Revision 1.1.1.1 2000/09/18 23:36:17 hjs
initial import
Revision 1.1 2000/09/05 14:55:11 tra
initial version filepicker interface
=============================================================================*/
#endif
|
