<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">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"><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> ┗ <a href="XModel.html">XModel</a> ┗ ::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>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>extends interface XModel. The following 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. </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. </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. </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. </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< string ></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> <dd><p>The names are usually logical view names. The following names have a defined meaning, i.e. every concrete implementation which returns such a name must ensure it has the same meaning, and if a concrete implementation has a view with the given meaning, it must give it the name as defined here: <ul> <li><b>Default</b> specifies the default view of the document.</li> <li><b>Preview</b> specifies a preview of the document. A minimal implementation of such a view is a <em>Default</em> view which is read-only.</li> <li><b>PrintPreview</b> specifies a print preview of the document.</li> </ul> </p> <p>Implementations of this interface might decide to support additional view names, which then are documented in the respective service descriptions.</p> </dd> <dt><b>Returns</b></dt> <dd>a sequence of names of all supported views for this document. </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="XController2.html">XController2</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"> Frame )</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> <dd><p>Effectively, this method is equivalent to calling <a href="#createView">createView</a> with the <code>ViewName</code> being <code>"Default"</code>.</p> </dd> <dt><b>Parameter Frame</b></dt> <dd>used to place the new created view there </dd> <dt><b>Returns</b></dt> <dd>the new view controller instance </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if one of the given parameter was wrong </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::uno::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="XController2.html">XController2</a></td> </tr> <tr> <td valign="top"><b>createViewController</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ViewName,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Arguments,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XFrame.html">XFrame</a></td> <td valign="bottom"> Frame )</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> <dd><p>The newly created controller must not be connected with the document and the frame. That is, you should neither call <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#setComponent">setComponent</a>, nor <a href="XController.html">XController</a>::<a href="XController.html#attachFrame">attachFrame</a>, nor <a href="XController.html">XController</a>::<a href="XController.html#attachModel">attachModel</a>, nor <a href="XModel.html">XModel</a>::<a href="XModel.html#connectController">connectController</a>, not <a href="XModel.html">XModel</a>::<a href="XModel.html#setCurrentController">setCurrentController</a>. All of this is the responsibility of the caller, which will do it in the proper order.</p> </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>Returns</b></dt> <dd>the new view controller instance </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if one of the given parameter was wrong </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::uno::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 © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
