Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 7430

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Service FilterOptionsDialog</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="FilterOptionsDialog-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub">Included Services</td>
<td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td>
<td class="navisub">Properties' Summary</td>
<td class="navisub">Properties' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">ui</a> :: <a href="module-ix.html" class="namechain">dialogs</a> :: </p>
</td>
</tr>
<tr>
<td class="title">service FilterOptionsDialog</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>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::<a href="../../document/module-ix.html">document</a>::<a href="../../document/MediaDescriptor.html">MediaDescriptor</a>
 and can be queried from the ::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/MediaDescriptor.html">MediaDescriptor</a> by
 the component that implements ::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/XFilter.html">XFilter</a>.

 The application will set the ::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/MediaDescriptor.html">MediaDescriptor</a>
 using the interface ::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/XPropertyAccess.html">XPropertyAccess</a> and then
 call <method>XExecutableDialog::execute<method>.

 If that method returns <code>ExecutableDialogResults::OK</code>,
 the application will retrieve the changed ::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/MediaDescriptor.html">MediaDescriptor</a>
 back using the interface ::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/XPropertyAccess.html">XPropertyAccess</a>. The filter
 operation is than continued, using the new ::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/MediaDescriptor.html">MediaDescriptor</a>.
 
 Otherwise, the filter operation is canceled.

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
<hr>
<a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/XPropertyAccess.html">XPropertyAccess</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>this interface is used to set the property values of the
 ::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/MediaDescriptor.html">MediaDescriptor</a> before executing
 the dialog and to retrieve the changed ::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/MediaDescriptor.html">MediaDescriptor</a>

 afterwards.
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XExecutableDialog.html">XExecutableDialog</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>this interface executes a dialog that displays the options
 for a filter.
 If <method>XExecutableDialog::execute<method>
 returns <code>ExecutableDialogResults::OK</code>,
 the options can be retrieved by calling <method scope="com::sun::star::beans">XPropertyAccess::getPropertyValues<method>.
 </dd>
</dl>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>