LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
FilePicker Service Referencepublished

A FilePicker. More...

import "FilePicker.idl";

Inheritance diagram for FilePicker:
XFilePicker3 XFilePicker XFilePickerNotifier XFilterManager XFilePreview XFilterGroupManager XCancellable XComponent XExecutableDialog XInterface XInterface XInterface XInterface XInterface XInterface XInterface

Public Member Functions

 createWithMode ([in] short Mode)
 Provides the ability to choose between different custom templates that do extend the subset of common controls a FilePicker usually supports. More...
 

Additional Inherited Members

- Exported Interfaces inherited from XFilePicker3
interface XFilePicker
 
interface XFilePickerNotifier
 Provides the ability to request notifications about changes. More...
 
interface XFilterManager
 Provides the ability to add different filter, query for the current filters and set a current filter. More...
 
interface XFilePreview
 Provides the ability to show a preview of a selected file. More...
 
interface XFilterGroupManager
 An interface which allows manipulation of groups of filters. More...
 
interface com::sun::star::util::XCancellable
 For canceling a running dialog instance. More...
 
interface com::sun::star::lang::XComponent
 For shutdown and listener support. More...
 
- Protected Member Functions inherited from XFilePreview
sequence< short > getSupportedImageFormats ()
 The method returns all image formats that the preview supports. More...
 
com::sun::star::util::Color getTargetColorDepth ()
 The method returns the supported color depth of the target device. More...
 
long getAvailableWidth ()
 The method returns the available width of the preview window even if the window is invisible or could not be created. More...
 
long getAvailableHeight ()
 The method returns the available height of the preview window even if the window is invisible or could not be created. More...
 
void setImage ([in] short aImageFormat,[in] any aImage) raises ( ::com::sun::star::lang::IllegalArgumentException )
 Sets a new image. More...
 
boolean setShowState ([in] boolean bShowState)
 Optionally sets the current show state of the preview. More...
 
boolean getShowState ()
 Returns the current show state of the preview. More...
 

Detailed Description

A FilePicker.

It is NOT 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.

See Also
XFilePicker

Member Function Documentation

createWithMode ( [in] short  Mode)

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 existence of a file and issue a warning if a file with the same name already exist.

See Also
com::sun::star::ui::dialogs::TemplateDescription

The documentation for this service was generated from the following file: