(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

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

service FilterOptionsDialog
Description
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 than continued, using the new ::com::sun::star::document::MediaDescriptor.

Otherwise, the filter operation is canceled.

Since
OOo 1.1.2
Exported Interfaces - Summary
::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.

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 XPropertyAccess::getPropertyValues.

Exported Interfaces - Details
::com::sun::star::beans::XPropertyAccess
Description
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.
XExecutableDialog
Description
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 XPropertyAccess::getPropertyValues.

 Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.