Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: ui :: dialogs ::

service FilePicker

Exported Interfaces - Summary
XFilePicker

Provides access to the basic FilePicker functionality.

XFilePickerNotifier

Provides the ability to request notifications about changes.

XFilterManager

Provides the ability to add different filter, query for the current filters and set a current filter

XFilePreview

Provides the ability to show a preview of a selected file (details)

XFilePickerControlAccess

Provides the ability manage additional controls (checkboxes, listboxes etc.) offered by an extended FilePicker, these controls extend the subset of common controls that a FilePicker usually supports. (details)

XFilterGroupManager

An interface which allows manipulation of groups of filters (details)

::com::sun::star::lang::XInitialization

Provides the ability to choose between different custom templates that 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 TemplateDescription.

(details)

::com::sun::star::util::XCancellable

For canceling a running dialog instance. (details)

::com::sun::star::lang::XComponent

For shutdown and listener support.

::com::sun::star::lang::XServiceInfo

Service should always support this interface.

::com::sun::star::lang::XTypeProvider

Service should always support this interface.

Properties' Summary
string
HelpURL
[ OPTIONAL ]
Allows to associate a help URL with the file picker instance.  
Exported Interfaces - Details
XFilePicker
Description
Provides access to the basic FilePicker functionality.
XFilePickerNotifier
Description
Provides the ability to request notifications about changes.
XFilterManager
Description
Provides the ability to add different filter, query for the current filters and set a current filter
XFilePreview
Usage Restrictions
optional
Description
Provides the ability to show a preview of a selected file
XFilePickerControlAccess
Usage Restrictions
deprecated
optional
Description
Provides the ability manage additional controls (checkboxes, listboxes etc.) offered by an extended FilePicker, these controls extend the subset of common controls that a FilePicker usually supports.
See also
CommonFilePickerElementIds, ExtendedFilePickerElementIds
XFilterGroupManager
Usage Restrictions
optional
Description
An interface which allows manipulation of groups of filters
::com::sun::star::lang::XInitialization
Usage Restrictions
optional
Description
Provides the ability to choose between different custom templates that 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 TemplateDescription.

Notes for the implementation of a FileSave dialog: 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.

See also
TemplateDescription
::com::sun::star::util::XCancellable
Usage Restrictions
optional
Description
For canceling a running dialog instance.

This may be usefull for automatic test tools for instance.

::com::sun::star::lang::XComponent
Description
For shutdown and listener support.
::com::sun::star::lang::XServiceInfo
Description
Service should always support this interface.
::com::sun::star::lang::XTypeProvider
Description
Service should always support this interface.
Properties' Details
HelpURL
string HelpURL;
Usage Restrictions
optional
Description
Allows to associate a help URL with the file picker instance.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.