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