Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 7795

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XFilePickerControlAccess</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="XFilePickerControlAccess-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' 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">interface XFilePickerControlAccess</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XFilePickerControlAccess</strong>
&#x2517 <a href="XFilePicker.html">XFilePicker</a>
   &#x2517 <a href="XExecutableDialog.html">XExecutableDialog</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XFilePicker.html">XFilePicker</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>Specifies an interface for a FilePicker
</dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Provides access to the controls of a FilePicker.

 </dd>
<dd><p> A FilePicker may contain additional elements according to the needs
 of the different applications. These additional elements can be
 addressed by this interface.</p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="FilePicker.html">FilePicker</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setValue">setValue</a></td>
<td class="imsum_right">Set the value of an additional element within a FilePicker. 

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getValue">getValue</a></td>
<td class="imsum_right">Get the value of an additional element within a FilePicker
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setLabel">setLabel</a></td>
<td class="imsum_right">Set the label of the specified element. If the specified element
 doesn't support setting a label, this method has no effect. 

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getLabel">getLabel</a></td>
<td class="imsum_right">Returns the label of the specified element. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#enableControl">enableControl</a></td>
<td class="imsum_right">Enables or disables a control.

 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="setValue" class="membertitle">setValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setValue</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;aControlId,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;aControlAction,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom">&nbsp;aValue );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set the value of an additional element within a FilePicker. 

 </dd>
<dt><b>Parameter ControlId</b></dt>
<dd>Identifies the element which value is to be set.

 </dd>
<dt><b>Parameter aControlAction</b></dt>
<dd>Specifies an action to perform with the given value.
 aControlAction has to be one of the values defined in <a href="ControlActions.html">ControlActions</a>.
 Not all of the values are valid for all controls.
 To add a new filter to the FilePicker use the interface XFilterManager, but 
 optionally an implementation may also support adding new filter using this
 method.
 
 </dd>
<dt><b>Parameter aValue</b></dt>
<dd>The value to set. For checkboxes aValue should be a boolean value that
 should be <b>true</b> if the checkbox should be checked and <b>false</b> otherwise.
 
 </dd>
<dt><b>See also</b></dt>
<dd><a href="CommonFilePickerElementIds.html">CommonFilePickerElementIds</a>, <a href="ExtendedFilePickerElementIds.html">ExtendedFilePickerElementIds</a>, <a href="ControlActions.html">ControlActions</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getValue" class="membertitle">getValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">any</td>
</tr>
<tr>
<td valign="top"><b>getValue</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;aControlId,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;aControlAction );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get the value of an additional element within a FilePicker
 
 </dd>
<dt><b>Parameter aControlId</b></dt>
<dd>Identifies the element for which value is requested.

 </dd>
<dt><b>Parameter aControlAction</b></dt>
<dd>Specifies which value to retrieve.
 aControlAction has to be one of the values defined in <a href="ControlActions.html">ControlActions</a>.
 Not all of the values are valid for all controls.

 </dd>
<dt><b>Returns</b></dt>
<dd>The value of the specified element. If the specified control
 is a checkbox the returned value is a boolean that is <b>true</b>
 if the checkbox is checked <b>false</b> otherwise.
 If the specified element doesn't exist or the specified element
 doesn't support the specidfied control action an empty any will be
 returned.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="CommonFilePickerElementIds.html">CommonFilePickerElementIds</a>, <a href="ExtendedFilePickerElementIds.html">ExtendedFilePickerElementIds</a>, <a href="ControlActions.html">ControlActions</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setLabel" class="membertitle">setLabel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setLabel</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;aControlId,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aLabel );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set the label of the specified element. If the specified element
 doesn't support setting a label, this method has no effect. 

 </dd>
<dt><b>Parameter aControlId</b></dt>
<dd>Identifies the element for which the label should be set.

 </dd>
<dt><b>Parameter aLabel</b></dt>
<dd>The label to be set.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="CommonFilePickerElementIds.html">CommonFilePickerElementIds</a>, <a href="ExtendedFilePickerElementIds.html">ExtendedFilePickerElementIds</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getLabel" class="membertitle">getLabel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getLabel</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;aControlId );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the label of the specified element. 
 
 </dd>
<dt><b>Parameter aControlId</b></dt>
<dd>Identifies the element for which the label should be returned.

 </dd>
<dt><b>Returns</b></dt>
<dd>The label of the specified element or an empty string if
 the specified element has no or supports no label or the
 specified element doesn't exist.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="CommonFilePickerElementIds.html">CommonFilePickerElementIds</a>, <a href="ExtendedFilePickerElementIds.html">ExtendedFilePickerElementIds</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="enableControl" class="membertitle">enableControl</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>enableControl</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;aControlId,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bEnable );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Enables or disables a control.

 </dd>
<dt><b>Parameter ControlId</b></dt>
<dd>Identifies the control.

 </dd>
<dt><b>Parameter bEnable</b></dt>
<dd><p>If <b>true</b> the specified control will be enabled.</p>
 <p>If <b>false</b> the specified control will be disabled.</p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="CommonFilePickerElementIds.html">CommonFilePickerElementIds</a>, <a href="ExtendedFilePickerElementIds.html">ExtendedFilePickerElementIds</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, 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.</p>

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

</html>