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_XFilePickerControlAccess_idl__
25#define __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__
26
27#ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__
28#include <com/sun/star/ui/dialogs/XFilePicker.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module ui { module dialogs {
34
35//=============================================================================
36/** Provides access to the controls of a FilePicker.
37
38	<p> A FilePicker may contain additional elements according to the needs
39		of the different applications. These additional elements can be
40		addressed by this interface.</p>
41
42	@see com::sun::star::ui::dialogs::FilePicker
43*/
44published interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker
45{
46
47//-------------------------------------------------------------------------
48/** Set the value of an additional element within a FilePicker.
49
50	@param ControlId
51	Identifies the element which value is to be set.
52
53	@param aControlAction
54		Specifies an action to perform with the given value.
55		aControlAction has to be one of the values defined in <type>ControlActions</type>.
56		Not all of the values are valid for all controls.
57		To add a new filter to the FilePicker use the interface XFilterManager, but
58		optionally an implementation may also support adding new filter using this
59		method.
60
61	@param aValue
62	The value to set. For checkboxes aValue should be a boolean value that
63	should be <TRUE/> if the checkbox should be checked and <FALSE/> otherwise.
64
65	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
66	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
67	@see com::sun::star::ui::dialogs::ControlActions
68*/
69void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue );
70
71//-------------------------------------------------------------------------
72/** Get the value of an additional element within a FilePicker
73
74	@param aControlId
75	Identifies the element for which value is requested.
76
77	@param aControlAction
78	Specifies which value to retrieve.
79	aControlAction has to be one of the values defined in <type>ControlActions</type>.
80	Not all of the values are valid for all controls.
81
82	@returns
83	The value of the specified element. If the specified control
84	is a checkbox the returned value is a boolean that is <TRUE/>
85	if the checkbox is checked <FALSE/> otherwise.
86	If the specified element doesn't exist or the specified element
87	doesn't support the specidfied control action an empty any will be
88	returned.
89
90	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
91	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
92	@see com::sun::star::ui::dialogs::ControlActions
93*/
94any getValue( [in] short aControlId, [in] short aControlAction );
95
96//-------------------------------------------------------------------------
97/** Set the label of the specified element. If the specified element
98	doesn't support setting a label, this method has no effect.
99
100	@param aControlId
101	Identifies the element for which the label should be set.
102
103	@param aLabel
104	The label to be set.
105
106	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
107	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
108*/
109void setLabel( [in] short aControlId, [in] string aLabel );
110
111//-------------------------------------------------------------------------
112/** Returns the label of the specified element.
113
114	@param aControlId
115	Identifies the element for which the label should be returned.
116
117	@returns
118	The label of the specified element or an empty string if
119	the specified element has no or supports no label or the
120	specified element doesn't exist.
121
122	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
123	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
124*/
125string getLabel( [in] short aControlId );
126
127//-------------------------------------------------------------------------
128/** Enables or disables a control.
129
130    @param ControlId
131	Identifies the control.
132
133	@param bEnable
134	<p>If <TRUE/> the specified control will be enabled.</p>
135	<p>If <FALSE/> the specified control will be disabled.</p>
136
137	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
138	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
139*/
140void enableControl( [in] short aControlId, [in] boolean bEnable );
141};
142
143//=============================================================================
144
145}; }; }; }; };
146
147
148#endif
149
150