Sophie

Sophie

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

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

<html>
<head>
<title>Interface XController</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="XController-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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">frame</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XController</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XController</strong>
&#x2517 ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</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="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>allows to exclicitly free resources and break cyclic references.
 
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>With this interface, components viewed in a <a href="Frame.html">Frame</a> can serve
 events (by supplying dispatches).

 </dd>
<dt><b>See also</b></dt>
<dd><a href="XFrame.html">XFrame</a>, ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a>, <a href="XModel.html">XModel</a></dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Component/Getting_Frames%2C_Controllers_and_Models_from_Each_Other">OfficeDev - Component - Getting Frames, Controllers and Models from Each Other</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Controllers">OfficeDev - Controllers</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Frame-Controller-Model_Paradigm_in_OpenOffice.org">OfficeDev - Frame-Controller-Model Paradigm in OpenOffice.org</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="#attachFrame">attachFrame</a></td>
<td class="imsum_right">is called to attach the controller with its managing frame.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#attachModel">attachModel</a></td>
<td class="imsum_right">is called to attach the controller to a new model.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#suspend">suspend</a></td>
<td class="imsum_right">is called to prepare the controller for closing the view

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getViewData">getViewData</a></td>
<td class="imsum_right">provides access to current view status

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#restoreViewData">restoreViewData</a></td>
<td class="imsum_right">restores the view status using the data gotten from a previous call to
 <a href="XController.html">XController</a>::<a href="XController.html#getViewData">getViewData()</a>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getModel">getModel</a></td>
<td class="imsum_right">provides access to currently attached model

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFrame">getFrame</a></td>
<td class="imsum_right">provides access to owner frame of this controller

 &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="attachFrame" class="membertitle">attachFrame</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>attachFrame</b>(</td>
<td valign="top">[in] <a href="XFrame.html">XFrame</a></td>
<td valign="bottom">&nbsp;Frame );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>is called to attach the controller with its managing frame.

 </dd>
<dt><b>Parameter Frame</b></dt>
<dd>the new owner frame of this controller
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="attachModel" class="membertitle">attachModel</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>attachModel</b>(</td>
<td valign="top">[in] <a href="XModel.html">XModel</a></td>
<td valign="bottom">&nbsp;Model );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>is called to attach the controller to a new model.

 </dd>
<dt><b>Parameter Model</b></dt>
<dd>the new model for this controller

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b>if attach was successfully
 <br>
 <b>false</b>otherwise
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="suspend" class="membertitle">suspend</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>suspend</b>(</td>
<td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;Suspend );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>is called to prepare the controller for closing the view

 </dd>
<dt><b>Parameter Suspend</b></dt>
<dd><b>true</b>force the controller to suspend his work
 <b>false</b>try to reactivate the controller

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b>if request was accepted and of course successfully finished
 <br>
 <b>false</b>otherwise
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getViewData" class="membertitle">getViewData</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>getViewData</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides access to current view status

 </dd>
<dt><b>Returns</b></dt>
<dd>set of data that can be used to restore the current view status
 at later time by using <a href="XController.html">XController</a>::<a href="XController.html#restoreViewData">restoreViewData()</a>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="restoreViewData" class="membertitle">restoreViewData</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>restoreViewData</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;Data );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>restores the view status using the data gotten from a previous call to
 <a href="XController.html">XController</a>::<a href="XController.html#getViewData">getViewData()</a>.

 </dd>
<dt><b>Parameter Data</b></dt>
<dd>set of data to restore it
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getModel" class="membertitle">getModel</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"><a href="XModel.html">XModel</a></td>
</tr>
<tr>
<td valign="top"><b>getModel</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides access to currently attached model

 </dd>
<dt><b>Returns</b></dt>
<dd>the currently attached model.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFrame" class="membertitle">getFrame</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"><a href="XFrame.html">XFrame</a></td>
</tr>
<tr>
<td valign="top"><b>getFrame</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides access to owner frame of this controller

 </dd>
<dt><b>Returns</b></dt>
<dd>the frame containing this controller.
 </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>