Sophie

Sophie

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

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

<html>
<head>
<title>Interface XFormController</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="XFormController-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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">form</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XFormController</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XFormController</strong>
&#x2517 ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XTabController.html">XTabController</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XTabController.html">XTabController</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>specifies the basic operations for a tab controller.
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides functionality to control the activation of forms controls.

 </dd>
<dd><p>There is a duality of forms (::com::sun::star::form::<a href="component/module-ix.html">component</a>::<a href="component/DataForm.html">DataForm</a>)
 and form controllers. In a document view, for every loaded form there is a form controller which is
 responsible for exactly the controls which's models are direct children of the form.<br/>

 In some sense, a form controller is the view representation of a form, like a <em>form control</em> is the
 view representation of a <em>form control model</em>.<br/>

 This is also reflected in this interface: If you call
 <method scope="com::sun::star::awt">XTabController::getModel</method> on a form controller, the form which
 the controller is responsible for will be returned.<br/>

 As always in the model-view-paradigm, there is no way from a model to its controller, mostly, because for
 <em>one</em> given form, there is one controller for <em>every</em> view of the document.</p>

 <p>A controller is called <em>active</em> if one of the controls it is responsible for has the focus,
 else inactive. To be notified whenever this activation state of a given controller changes, you can
 add listeners.</p>

 </dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::form::<a href="component/module-ix.html">component</a>::<a href="component/Form.html">Form</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="#getCurrentControl">getCurrentControl</a></td>
<td class="imsum_right">access to the currently active control

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addActivateListener">addActivateListener</a></td>
<td class="imsum_right">adds the specified listener to receive notifications whenever the activation state of
 the controller changes.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeActivateListener">removeActivateListener</a></td>
<td class="imsum_right">removes the specified listener

 &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="getCurrentControl" class="membertitle">getCurrentControl</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">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XControl.html">XControl</a></td>
</tr>
<tr>
<td valign="top"><b>getCurrentControl</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>access to the currently active control

 </dd>
<dt><b>Returns</b></dt>
<dd>the currently active control, or <b>NULL</b> if there is no such control
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addActivateListener" class="membertitle">addActivateListener</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">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>addActivateListener</b>(</td>
<td valign="top">[in] <a href="XFormControllerListener.html">XFormControllerListener</a></td>
<td valign="bottom">&nbsp;l );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds the specified listener to receive notifications whenever the activation state of
 the controller changes.

 </dd>
<dt><b>Parameter l</b></dt>
<dd>the listener to add.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeActivateListener" class="membertitle">removeActivateListener</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">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>removeActivateListener</b>(</td>
<td valign="top">[in] <a href="XFormControllerListener.html">XFormControllerListener</a></td>
<td valign="bottom">&nbsp;l );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes the specified listener

 </dd>
<dt><b>Parameter l</b></dt>
<dd>the listener to remove.
 </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; 2008 Sun Microsystems, Inc.</p>

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

</html>