LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XFilePickerListener Interface Referencepublished

Interface to be implemented by a FilePicker listener. More...

import"XFilePickerListener.idl";

Inheritance diagram for XFilePickerListener:
XEventListener XInterface

Public Member Functions

void fileSelectionChanged ([in] FilePickerEvent aEvent)
 A client receives this event if the file selection within the FilePicker service dialog changes. More...
 
void directoryChanged ([in] FilePickerEvent aEvent)
 A client receives this event if the directory selection within the FilePicker dialog changes. More...
 
string helpRequested ([in] FilePickerEvent aEvent)
 A client receives this event if the F1 key or the help button was pressed. More...
 
void controlStateChanged ([in] FilePickerEvent aEvent)
 A client receives this event if the state of a control within the FilePicker service dialog changes. More...
 
void dialogSizeChanged ()
 A client receives this event if the size of the FilePicker dialog has changed. More...
 
- Public Member Functions inherited from XEventListener
void disposing ([in] com::sun::star::lang::EventObject Source)
 gets called when the broadcaster is about to be disposed. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed 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.

Member Function Documentation

void controlStateChanged ( [in] FilePickerEvent  aEvent)

A client receives this event if the state of a control within the FilePicker service dialog changes.

Parameters
aEventof type FilePickerEvent that describes the event.
See also
com::sun::star::ui::dialogs::FilePickerEvent
void 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.

void directoryChanged ( [in] FilePickerEvent  aEvent)

A client receives this event if the directory selection within the FilePicker dialog changes.

Parameters
aEventOf type FilePickerEvent that describes the event.
See also
com::sun::star::ui::dialogs::FilePickerEvent
void fileSelectionChanged ( [in] FilePickerEvent  aEvent)

A client receives this event if the file selection within the FilePicker service dialog changes.

Parameters
aEventof type FilePickerEvent that describes the event
See also
com::sun::star::ui::dialogs::FilePickerEvent
string helpRequested ( [in] FilePickerEvent  aEvent)

A client receives this event if the F1 key or the help button was pressed.

Parameters
aEventof 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
com::sun::star::ui::dialogs::FilePickerEvent

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