<html> <head> <title>Interface XObjectInspectorUI</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="XObjectInspectorUI-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">inspection</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 XObjectInspectorUI</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>grants access to certain aspects of the user interface of an object inspector </dd> <dd><p>This interface is used as callback for <a href="XPropertyHandler.html">XPropertyHandler</a>s.</p> <p>As a consequence, methods operating on the UI for a property, and taking the name of this property, are tolerant against properties which do not exist. For instance, if a property handler tries to disable the UI for property <code>Foo</code>, but another handler has superseded this property, then the <a href="ObjectInspector.html">ObjectInspector</a> will not <em>have</em> any UI for it. In this case, the call to <code>enablePropertyUI( "Foo" )</code> will simply be ignored.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0.3</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="#enablePropertyUI">enablePropertyUI</a></td> <td class="imsum_right">enables or disables all components belonging to the UI representation of a property </td> </tr> <tr> <td class="imsum_left"><a href="#enablePropertyUIElements">enablePropertyUIElements</a></td> <td class="imsum_right">enables or disables the single elements which can be part of the UI representation of a property </td> </tr> <tr> <td class="imsum_left"><a href="#rebuildPropertyUI">rebuildPropertyUI</a></td> <td class="imsum_right">completely rebuilds the UI for the given property. </td> </tr> <tr> <td class="imsum_left"><a href="#showPropertyUI">showPropertyUI</a></td> <td class="imsum_right">shows the UI for a given property </td> </tr> <tr> <td class="imsum_left"><a href="#hidePropertyUI">hidePropertyUI</a></td> <td class="imsum_right">hides the UI for a given property </td> </tr> <tr> <td class="imsum_left"><a href="#showCategory">showCategory</a></td> <td class="imsum_right">shows or hides all properties belonging to a given category </td> </tr> <tr> <td class="imsum_left"><a href="#getPropertyControl">getPropertyControl</a></td> <td class="imsum_right">retrieves the control currently used to display a given property </td> </tr> <tr> <td class="imsum_left"><a href="#registerControlObserver">registerControlObserver</a></td> <td class="imsum_right">registers an observer for all property controls </td> </tr> <tr> <td class="imsum_left"><a href="#revokeControlObserver">revokeControlObserver</a></td> <td class="imsum_right">revokes a previously registered control observer </td> </tr> <tr> <td class="imsum_left"><a href="#setHelpSectionText">setHelpSectionText</a></td> <td class="imsum_right">sets the text of the help section, if the object inspector contains one. </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="enablePropertyUI" class="membertitle">enablePropertyUI</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>enablePropertyUI</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> Enable );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>enables or disables all components belonging to the UI representation of a property </dd> <dd><p>This is usually used by an <a href="XPropertyHandler.html">XPropertyHandler</a> if it handles properties, where one does only make sense if another one has a certain value.</p> </dd> <dt><b>Parameter PropertyName</b></dt> <dd>denotes the name of the property whose UI is to be enabled or disabled. </dd> <dt><b>Parameter Enable</b></dt> <dd><b>true</b> if and only if the UI should be disabled, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="enablePropertyUIElements" class="membertitle">enablePropertyUIElements</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>enablePropertyUIElements</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> Elements,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> Enable );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>enables or disables the single elements which can be part of the UI representation of a property </dd> <dd><p>Note that the complete UI for the property must be enabled in order for these settings to be evaluated. That is, <a href="#enablePropertyUIElements">enablePropertyUIElements</a> does not have any effect if somebody previously disabled the complete UI for this property with <a href="#enablePropertyUI">enablePropertyUI</a>.</p> </dd> <dt><b>Parameter PropertyName</b></dt> <dd>the name of the property whose user interface elements are to be enabled or disabled </dd> <dt><b>Parameter Elements</b></dt> <dd>a combination of <a href="PropertyLineElement.html">PropertyLineElement</a> flags specifying which elements are to be enabled or disabled.<br/> Note that if you don't set a particular bit here (say, <a href="PropertyLineElement.html">PropertyLineElement</a>::<a href="PropertyLineElement.html#PrimaryButton">PrimaryButton</a>), this does mean that this element's state is not affected by the call - it does <em>not</em> mean that it is disabled. </dd> <dt><b>Parameter Enable</b></dt> <dd><b>true</b> if the elements denoted by <arg>_nElements</arg> should be enabled, <b>false</b> if they should be disabled. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="rebuildPropertyUI" class="membertitle">rebuildPropertyUI</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>rebuildPropertyUI</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>completely rebuilds the UI for the given property. </dd> <dd><p>This method might be used by an <a href="XPropertyHandler.html">XPropertyHandler</a> if it wants to change the type of control (see <a href="PropertyControlType.html">PropertyControlType</a>) used to display a certain property.</p> <p>The object inspector will then call describePropertyLine again, and update its UI accordingly.</p> <p>Note that the property whose UI should be rebuilt must not necessarily be (though usually <em>is</em>) in the responsibility of the handler which calls this method. The object inspector will look up the handler with the responsibility for <arg>PropertyName</arg> and call its <a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#describePropertyLine">describePropertyLine</a></p> </dd> <dt><b>Parameter PropertyName</b></dt> <dd>the name of the property whose UI is to be completely rebuilt. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="showPropertyUI" class="membertitle">showPropertyUI</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>showPropertyUI</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>shows the UI for a given property </dd> <dt><b>Parameter PropertyName</b></dt> <dd>the name of the property whose UI is to be shown </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hidePropertyUI" class="membertitle">hidePropertyUI</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>hidePropertyUI</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>hides the UI for a given property </dd> <dt><b>Parameter PropertyName</b></dt> <dd>the name of the property whose UI is to be hidden </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="showCategory" class="membertitle">showCategory</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>showCategory</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> Category,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> Show );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>shows or hides all properties belonging to a given category </dd> <dt><b>See also</b></dt> <dd><a href="LineDescriptor.html">LineDescriptor</a>::<a href="LineDescriptor.html#Category">Category</a>, <a href="XObjectInspectorModel.html">XObjectInspectorModel</a>::<a href="XObjectInspectorModel.html#describeCategories">describeCategories</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPropertyControl" class="membertitle">getPropertyControl</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="XPropertyControl.html">XPropertyControl</a></td> </tr> <tr> <td valign="top"><b>getPropertyControl</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the control currently used to display a given property </dd> <dt><b>Parameter PropertyName</b></dt> <dd>the name of the property whose control should be retrieved </dd> <dt><b>Returns</b></dt> <dd>the <a href="XPropertyControl.html">XPropertyControl</a> representing the given property, or <b>NULL</b> if there is no such property control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="registerControlObserver" class="membertitle">registerControlObserver</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>registerControlObserver</b>(</td> <td valign="top">[in] <a href="XPropertyControlObserver.html">XPropertyControlObserver</a></td> <td valign="bottom"> Observer );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers an observer for all property controls </dd> <dd><p>The given XPropertyControlObserver will be notified of all changes in all property controls.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.2 </dd> <dt><b>See also</b></dt> <dd><a href="#revokeControlObserver">revokeControlObserver</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="revokeControlObserver" class="membertitle">revokeControlObserver</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>revokeControlObserver</b>(</td> <td valign="top">[in] <a href="XPropertyControlObserver.html">XPropertyControlObserver</a></td> <td valign="bottom"> Observer );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>revokes a previously registered control observer </dd> <dt><b>Since </b></dt> <dd>OOo 2.2 </dd> <dt><b>See also</b></dt> <dd><a href="#registerControlObserver">registerControlObserver</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setHelpSectionText" class="membertitle">setHelpSectionText</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>setHelpSectionText</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> HelpText )</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/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the text of the help section, if the object inspector contains one. </dd> <dt><b>Throws</b></dt> <dd>NoSupportException if the <a href="XObjectInspectorModel.html">XObjectInspectorModel</a>::<a href="XObjectInspectorModel.html#HasHelpSection">HasHelpSection</a> property requires the help section to be unavailable. </dd> <dt><b>Since </b></dt> <dd>OOo 2.2 </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>
