diff options
Diffstat (limited to 'offapi/com/sun/star/ui/dialogs')
32 files changed, 233 insertions, 233 deletions
diff --git a/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl b/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl index 8c2efee4f993..861acf8e6ed2 100644 --- a/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl +++ b/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,8 +32,8 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** These constants are used to specify common controls of a FilePicker dialog. - +/** These constants are used to specify common controls of a FilePicker dialog. + */ published constants CommonFilePickerElementIds @@ -63,21 +63,21 @@ published constants CommonFilePickerElementIds /** Is used to refer to the edit line where a file or path can be entered by the user. */ const short EDIT_FILEURL = 5; - + //--------------------------------------------------------------------- /** The label of the filter listbox of a FilePicker dialog. @since OOo 1.1.2 */ const short LISTBOX_FILTER_LABEL = 6; - + //--------------------------------------------------------------------- /** The label of the file name listbox of a FilePicker dialog. @since OOo 1.1.2 */ const short EDIT_FILEURL_LABEL = 7; -}; +}; //============================================================================= diff --git a/offapi/com/sun/star/ui/dialogs/ControlActions.idl b/offapi/com/sun/star/ui/dialogs/ControlActions.idl index d3fe967311f0..36f7cc574eb2 100644 --- a/offapi/com/sun/star/ui/dialogs/ControlActions.idl +++ b/offapi/com/sun/star/ui/dialogs/ControlActions.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,7 +32,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Control actions for common and extended controls of a FilePicker. +/** Control actions for common and extended controls of a FilePicker. @see com::sun::star::ui::dialogs::XFilePickerControlAccess @see com::sun::star::ui::dialogs::CommonFilePickerElementIds @@ -42,18 +42,18 @@ module com { module sun { module star { module ui { module dialogs { published constants ControlActions { //--------------------------------------------------------------------- - /** Adds an item to the content of the listbox. The given item has to + /** Adds an item to the content of the listbox. The given item has to be a string. */ const short ADD_ITEM = 1; //--------------------------------------------------------------------- - /** Adds a sequence of strings to the content of the listbox. + /** Adds a sequence of strings to the content of the listbox. */ - const short ADD_ITEMS = 2; + const short ADD_ITEMS = 2; //--------------------------------------------------------------------- - /** Removes an item from a listbox. The given value has to be a + /** Removes an item from a listbox. The given value has to be a position. If the position is invalid an exception will be thrown. The index of the first position is 0. The value should be a sal_Int32. @@ -67,7 +67,7 @@ published constants ControlActions //--------------------------------------------------------------------- /** Selects an item in a listbox. The given value has to be a position. - The index of the first position is 0. A value of -1 removes the + The index of the first position is 0. A value of -1 removes the selection. If the given position is invalid an exception will be thrown. The value should be a sal_Int32. @@ -77,7 +77,7 @@ published constants ControlActions //--------------------------------------------------------------------- /** Returns all items of the listbox as a sequence of strings. */ - const short GET_ITEMS = 6; + const short GET_ITEMS = 6; //--------------------------------------------------------------------- /** Returns the currently selected item. The returned item is an empty @@ -86,8 +86,8 @@ published constants ControlActions const short GET_SELECTED_ITEM = 7; //--------------------------------------------------------------------- - /** Returns the zero based index of the currently selected item. - If the listbox is empty or there is no item selected -1 will be + /** Returns the zero based index of the currently selected item. + If the listbox is empty or there is no item selected -1 will be returned. The returned value is a sal_Int32. */ diff --git a/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl b/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl index 107ec70ca2cc..87ccc292acd9 100644 --- a/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl +++ b/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl b/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl index c509e50b7576..a7a1c4bb89bb 100644 --- a/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl +++ b/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl b/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl index 3d8caf3a08ef..e28a20c77c4e 100644 --- a/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl +++ b/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -33,7 +33,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** These constants are used to specify a result of executing a <type>XExecutableDialog</type>. +/** These constants are used to specify a result of executing a <type>XExecutableDialog</type>. */ published constants ExecutableDialogResults @@ -46,7 +46,7 @@ published constants ExecutableDialogResults //------------------------------------------------------------------------- /** The user acknowledged the dialog. */ - const short OK = 1; + const short OK = 1; }; //============================================================================= diff --git a/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl b/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl index 970d70e3c4b8..b281d1860792 100644 --- a/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl +++ b/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,10 +32,10 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** <p>These constants are used to specify extended controls of a FilePicker dialog. - A FilePicker service may be initialized so that it has additional controls +/** <p>These constants are used to specify extended controls of a FilePicker dialog. + A FilePicker service may be initialized so that it has additional controls extending the set of common controls a FilePicker usually supports.</p> - + @see com::sun::star::ui::dialogs::FilePicker @see com::sun::star::ui::dialogs::XFilePickerControlAccess @see com::sun::star::ui::dialogs::CommonFilePickerElementIds @@ -44,81 +44,81 @@ module com { module sun { module star { module ui { module dialogs { published constants ExtendedFilePickerElementIds { //--------------------------------------------------------------------- - /** + /** */ const short CHECKBOX_AUTOEXTENSION = 100; //--------------------------------------------------------------------- - /** + /** */ const short CHECKBOX_PASSWORD = 101; //--------------------------------------------------------------------- - /** + /** */ const short CHECKBOX_FILTEROPTIONS = 102; //--------------------------------------------------------------------- - /** + /** */ const short CHECKBOX_READONLY = 103; - + //--------------------------------------------------------------------- - /** + /** */ const short CHECKBOX_LINK = 104; //--------------------------------------------------------------------- - /** + /** */ const short CHECKBOX_PREVIEW = 105; //--------------------------------------------------------------------- - /** + /** */ const short PUSHBUTTON_PLAY = 106; //--------------------------------------------------------------------- - /** + /** */ const short LISTBOX_VERSION = 107; //--------------------------------------------------------------------- - /** + /** */ const short LISTBOX_TEMPLATE = 108; //--------------------------------------------------------------------- - /** + /** */ const short LISTBOX_IMAGE_TEMPLATE = 109; //--------------------------------------------------------------------- - /** + /** */ const short CHECKBOX_SELECTION = 110; //--------------------------------------------------------------------- - /** + /** */ const short LISTBOX_VERSION_LABEL = 207; //--------------------------------------------------------------------- - /** + /** */ const short LISTBOX_TEMPLATE_LABEL = 208; //--------------------------------------------------------------------- - /** + /** */ const short LISTBOX_IMAGE_TEMPLATE_LABEL = 209; //--------------------------------------------------------------------- - /** + /** */ const short LISTBOX_FILTER_SELECTOR = 210; -}; +}; //============================================================================= diff --git a/offapi/com/sun/star/ui/dialogs/FilePicker.idl b/offapi/com/sun/star/ui/dialogs/FilePicker.idl index 230f289c10f4..741528d208e7 100644 --- a/offapi/com/sun/star/ui/dialogs/FilePicker.idl +++ b/offapi/com/sun/star/ui/dialogs/FilePicker.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -44,7 +44,7 @@ #include <com/sun/star/lang/XInitialization.idl> #endif -#ifndef __com_sun_star_util_XCancellable_idl__ +#ifndef __com_sun_star_util_XCancellable_idl__ #include <com/sun/star/util/XCancellable.idl> #endif @@ -55,10 +55,10 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= //============================================================================= -/** A FilePicker. +/** A FilePicker. - It is <strong>NOT</strong> recommended to cache a reference to a file - picker instance. Due to restrictions by the underlying system there can + It is <strong>NOT</strong> recommended to cache a reference to a file + picker instance. Due to restrictions by the underlying system there can be specific limitations possible. To overcome these problems it' s recommended to create a new instance on demand. @@ -71,7 +71,7 @@ module com { module sun { module star { module ui { module dialogs { published interface XFilterManager; published interface XFilePreview; published interface XFilterGroupManager; - + published service FilePicker { //------------------------------------------------------------------------- @@ -80,7 +80,7 @@ published service FilePicker [optional, property] string HelpURL; //------------------------------------------------------------------------- - /** Provides access to the basic FilePicker functionality. + /** Provides access to the basic FilePicker functionality. */ interface XFilePicker; @@ -90,13 +90,13 @@ published service FilePicker interface XFilePickerNotifier; //------------------------------------------------------------------------- - /** Provides the ability to add different filter, query for the current - filters and set a current filter + /** Provides the ability to add different filter, query for the current + filters and set a current filter */ interface XFilterManager; //------------------------------------------------------------------------- - /** Provides the ability to show a preview of a selected file + /** Provides the ability to show a preview of a selected file */ [optional] interface XFilePreview; @@ -106,8 +106,8 @@ published service FilePicker common controls that a FilePicker usually supports. @see com::sun::star::ui::dialogs::CommonFilePickerElementIds - @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds - + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds + @deprecated */ [optional] interface XFilePickerControlAccess; @@ -119,19 +119,19 @@ published service FilePicker //------------------------------------------------------------------------- /** Provides the ability to choose between different custom templates that - do extend the subset of common controls a FilePicker usually supports. + do extend the subset of common controls a FilePicker usually supports. Implementers may omit this interface if the FileOpen dialog doesn't support custom templates. In this case a createInstance will create an ordinary FileOpen dialog with only the common FilePicker elements. - The client has to provide one of the specified constants in + The client has to provide one of the specified constants in TemplateDescription. - <br/><br/> + <br/><br/> <p><strong>Notes for the implementation of a FileSave dialog:</strong> - The implementation of a FileSave dialog should automatically check - for existens of a file and issue a warning if a file with the same + The implementation of a FileSave dialog should automatically check + for existens of a file and issue a warning if a file with the same name already exist.</p> - + @see com::sun::star::ui::dialogs::TemplateDescription */ [optional] interface com::sun::star::lang::XInitialization; diff --git a/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl b/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl index d57f08a921b6..5bfa3c11541b 100644 --- a/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl +++ b/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -44,8 +44,8 @@ module com { module sun { module star { module ui { module dialogs { published struct FilePickerEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** - @param ElementId + /** + @param ElementId Identifies the affected element @see com::sun::star::ui::dialogs::CommonFilePickerElementIds diff --git a/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl index 9d1b006c0e64..0b6152709b50 100644 --- a/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl +++ b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,7 +32,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** These constants are used to specify image formats supported by an implementation +/** These constants are used to specify image formats supported by an implementation of the interface <type scope="com::sun::star::ui::dialogs">XFilePreview</type>. */ @@ -44,7 +44,7 @@ published constants FilePreviewImageFormats The bitmap data should be provided as a sequence of sal_Int8. */ const short BITMAP = 1; -}; +}; //============================================================================= diff --git a/offapi/com/sun/star/ui/dialogs/FilterOptionsDialog.idl b/offapi/com/sun/star/ui/dialogs/FilterOptionsDialog.idl index fc0f6c480b84..5f34ff6db93d 100644 --- a/offapi/com/sun/star/ui/dialogs/FilterOptionsDialog.idl +++ b/offapi/com/sun/star/ui/dialogs/FilterOptionsDialog.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,7 +41,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** This service enables a filter developer to register a dialog to query +/** This service enables a filter developer to register a dialog to query for user options before the filter operation is performed. <p>The user options are stored inside the <type scope="com::sun::star::document">MediaDescriptor</type> @@ -56,7 +56,7 @@ module com { module sun { module star { module ui { module dialogs { the application will retrieve the changed <type scope="com::sun::star::document">MediaDescriptor</type> back using the interface <type scope="com::sun::star::beans">XPropertyAccess</type>. The filter operation is than continued, using the new <type scope="com::sun::star::document">MediaDescriptor</type>.</p> - + <p>Otherwise, the filter operation is canceled.</p> @since OOo 1.1.2 @@ -64,7 +64,7 @@ module com { module sun { module star { module ui { module dialogs { published service FilterOptionsDialog { //------------------------------------------------------------------------- - /** this interface is used to set the property values of the + /** this interface is used to set the property values of the <type scope="com::sun::star::document">MediaDescriptor</type> before executing the dialog and to retrieve the changed <type scope="com::sun::star::document">MediaDescriptor</type> @@ -73,7 +73,7 @@ published service FilterOptionsDialog interface com::sun::star::beans::XPropertyAccess; //------------------------------------------------------------------------- - /** this interface executes a dialog that displays the options + /** this interface executes a dialog that displays the options for a filter. If <method>XExecutableDialog::execute<method> returns <code>ExecutableDialogResults::OK</code>, diff --git a/offapi/com/sun/star/ui/dialogs/FolderPicker.idl b/offapi/com/sun/star/ui/dialogs/FolderPicker.idl index adfad7fed497..c80e3c02fc62 100644 --- a/offapi/com/sun/star/ui/dialogs/FolderPicker.idl +++ b/offapi/com/sun/star/ui/dialogs/FolderPicker.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,18 +40,18 @@ #include <com/sun/star/lang/XTypeProvider.idl> #endif -#ifndef __com_sun_star_util_XCancellable_idl__ +#ifndef __com_sun_star_util_XCancellable_idl__ #include <com/sun/star/util/XCancellable.idl> #endif //============================================================================= module com { module sun { module star { module ui { module dialogs { - + //============================================================================= published interface XFolderPicker; - + //============================================================================= /** A FolderPicker service. */ @@ -59,7 +59,7 @@ module com { module sun { module star { module ui { module dialogs { published service FolderPicker { //------------------------------------------------------------------------- - /** Provides the ability to execute a FolderPicker dialog and + /** Provides the ability to execute a FolderPicker dialog and browse for and select folders. */ interface XFolderPicker; @@ -75,7 +75,7 @@ published service FolderPicker interface com::sun::star::lang::XTypeProvider; //------------------------------------------------------------------------- - /** For canceling a running dialog instance. + /** For canceling a running dialog instance. <p>This may be usefull for automatic test tools for instance.</p> */ [optional] interface com::sun::star::util::XCancellable; diff --git a/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl b/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl index 7bd5e5da0219..4bd6b7b2b7eb 100644 --- a/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl +++ b/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,18 +40,18 @@ module com { module sun { module star { module ui { module dialogs { published constants ListboxControlActions { //--------------------------------------------------------------------- - /** Adds an item to the content of the listbox. The given item has to + /** Adds an item to the content of the listbox. The given item has to be a string. */ const short ADD_ITEM = 1; //--------------------------------------------------------------------- - /** Adds a sequence of strings to the content of the listbox. + /** Adds a sequence of strings to the content of the listbox. */ - const short ADD_ITEMS = 2; + const short ADD_ITEMS = 2; //--------------------------------------------------------------------- - /** Removes an item from a listbox. The given value has to be a + /** Removes an item from a listbox. The given value has to be a position. If the position is invalid an exception will be thrown. The index of the first position is 0. The value should be a sal_Int32. @@ -65,7 +65,7 @@ published constants ListboxControlActions //--------------------------------------------------------------------- /** Selects an item in a listbox. The given value has to be a position. - The index of the first position is 0. A value of -1 removes the + The index of the first position is 0. A value of -1 removes the selection. If the given position is invalid an exception will be thrown. The value should be a sal_Int32. @@ -75,7 +75,7 @@ published constants ListboxControlActions //--------------------------------------------------------------------- /** Returns all items of the listbox as a sequence of strings. */ - const short GET_ITEMS = 6; + const short GET_ITEMS = 6; //--------------------------------------------------------------------- /** Returns the currently selected item. The returned item is an empty diff --git a/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl b/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl index 615fbe055b8e..69908450d74a 100644 --- a/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl +++ b/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,10 +32,10 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** The implementation of a FilePicker service may support the usage of - different templates. The following constants define the currently +/** The implementation of a FilePicker service may support the usage of + different templates. The following constants define the currently specified templates. - + @see com::sun::star::ui::dialogs::FilePicker */ @@ -50,7 +50,7 @@ published constants TemplateDescription /** A FileSave dialog without any additional controls. */ const short FILESAVE_SIMPLE = 1; - + //--------------------------------------------------------------------- /** A FileSave dialog with additional controls. <ul> @@ -124,7 +124,7 @@ published constants TemplateDescription <li>A window for displaying a file preview</li> </ul> */ - const short FILEOPEN_LINK_PREVIEW = 9; + const short FILEOPEN_LINK_PREVIEW = 9; //--------------------------------------------------------------------- /** A FileSave dialog with additional controls. @@ -132,9 +132,9 @@ published constants TemplateDescription <li>A checkbox "Auto Extension"</li> </ul> */ - const short FILESAVE_AUTOEXTENSION = 10; + const short FILESAVE_AUTOEXTENSION = 10; -}; +}; //============================================================================= diff --git a/offapi/com/sun/star/ui/dialogs/Wizard.idl b/offapi/com/sun/star/ui/dialogs/Wizard.idl index 4e6b13f44ca2..b3237be3f011 100644 --- a/offapi/com/sun/star/ui/dialogs/Wizard.idl +++ b/offapi/com/sun/star/ui/dialogs/Wizard.idl @@ -32,7 +32,7 @@ //================================================================================================================== -module com { module sun { module star { module ui { module dialogs { +module com { module sun { module star { module ui { module dialogs { interface XWizardController; @@ -68,7 +68,7 @@ service Wizard : XWizard //================================================================================================================== -}; }; }; }; }; +}; }; }; }; }; //================================================================================================================== diff --git a/offapi/com/sun/star/ui/dialogs/WizardButton.idl b/offapi/com/sun/star/ui/dialogs/WizardButton.idl index 34c0d8074889..acba104e36e4 100644 --- a/offapi/com/sun/star/ui/dialogs/WizardButton.idl +++ b/offapi/com/sun/star/ui/dialogs/WizardButton.idl @@ -29,7 +29,7 @@ //================================================================================================================== -module com { module sun { module star { module ui { module dialogs { +module com { module sun { module star { module ui { module dialogs { //================================================================================================================== diff --git a/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl b/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl index 271a006346b7..d46021266c18 100644 --- a/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl +++ b/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl @@ -47,7 +47,7 @@ constants WizardTravelType //================================================================================================================== -}; }; }; }; }; +}; }; }; }; }; //================================================================================================================== diff --git a/offapi/com/sun/star/ui/dialogs/XAsynchronousExecutableDialog.idl b/offapi/com/sun/star/ui/dialogs/XAsynchronousExecutableDialog.idl index e844ab96b77c..c19de5ab74e4 100644 --- a/offapi/com/sun/star/ui/dialogs/XAsynchronousExecutableDialog.idl +++ b/offapi/com/sun/star/ui/dialogs/XAsynchronousExecutableDialog.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -46,7 +46,7 @@ module com { module sun { module star { module ui { module dialogs { interface XAsynchronousExecutableDialog: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Sets the title of the dialog. + /** Sets the title of the dialog. @param aTitle Set an abitrary title for the dialog, diff --git a/offapi/com/sun/star/ui/dialogs/XControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XControlAccess.idl index 6c7eeddf3972..c574da70d0a5 100644 --- a/offapi/com/sun/star/ui/dialogs/XControlAccess.idl +++ b/offapi/com/sun/star/ui/dialogs/XControlAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,13 +41,13 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Generic control access interface. +/** Generic control access interface. <p>Use this interface to access user interface controls supported - by the implementing service. The supported controls, control - properties and the appropriate values are documented in the + by the implementing service. The supported controls, control + properties and the appropriate values are documented in the decription of the implementing service.</p> - + @see com::sun::star::ui::dialogs::FilePicker @see com::sun::star::ui::dialogs::FilePicker @@ -57,18 +57,18 @@ published interface XControlAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** Change a control property. - + @param aControlName The name of the control. Common control names are for instance 'OkButton' or 'CancelButton'. - + @param aControlProperty The control property to manipulate. Common control properties are for instance 'Label' or 'State'. - + @param aValue A value appropriated for the property. - + @throws com::sun::star::lang::IllegalArgumentException when the control is not supported, the control property is invalid or the value fits not the control action. @@ -82,14 +82,14 @@ void setControlProperty( [in] string aControlName, [in] string aControlProperty, @param aControlName The name of the control. Common control names are for instance 'OkButton' or 'CancelButton'. - + @param aControlProperty The requested control property. Common control properties are for instance 'Label' or 'State'. - - @returns + + @returns the requested value. - + @throws com::sun::star::lang::IllegalArgumentException when the control is not supported or the control property is invalid. */ diff --git a/offapi/com/sun/star/ui/dialogs/XControlInformation.idl b/offapi/com/sun/star/ui/dialogs/XControlInformation.idl index c632f4fa1f8b..cb6fa46393bf 100644 --- a/offapi/com/sun/star/ui/dialogs/XControlInformation.idl +++ b/offapi/com/sun/star/ui/dialogs/XControlInformation.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,7 +24,7 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ - + #ifndef __com_sun_star_ui_dialogs_XControlInformation_idl__ #define __com_sun_star_ui_dialogs_XControlInformation_idl__ @@ -41,7 +41,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Interface to query for controls and control properties supported by the +/** Interface to query for controls and control properties supported by the implementing instance. @since OOo 1.1.2 @@ -51,54 +51,54 @@ published interface XControlInformation: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Query for the supported controls of a service instance. - @returns + @returns a sequence with the names of the supported controls. */ sequence<string> getSupportedControls( ); //------------------------------------------------------------------------- /** Returns whether the specified control is supported or not. - + @param aControlName The name of the control. Common control names are for instance 'OkButton' or 'CancelButton'. - - @returns + + @returns <TRUE/> if the specified control is supported. <FALSE/> if the specified control is not supported. */ boolean isControlSupported( [in] string aControlName ); - + //------------------------------------------------------------------------- /** Returns a sequence with properties supported by the specified control. - + @param aControlName The name of the control. Common control names are for instance 'OkButton' or 'CancelButton'. - + @returns a sequence of control properties supported by the specified control. - + @throws com::sun::star::lang::IllegalArgumentException when the specified control is not supported. */ sequence<string> getSupportedControlProperties( [in] string aControlName ) raises( com::sun::star::lang::IllegalArgumentException ); - + //------------------------------------------------------------------------- /** Returns whether control property is supported by a control. - + @param aControlName The name of the control. - + @param aControlProperty The control property to query for. - - @returns + + @returns <TRUE/> if the specified control action is supported. <FALSE/> if the specified control action is not supported. - + @throws com::sun::star::lang::IllegalArgumentException when the specified control is not supported. */ diff --git a/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl b/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl index 0f03d37efea2..fcf9cf500bde 100644 --- a/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl +++ b/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl b/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl index 556a9bf8cc0f..267eecce3ccb 100644 --- a/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl +++ b/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,24 +43,24 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= /** Specifies an interface for an executable dialog. */ - + published interface XExecutableDialog: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Sets the title of the dialog. + /** Sets the title of the dialog. - @param aTitle - Set an abitrary title for the dialog, + @param aTitle + Set an abitrary title for the dialog, may be an empty string if the dialog should not have a title. */ void setTitle( [in] string aTitle ); //------------------------------------------------------------------------- - /** Executes (shows) the dialog. + /** Executes (shows) the dialog. - @returns + @returns A status code of type <type>ExecutableDialogResults</type>. */ short execute(); diff --git a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl index d35683f71fc3..9d7b3639006d 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -46,27 +46,27 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= /** Specifies an interface for a FilePicker */ - + published interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog { //------------------------------------------------------------------------- - /** Enable/disable multiselection mode + /** Enable/disable multiselection mode - <p>If the multiselection mode is enabled, multiple files + <p>If the multiselection mode is enabled, multiple files may be selected by the user else only one file selection at a time is possible</p> - - @param bMode + + @param bMode <p>A value of <TRUE/> enables the multiselection mode.</p> <p>A value of <FALSE/> disables the multiselection mode, this is the default.</p> */ void setMultiSelectionMode( [in] boolean bMode ); //------------------------------------------------------------------------- - /** Sets the default string that appears in the file name box of a FilePicker. + /** Sets the default string that appears in the file name box of a FilePicker. @param aName - <p> Specifies the default file name, displayed when the FilePicker + <p> Specifies the default file name, displayed when the FilePicker is shown. The implementation may accept any string, and does not have to check for a valid file name or if the file really exists. </p> @@ -74,61 +74,61 @@ published interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog void setDefaultName( [in] string aName ); //------------------------------------------------------------------------- - /** Sets the directory that the file dialog initially displays. + /** Sets the directory that the file dialog initially displays. @param aDirectory Specifies the initial directory in URL format. The given URL must be - conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). - + conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). + @throws com::sun::star::lang::IllegalArgumentException - if the URL is invalid (doesn't conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). + if the URL is invalid (doesn't conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). */ void setDisplayDirectory( [in] string aDirectory ) raises( ::com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** Returns the directory that the file dialog is currently showing or - was last showing before closing the dialog with Ok. If the user - did cancel the dialog, the returned value is undefined. + /** Returns the directory that the file dialog is currently showing or + was last showing before closing the dialog with Ok. If the user + did cancel the dialog, the returned value is undefined. - @returns - The directory in URL format, must be conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. + @returns + The directory in URL format, must be conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. */ string getDisplayDirectory(); //------------------------------------------------------------------------- - /** Returns a sequence of the selected files including path information in + /** Returns a sequence of the selected files including path information in URL format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. - <p>If the user closed the dialog with cancel an empty sequence will be + <p>If the user closed the dialog with cancel an empty sequence will be returned.</p> <br/> - <p>If the dialog is in execution mode and a single file is selected + <p>If the dialog is in execution mode and a single file is selected the complete URL of this file will be returned.</p> - <p>If the dialog is in execution mode and multiple files are selected + <p>If the dialog is in execution mode and multiple files are selected an empty sequence will be returned.</p> <p>If the dialog is in execution mode and the selected file name is false or any other error occurs an empty sequence will be returned.</p> - @returns - <p> The complete path of the file or directory currently selected + @returns + <p> The complete path of the file or directory currently selected in URL format. There are two different cases: <ol> - <li>Multiselection is disabled: - The first and only entry of the sequence contains the complete + <li>Multiselection is disabled: + The first and only entry of the sequence contains the complete path/filename in URL format.</li> - <li>Multiselection is enabled: + <li>Multiselection is enabled: If only one file is selected, the first entry - of the sequence contains the complete path/filename in URL format. - If multiple files are selected, the first entry of the sequence contains - the path in URL format, and the other entries contains the names of the selected + of the sequence contains the complete path/filename in URL format. + If multiple files are selected, the first entry of the sequence contains + the path in URL format, and the other entries contains the names of the selected files without path information.</li> </ol> - + <br/> - <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists + <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists a checkbox "Automatic File Extension" which is checked and a valid filter is currently selected the dialog may automatically add an extension to the selected file name.</p> </p> diff --git a/offapi/com/sun/star/ui/dialogs/XFilePicker2.idl b/offapi/com/sun/star/ui/dialogs/XFilePicker2.idl index b80c198a5fa4..bac615f46406 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePicker2.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePicker2.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -42,7 +42,7 @@ module com { module sun { module star { module ui { module dialogs { interface XFilePicker2 : ::com::sun::star::ui::dialogs::XFilePicker { //------------------------------------------------------------------------- - /** Returns a sequence of the selected files including path information in + /** Returns a sequence of the selected files including path information in URL format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. <p>If the user closed the dialog with cancel an empty sequence will be returned.</p> @@ -56,11 +56,11 @@ interface XFilePicker2 : ::com::sun::star::ui::dialogs::XFilePicker full qualified URL's for every selected file. </p> - @returns + @returns <p>A list of all selected file as complete URL's.</p> <br/> - <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists + <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists a checkbox "Automatic File Extension" which is checked and a valid filter is currently selected the dialog may automatically add an extension to the selected file name(s).</p> */ diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl index 1c57cce3243d..986c1e4ae28b 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -49,7 +49,7 @@ published interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFile { //------------------------------------------------------------------------- -/** Set the value of an additional element within a FilePicker. +/** Set the value of an additional element within a FilePicker. @param ControlId Identifies the element which value is to be set. @@ -58,24 +58,24 @@ published interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFile Specifies an action to perform with the given value. aControlAction has to be one of the values defined in <type>ControlActions</type>. Not all of the values are valid for all controls. - To add a new filter to the FilePicker use the interface XFilterManager, but + To add a new filter to the FilePicker use the interface XFilterManager, but optionally an implementation may also support adding new filter using this method. - - @param aValue + + @param aValue 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 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 ); +void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue ); //------------------------------------------------------------------------- /** Get the value of an additional element within a FilePicker - - @param aControlId + + @param aControlId Identifies the element for which value is requested. @param aControlAction @@ -83,7 +83,7 @@ void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue aControlAction has to be one of the values defined in <type>ControlActions</type>. Not all of the values are valid for all controls. - @returns + @returns 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. @@ -94,12 +94,12 @@ void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue @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 ); +*/ +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. + doesn't support setting a label, this method has no effect. @param aControlId Identifies the element for which the label should be set. @@ -113,12 +113,12 @@ any getValue( [in] short aControlId, [in] short aControlAction ); void setLabel( [in] short aControlId, [in] string aLabel ); //------------------------------------------------------------------------- -/** Returns the label of the specified element. - +/** Returns the label of the specified element. + @param aControlId Identifies the element for which the label should be returned. - @returns + @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. @@ -131,7 +131,7 @@ string getLabel( [in] short aControlId ); //------------------------------------------------------------------------- /** Enables or disables a control. - @param ControlId + @param ControlId Identifies the control. @param bEnable diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl index cacdcd1afde5..915c6224dbcb 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -53,7 +53,7 @@ module com { module sun { module star { module ui { module dialogs { published interface XFilePickerListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** A client receives this event if the file selection within the + /** A client receives this event if the file selection within the FilePicker service dialog changes. @param aEvent @@ -65,7 +65,7 @@ published interface XFilePickerListener: com::sun::star::lang::XEventListener //------------------------------------------------------------------------- - /** A client receives this event if the directory selection within the + /** A client receives this event if the directory selection within the FilePicker dialog changes. @param aEvent @@ -82,19 +82,19 @@ published interface XFilePickerListener: com::sun::star::lang::XEventListener @param aEvent of type <type>FilePickerEvent</type> that describes the event - @returns + @returns A help string which the FilePicker dialog should use to display a help for a specific control. If the returned string is empty it is undefined how the FilePicker implementation will behave. It may show a message 'no help available' or may show no - help at all. + help at all. @see com::sun::star::ui::dialogs::FilePickerEvent */ string helpRequested( [in] FilePickerEvent aEvent ); //------------------------------------------------------------------------- - /** A client receives this event if the state of a control within the + /** A client receives this event if the state of a control within the FilePicker service dialog changes. @param aEvent @@ -107,7 +107,7 @@ published interface XFilePickerListener: com::sun::star::lang::XEventListener //------------------------------------------------------------------------- /** A client receives this event if the size of the FilePicker dialog has changed. If the FilePicker dialog contains a preview the client - may ask for the new dimension of the preview area. + may ask for the new dimension of the preview area. */ void dialogSizeChanged( ); }; diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl index 862e92b7084d..658a24aa6622 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -53,7 +53,7 @@ published interface XFilePickerNotifier: com::sun::star::uno::XInterface @param xListener The <type>XFilePickerListener</type> interface of the listener that wants to receive events of type <type>FilePickerEvent</type>. - <p>Invalid interfaces or NULL values will be ignored.</p> + <p>Invalid interfaces or NULL values will be ignored.</p> */ [oneway] void addFilePickerListener( [in] XFilePickerListener xListener ); diff --git a/offapi/com/sun/star/ui/dialogs/XFilePreview.idl b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl index 935b1528db1e..a2ea68707bb6 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePreview.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -54,16 +54,16 @@ published interface XFilePreview: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** The method returns all image formats that the preview supports. - @returns + @returns A sequence of all supported preview formats - + @see com::sun::star::ui::dialogs::FilePreviewImageFormats - */ + */ sequence< short > getSupportedImageFormats( ); //------------------------------------------------------------------------- /** The method returns the supported color depth of the target device. - + @returns The color depth in bit, e.g. 8 bit, 16 bit, 32 bit. */ @@ -87,17 +87,17 @@ published interface XFilePreview: com::sun::star::uno::XInterface 0 will be returned. @returns - The heigth of the preview window in pixel. + The heigth of the preview window in pixel. */ long getAvailableHeight( ); //------------------------------------------------------------------------- - /** Sets a new image. If the preview is currently hidden the + /** Sets a new image. If the preview is currently hidden the image will be ignored. An empty any will clear the preview window. @param aImageFormat Specifies the format of the data that will be delivered - + @param aImage The image data, the image format defines how the image data have to be delivered @@ -106,7 +106,7 @@ published interface XFilePreview: com::sun::star::uno::XInterface If the specified image format is invalid or not supported by the preview implementation - @see com::sun::star::ui::dialogs::FilePreviewImageFormats + @see com::sun::star::ui::dialogs::FilePreviewImageFormats */ void setImage( [in] short aImageFormat, [in] any aImage ) raises( ::com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl b/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl index 75e5b6458f3d..5e0992cb7f9b 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,10 +37,10 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif -module com { module sun { module star { module ui { module dialogs { +module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Specifies an interface which allows manipulation of groups of filters +/** Specifies an interface which allows manipulation of groups of filters for the <type>FilePicker</type> service. */ published interface XFilterGroupManager : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/ui/dialogs/XFilterManager.idl b/offapi/com/sun/star/ui/dialogs/XFilterManager.idl index 8e418b7519f0..8fa927ebfd24 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilterManager.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilterManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,12 +43,12 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= /** Specifies a filter manager interface for a FilePicker */ - + published interface XFilterManager: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Adds a filter identified by a title. + /** Adds a filter identified by a title. @param aTitle Specifies the name of the filter as shown in the filter box of the @@ -61,13 +61,13 @@ published interface XFilterManager: com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IllegalArgumentException If a filter with the specified title already exists. - + */ void appendFilter( [in] string aTitle, [in] string aFilter ) raises( ::com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** Sets the current filter. + /** Sets the current filter. @param aTitle Specifies the name of the filter to be set. @@ -79,9 +79,9 @@ published interface XFilterManager: com::sun::star::uno::XInterface raises( ::com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** Returns the currently selected filter. + /** Returns the currently selected filter. - @returns + @returns The name of the selected filter or an empty string if there is no filter or no filter is currently selected. */ diff --git a/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl b/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl index 2265ecab2346..75e63d7180de 100644 --- a/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl +++ b/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -46,36 +46,36 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= /** Specifies a FolderPicker interface. */ - + published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog { //------------------------------------------------------------------------- - /** Sets the root directory that the FolderPicker should display. - It is not specified which root directory the FolderPicker + /** Sets the root directory that the FolderPicker should display. + It is not specified which root directory the FolderPicker chooses if the specified root directory doesn't exist. - + @param aDirectory - Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. - - @throws com::sun::star::lang::IllegalArgumentException + Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. + + @throws com::sun::star::lang::IllegalArgumentException if the given url is invalid. */ void setDisplayDirectory( [in] string aDirectory ) raises( ::com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** Returns the root directory that the FolderPicker is showing. The - return value is undefined if the client did not choose a root directory + /** Returns the root directory that the FolderPicker is showing. The + return value is undefined if the client did not choose a root directory or the previously specified root directory doesn't exist. - @returns + @returns The directory in url format. */ string getDisplayDirectory(); //------------------------------------------------------------------------- /** Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. - + @returns The selected directory as url if the user did close the dialog with ok else the returned value is undefined. @@ -83,9 +83,9 @@ published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialo string getDirectory( ); //------------------------------------------------------------------------- - /** The implementation may optionally show the given text as a description - for the user within the dialog, e.g. "Please select a directory". - If the client doesn't set a description the dialog may show a default + /** The implementation may optionally show the given text as a description + for the user within the dialog, e.g. "Please select a directory". + If the client doesn't set a description the dialog may show a default description. */ void setDescription( [in] string aDescription ); diff --git a/offapi/com/sun/star/ui/dialogs/XWizardController.idl b/offapi/com/sun/star/ui/dialogs/XWizardController.idl index 6a51a67360fe..52a24542261e 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizardController.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizardController.idl @@ -78,7 +78,7 @@ interface XWizardController //================================================================================================================== -}; }; }; }; }; +}; }; }; }; }; //================================================================================================================== diff --git a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl index 149f8c14709b..4eef97d00915 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl @@ -79,7 +79,7 @@ interface XWizardPage : ::com::sun::star::lang::XComponent //================================================================================================================== -}; }; }; }; }; +}; }; }; }; }; //================================================================================================================== |