offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFilePickerControlAccess.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__
  32 #define __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__
  33
  34 #ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__
  35 #include <com/sun/star/ui/dialogs/XFilePicker.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ui { module dialogs {
  41
  42 //=============================================================================
  43 /** Provides access to the controls of a FilePicker.
  44
  45     <p> A FilePicker may contain additional elements according to the needs
  46         of the different applications. These additional elements can be
  47         addressed by this interface.</p>
  48
  49     @see com::sun::star::ui::dialogs::FilePicker
  50 */
  51 published interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker
  52 {
  53
  54 //-------------------------------------------------------------------------
  55 /** Set the value of an additional element within a FilePicker.
  56
  57     @param ControlId
  58     Identifies the element which value is to be set.
  59
  60     @param aControlAction
  61         Specifies an action to perform with the given value.
  62         aControlAction has to be one of the values defined in <type>ControlActions</type>.
  63         Not all of the values are valid for all controls.
  64         To add a new filter to the FilePicker use the interface XFilterManager, but
  65         optionally an implementation may also support adding new filter using this
  66         method.
  67
  68     @param aValue
  69     The value to set. For checkboxes aValue should be a boolean value that
  70     should be <TRUE/> if the checkbox should be checked and <FALSE/> otherwise.
  71
  72     @see com::sun::star::ui::dialogs::CommonFilePickerElementIds
  73     @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
  74     @see com::sun::star::ui::dialogs::ControlActions
  75 */
  76 void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue );
  77
  78 //-------------------------------------------------------------------------
  79 /** Get the value of an additional element within a FilePicker
  80
  81     @param aControlId
  82     Identifies the element for which value is requested.
  83
  84     @param aControlAction
  85     Specifies which value to retrieve.
  86     aControlAction has to be one of the values defined in <type>ControlActions</type>.
  87     Not all of the values are valid for all controls.
  88
  89     @returns
  90     The value of the specified element. If the specified control
  91     is a checkbox the returned value is a boolean that is <TRUE/>
  92     if the checkbox is checked <FALSE/> otherwise.
  93     If the specified element doesn't exist or the specified element
  94     doesn't support the specidfied control action an empty any will be
  95     returned.
  96
  97     @see com::sun::star::ui::dialogs::CommonFilePickerElementIds
  98     @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
  99     @see com::sun::star::ui::dialogs::ControlActions
 100 */
 101 any getValue( [in] short aControlId, [in] short aControlAction );
 102
 103 //-------------------------------------------------------------------------
 104 /** Set the label of the specified element. If the specified element
 105     doesn't support setting a label, this method has no effect.
 106
 107     @param aControlId
 108     Identifies the element for which the label should be set.
 109
 110     @param aLabel
 111     The label to be set.
 112
 113     @see com::sun::star::ui::dialogs::CommonFilePickerElementIds
 114     @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
 115 */
 116 void setLabel( [in] short aControlId, [in] string aLabel );
 117
 118 //-------------------------------------------------------------------------
 119 /** Returns the label of the specified element.
 120
 121     @param aControlId
 122     Identifies the element for which the label should be returned.
 123
 124     @returns
 125     The label of the specified element or an empty string if
 126     the specified element has no or supports no label or the
 127     specified element doesn't exist.
 128
 129     @see com::sun::star::ui::dialogs::CommonFilePickerElementIds
 130     @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
 131 */
 132 string getLabel( [in] short aControlId );
 133
 134 //-------------------------------------------------------------------------
 135 /** Enables or disables a control.
 136
 137     @param ControlId
 138     Identifies the control.
 139
 140     @param bEnable
 141     <p>If <TRUE/> the specified control will be enabled.</p>
 142     <p>If <FALSE/> the specified control will be disabled.</p>
 143
 144     @see com::sun::star::ui::dialogs::CommonFilePickerElementIds
 145     @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
 146 */
 147 void enableControl( [in] short aControlId, [in] boolean bEnable );
 148 };
 149
 150 //=============================================================================
 151
 152 }; }; }; }; };
 153
 154
 155 #endif
 156