1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__
25cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__
28cdf0e10cSrcweir#include <com/sun/star/ui/dialogs/XFilePicker.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweir
33cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs {
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir/** Provides access to the controls of a FilePicker.
37cdf0e10cSrcweir
38cdf0e10cSrcweir	<p> A FilePicker may contain additional elements according to the needs
39cdf0e10cSrcweir		of the different applications. These additional elements can be
40cdf0e10cSrcweir		addressed by this interface.</p>
41cdf0e10cSrcweir
42cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::FilePicker
43cdf0e10cSrcweir*/
44cdf0e10cSrcweirpublished interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker
45cdf0e10cSrcweir{
46cdf0e10cSrcweir
47cdf0e10cSrcweir//-------------------------------------------------------------------------
48cdf0e10cSrcweir/** Set the value of an additional element within a FilePicker.
49cdf0e10cSrcweir
50cdf0e10cSrcweir	@param ControlId
51cdf0e10cSrcweir	Identifies the element which value is to be set.
52cdf0e10cSrcweir
53cdf0e10cSrcweir	@param aControlAction
54cdf0e10cSrcweir		Specifies an action to perform with the given value.
55cdf0e10cSrcweir		aControlAction has to be one of the values defined in <type>ControlActions</type>.
56cdf0e10cSrcweir		Not all of the values are valid for all controls.
57cdf0e10cSrcweir		To add a new filter to the FilePicker use the interface XFilterManager, but
58cdf0e10cSrcweir		optionally an implementation may also support adding new filter using this
59cdf0e10cSrcweir		method.
60cdf0e10cSrcweir
61cdf0e10cSrcweir	@param aValue
62cdf0e10cSrcweir	The value to set. For checkboxes aValue should be a boolean value that
63cdf0e10cSrcweir	should be <TRUE/> if the checkbox should be checked and <FALSE/> otherwise.
64cdf0e10cSrcweir
65cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
66cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
67cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::ControlActions
68cdf0e10cSrcweir*/
69cdf0e10cSrcweirvoid setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue );
70cdf0e10cSrcweir
71cdf0e10cSrcweir//-------------------------------------------------------------------------
72cdf0e10cSrcweir/** Get the value of an additional element within a FilePicker
73cdf0e10cSrcweir
74cdf0e10cSrcweir	@param aControlId
75cdf0e10cSrcweir	Identifies the element for which value is requested.
76cdf0e10cSrcweir
77cdf0e10cSrcweir	@param aControlAction
78cdf0e10cSrcweir	Specifies which value to retrieve.
79cdf0e10cSrcweir	aControlAction has to be one of the values defined in <type>ControlActions</type>.
80cdf0e10cSrcweir	Not all of the values are valid for all controls.
81cdf0e10cSrcweir
82cdf0e10cSrcweir	@returns
83cdf0e10cSrcweir	The value of the specified element. If the specified control
84cdf0e10cSrcweir	is a checkbox the returned value is a boolean that is <TRUE/>
85cdf0e10cSrcweir	if the checkbox is checked <FALSE/> otherwise.
86cdf0e10cSrcweir	If the specified element doesn't exist or the specified element
87cdf0e10cSrcweir	doesn't support the specidfied control action an empty any will be
88cdf0e10cSrcweir	returned.
89cdf0e10cSrcweir
90cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
91cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
92cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::ControlActions
93cdf0e10cSrcweir*/
94cdf0e10cSrcweirany getValue( [in] short aControlId, [in] short aControlAction );
95cdf0e10cSrcweir
96cdf0e10cSrcweir//-------------------------------------------------------------------------
97cdf0e10cSrcweir/** Set the label of the specified element. If the specified element
98cdf0e10cSrcweir	doesn't support setting a label, this method has no effect.
99cdf0e10cSrcweir
100cdf0e10cSrcweir	@param aControlId
101cdf0e10cSrcweir	Identifies the element for which the label should be set.
102cdf0e10cSrcweir
103cdf0e10cSrcweir	@param aLabel
104cdf0e10cSrcweir	The label to be set.
105cdf0e10cSrcweir
106cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
107cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
108cdf0e10cSrcweir*/
109cdf0e10cSrcweirvoid setLabel( [in] short aControlId, [in] string aLabel );
110cdf0e10cSrcweir
111cdf0e10cSrcweir//-------------------------------------------------------------------------
112cdf0e10cSrcweir/** Returns the label of the specified element.
113cdf0e10cSrcweir
114cdf0e10cSrcweir	@param aControlId
115cdf0e10cSrcweir	Identifies the element for which the label should be returned.
116cdf0e10cSrcweir
117cdf0e10cSrcweir	@returns
118cdf0e10cSrcweir	The label of the specified element or an empty string if
119cdf0e10cSrcweir	the specified element has no or supports no label or the
120cdf0e10cSrcweir	specified element doesn't exist.
121cdf0e10cSrcweir
122cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
123cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
124cdf0e10cSrcweir*/
125cdf0e10cSrcweirstring getLabel( [in] short aControlId );
126cdf0e10cSrcweir
127cdf0e10cSrcweir//-------------------------------------------------------------------------
128cdf0e10cSrcweir/** Enables or disables a control.
129cdf0e10cSrcweir
130cdf0e10cSrcweir    @param ControlId
131cdf0e10cSrcweir	Identifies the control.
132cdf0e10cSrcweir
133cdf0e10cSrcweir	@param bEnable
134cdf0e10cSrcweir	<p>If <TRUE/> the specified control will be enabled.</p>
135cdf0e10cSrcweir	<p>If <FALSE/> the specified control will be disabled.</p>
136cdf0e10cSrcweir
137cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
138cdf0e10cSrcweir	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
139cdf0e10cSrcweir*/
140cdf0e10cSrcweirvoid enableControl( [in] short aControlId, [in] boolean bEnable );
141cdf0e10cSrcweir};
142cdf0e10cSrcweir
143cdf0e10cSrcweir//=============================================================================
144cdf0e10cSrcweir
145cdf0e10cSrcweir}; }; }; }; };
146cdf0e10cSrcweir
147cdf0e10cSrcweir
148cdf0e10cSrcweir#endif
149cdf0e10cSrcweir
150