LibreOffice
LibreOffice 24.2 SDK API Reference
|
This service enables a filter developer to register a dialog to query for user options before the filter operation is performed. More...
import"FilterOptionsDialog.idl";
Exported Interfaces | |
interface | com::sun::star::beans::XPropertyAccess |
this interface is used to set the property values of the com::sun::star::document::MediaDescriptor before executing the dialog and to retrieve the changed com::sun::star::document::MediaDescriptor More... | |
interface | ::com::sun::star::ui::dialogs::XExecutableDialog |
this interface executes a dialog that displays the options for a filter. More... | |
Additional Inherited Members | |
![]() | |
sequence< com::sun::star::beans::PropertyValue > | getPropertyValues () |
void | setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the values of given properties. More... | |
![]() | |
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... | |
![]() | |
void | setTitle ([in] string aTitle) |
Sets the title of the dialog. More... | |
short | execute () |
Executes (shows) the dialog. More... | |
This service enables a filter developer to register a dialog to query for user options before the filter operation is performed.
The user options are stored inside the com::sun::star::document::MediaDescriptor and can be queried from the com::sun::star::document::MediaDescriptor by the component that implements com::sun::star::document::XFilter.
The application will set the com::sun::star::document::MediaDescriptor using the interface com::sun::star::beans::XPropertyAccess and then call XExecutableDialog::execute().
If that method returns ExecutableDialogResults::OK
, the application will retrieve the changed com::sun::star::document::MediaDescriptor back using the interface com::sun::star::beans::XPropertyAccess. The filter operation is then continued, using the new com::sun::star::document::MediaDescriptor.
Otherwise, the filter operation is canceled.
interface ::com::sun::star::ui::dialogs::XExecutableDialog |
this interface executes a dialog that displays the options for a filter.
If XExecutableDialog::execute() returns ExecutableDialogResults::OK
, the options can be retrieved by calling com::sun::star::beans::XPropertyAccess::getPropertyValues.
interface com::sun::star::beans::XPropertyAccess |
this interface is used to set the property values of the com::sun::star::document::MediaDescriptor before executing the dialog and to retrieve the changed com::sun::star::document::MediaDescriptor
afterwards.