diff options
Diffstat (limited to 'offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl')
| -rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl | 120 |
1 files changed, 51 insertions, 69 deletions
diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl index bea3429ea537..0aa80a7328f5 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilePickerControlAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: tra $ $Date: 2001-12-12 11:10:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,11 +71,13 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Specifies extension of a file picker. +/** Provides access to the controls of a FilePicker. <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> + addressed by this interface.</p> + + @see com::sun::star::ui::dialogs::FilePicker */ interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker { @@ -84,7 +86,7 @@ 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. + Identifies the element which value is to be set. @param aControlAction Specifies an action to perform with the given value. @@ -95,10 +97,12 @@ interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker 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. + The value to set. For checkboxes aValue should be a boolean value that + should be <TRUE/> if the checkbox should be checked and <FALSE/> otherwise. - @see ControlActions + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds + @see com::sun::star::ui::dialogs::ControlActions */ void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue ); @@ -106,39 +110,55 @@ 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. + Identifies the element for which value is requested. @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. + 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. @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. + The value of the specified element. If the specified control + is a checkbox the returned value is a boolean that is <TRUE/> + if the checkbox is checked <FALSE/> otherwise. + If the specified element doesn't exist or the specified element + doesn't support the specidfied control action an empty any will be + returned. + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds + @see com::sun::star::ui::dialogs::ControlActions */ 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. + + @param aControlId + Identifies the element for which the label should be set. + + @param aLabel + The label to be set. + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ void setLabel( [in] short aControlId, [in] string aLabel ); //------------------------------------------------------------------------- -/** Returns the lable of the specified element. +/** Returns the label of the specified element. + + @param aControlId + Identifies the element for which the label should be returned. @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. + 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. + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ string getLabel( [in] short aControlId ); @@ -146,11 +166,14 @@ string getLabel( [in] short aControlId ); /** Enables or disables a control. @param ControlId - Identifies the control. + Identifies the control. @param bEnable - If true the specified control will be enabled. - If false the specified control will be disabled. + <p>If <TRUE/> the specified control will be enabled.</p> + <p>If <FALSE/> the specified control will be disabled.</p> + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ void enableControl( [in] short aControlId, [in] boolean bEnable ); }; @@ -159,47 +182,6 @@ 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 |