Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XFilePickerListener
Base Interfaces
XFilePickerListener
┗ ::com::sun::star::lang::XEventListener

::com::sun::star::lang::XEventListener
(referenced interface's summary:)
base interface for all event listeners interfaces.
Description
Interface to be implemented by a FilePicker listener.

The XFilePickerListener interface must be implemented by the clients of the FilePicker service which need to be informed about events while the FilePicker service is displayed.


Methods' Summary
fileSelectionChanged A client receives this event if the file selection within the FilePicker service dialog changes.  
directoryChanged A client receives this event if the directory selection within the FilePicker dialog changes.  
helpRequested A client receives this event if the F1 key or the help button was pressed.  
controlStateChanged A client receives this event if the state of a control within the FilePicker service dialog changes.  
dialogSizeChanged 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.  
Methods' Details
fileSelectionChanged
void
fileSelectionChanged( [in] FilePickerEvent  aEvent );

Description
A client receives this event if the file selection within the FilePicker service dialog changes.
Parameter aEvent
of type FilePickerEvent that describes the event
See also
FilePickerEvent
directoryChanged
void
directoryChanged( [in] FilePickerEvent  aEvent );

Description
A client receives this event if the directory selection within the FilePicker dialog changes.
Parameter aEvent
Of type FilePickerEvent that describes the event.
See also
FilePickerEvent
helpRequested
string
helpRequested( [in] FilePickerEvent  aEvent );

Description
A client receives this event if the F1 key or the help button was pressed.
Parameter aEvent
of type FilePickerEvent that describes the event
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.
See also
FilePickerEvent
controlStateChanged
void
controlStateChanged( [in] FilePickerEvent  aEvent );

Description
A client receives this event if the state of a control within the FilePicker service dialog changes.
Parameter aEvent
of type FilePickerEvent that describes the event.
See also
FilePickerEvent
dialogSizeChanged
void
dialogSizeChanged();

Description
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.
Top of Page

Apache Software Foundation

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

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