Sophie

Sophie

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

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

<html>
<head>
<title>Interface XModel2</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="XModel2-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">frame</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XModel2</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XModel2</strong>
&#x2517 <a href="XModel.html">XModel</a>
   &#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"><a href="XModel.html">XModel</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>represents a component which is created from an URL and arguments.

 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>extends interface XModel.
 
 The foloowing functions are added:
 
 - enumeration of all currently connected controller objects.
 (not getCurrentController() only, which depends on focus)
 
 - establish new view controller factory methods, which will make
 it possible to create new views for this model.
 </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="#getControllers">getControllers</a></td>
<td class="imsum_right">provides list of all currently connected controller objects.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAvailableViewControllerNames">getAvailableViewControllerNames</a></td>
<td class="imsum_right">provides the available names of the factory to be used to create views.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createDefaultViewController">createDefaultViewController</a></td>
<td class="imsum_right">creates the default view instance for this model.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createViewController">createViewController</a></td>
<td class="imsum_right">creates a new view instance classified by the specified name and arguments.
 
 &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="getControllers" class="membertitle">getControllers</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="../container/module-ix.html">container</a>::<a href="../container/XEnumeration.html">XEnumeration</a></td>
</tr>
<tr>
<td valign="top"><b>getControllers</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides list of all currently connected controller objects.

 </dd>
<dd><p>
 Please note: Because this interface will might be used inside
 multi threaded environments those list can contain still disposed items
 or it new added controller will be missing (if they was added after this
 enumeration was created).
 </P>

 </dd>
<dt><b>Returns</b></dt>
<dd>list of controller objects.
 Enumeration can be empty but not NULL.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAvailableViewControllerNames" class="membertitle">getAvailableViewControllerNames</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">sequence&lt; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getAvailableViewControllerNames</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides the available names of the factory to be used to create views.

 </dd>
<dt><b>Returns</b></dt>
<dd>sequence of all view names
 </dd>
<dt><b>See also</b></dt>
<dd><a href="#createView()">createView()</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createDefaultViewController" class="membertitle">createDefaultViewController</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="XController.html">XController</a></td>
</tr>
<tr>
<td valign="top"><b>createDefaultViewController</b>(</td>
<td valign="top">[in] <a href="XFrame.html">XFrame</a></td>
<td valign="bottom">&nbsp;Frame,</td>
</tr>
<tr>
<td/><td valign="top">[out] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td>
<td valign="bottom">&nbsp;ComponentWindow )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>creates the default view instance for this model.
 
 </dd>
<dt><b>Parameter Frame</b></dt>
<dd>used to place the new created view there
 
 </dd>
<dt><b>Parameter ComponentWindow</b></dt>
<dd>returns a suitable component window for the new created view controller
 
 </dd>
<dt><b>Returns</b></dt>
<dd>the new view controller instance
 
 @throw IllegalArgumentException
 if one of the given parameter was wrong
 
 @throw Exception
 if creation of a new view failed by other reasons
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createViewController" class="membertitle">createViewController</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="XController.html">XController</a></td>
</tr>
<tr>
<td valign="top"><b>createViewController</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;ViewName,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;Arguments,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XFrame.html">XFrame</a></td>
<td valign="bottom">&nbsp;Frame,</td>
</tr>
<tr>
<td/><td valign="top">[out] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td>
<td valign="bottom">&nbsp;ComponentWindow )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>creates a new view instance classified by the specified name and arguments.
 
 </dd>
<dt><b>Parameter ViewName</b></dt>
<dd>classified name of instance
 
 </dd>
<dt><b>Parameter Arguments</b></dt>
<dd>arguments used for creation
 
 </dd>
<dt><b>Parameter Frame</b></dt>
<dd>used to place the new created view there
 
 </dd>
<dt><b>Parameter ComponentWindow</b></dt>
<dd>returns a suitable component window for the new created view controller
 
 </dd>
<dt><b>Returns</b></dt>
<dd>the new view controller instance
 
 @throw IllegalArgumentException
 if one of the given parameter was wrong
 
 @throw Exception
 if creation of a new view failed by other reasons
 </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>