<html> <head> <title>Interface XControl</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="XControl-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">awt</a> :: </p> </td> </tr> <tr> <td class="title">interface XControl</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XControl</strong> ┗ ::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>identifies a control. </dd> <dd><p>Implementations of this interface are abstract windows. The main reason to instantiate this implementation is to show the window on the screen. Before the window appears on the screen, the <a href="XControl.html#createPeer">createPeer</a> method must be called.</p> <p>If the implementation of the control does not distinguish between model, view and controller, it must allow to set a new XGraphics in the view, so that the control can be printed.</p> </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="#setContext">setContext</a></td> <td class="imsum_right">sets the context of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#getContext">getContext</a></td> <td class="imsum_right">gets the context of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#createPeer">createPeer</a></td> <td class="imsum_right">creates a "child" window on the screen. </td> </tr> <tr> <td class="imsum_left"><a href="#getPeer">getPeer</a></td> <td class="imsum_right">returns the peer which was previously created or set. </td> </tr> <tr> <td class="imsum_left"><a href="#setModel">setModel</a></td> <td class="imsum_right">sets a model for the control. </td> </tr> <tr> <td class="imsum_left"><a href="#getModel">getModel</a></td> <td class="imsum_right">returns the model for this control. </td> </tr> <tr> <td class="imsum_left"><a href="#getView">getView</a></td> <td class="imsum_right">returns the view of this control. </td> </tr> <tr> <td class="imsum_left"><a href="#setDesignMode">setDesignMode</a></td> <td class="imsum_right">sets the design mode for use in a design editor. </td> </tr> <tr> <td class="imsum_left"><a href="#isDesignMode">isDesignMode</a></td> <td class="imsum_right">returns <b>true</b> if the control is in design mode, <b>false</b> otherwise. </td> </tr> <tr> <td class="imsum_left"><a href="#isTransparent">isTransparent</a></td> <td class="imsum_right">returns <b>true</b> if the control is transparent, <b>false</b> otherwise. </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="setContext" class="membertitle">setContext</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>setContext</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> Context );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the context of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getContext" class="membertitle">getContext</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="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>getContext</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the context of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createPeer" class="membertitle">createPeer</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>createPeer</b>(</td> <td valign="top">[in] <a href="XToolkit.html">XToolkit</a></td> <td valign="bottom"> Toolkit,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XWindowPeer.html">XWindowPeer</a></td> <td valign="bottom"> Parent );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a "child" window on the screen. </dd> <dd><p>If the parent is NULL, then the desktop window of the toolkit is the parent.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPeer" class="membertitle">getPeer</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="XWindowPeer.html">XWindowPeer</a></td> </tr> <tr> <td valign="top"><b>getPeer</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the peer which was previously created or set. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setModel" class="membertitle">setModel</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>setModel</b>(</td> <td valign="top">[in] <a href="XControlModel.html">XControlModel</a></td> <td valign="bottom"> Model );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a model for the control. </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="XControlModel.html">XControlModel</a></td> </tr> <tr> <td valign="top"><b>getModel</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the model for this control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getView" class="membertitle">getView</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="XView.html">XView</a></td> </tr> <tr> <td valign="top"><b>getView</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the view of this control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setDesignMode" class="membertitle">setDesignMode</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>setDesignMode</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bOn );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the design mode for use in a design editor. </dd> <dd><p>Normally the control will be painted directly without a peer.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isDesignMode" class="membertitle">isDesignMode</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>isDesignMode</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns <b>true</b> if the control is in design mode, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isTransparent" class="membertitle">isTransparent</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>isTransparent</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns <b>true</b> if the control is transparent, <b>false</b> otherwise. </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>
