<html> <head> <title>Interface XObjectInspector</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="XObjectInspector-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="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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 XObjectInspector</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XObjectInspector</strong> ┣ ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a> ┃ ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┗ ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XDispatchProvider.html">XDispatchProvider</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="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to plug the inspector into an ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XFrame.html">XFrame</a> </dd> <dd><p>The ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a>::<a href="../frame/XController.html#setModel">setModel</a> method accepts only <a href="XObjectInspectorModel.html">XObjectInspectorModel</a>s, and will return <b>false</b> if the to-be-attached model is not <b>NULL</b>, but does not support this interface.</p> <p>If you do not want to support a full-blown ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a>, use the <a href="XObjectInspector.html#InspectorModel">InspectorModel</a> attribute instead.</p> <p>The ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a>::<a href="../frame/XController.html#getViewData">getViewData</a> and ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a>::<a href="../frame/XController.html#restoreViewData">restoreViewData</a> exchange string values, which describes as much of the current view state as possible.</p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XDispatchProvider.html">XDispatchProvider</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to intercept functionality </dd> <dd><p>This interface is inherited from the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/Controller.html">Controller</a> service, currently, there is no functionality to intercept at an <a href="XObjectInspector.html">XObjectInspector</a>.</p> </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>describes the main interface of an <a href="ObjectInspector.html">ObjectInspector</a>. </dd> <dt><b>Since </b></dt> <dd>OOo 2.0.3</dd> <dt><b>See also</b></dt> <dd><a href="ObjectInspector.html">ObjectInspector</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="#inspect">inspect</a></td> <td class="imsum_right">inspects a new collection of one or more objects. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#InspectorModel">InspectorModel</a></td> <td class="imsum_right">provides access to the current model of the inspector </td> </tr> <tr> <td class="imsum_left"><a href="#InspectorUI">InspectorUI</a></td> <td class="imsum_right">provides access to the user interface of the object inspector. </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="inspect" class="membertitle">inspect</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>inspect</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a> ></td> <td valign="bottom"> Objects )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/VetoException.html">VetoException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inspects a new collection of one or more objects. </dd> <dd><p>If the sequence is empty, the UI of the <a href="ObjectInspector.html">ObjectInspector</a> will be cleared.</p> <p>If the sequence contains more than one object, the <a href="XObjectInspector.html">XObjectInspector</a> will create a complete set of property handlers (as indicated by <a href="XObjectInspectorModel.html">XObjectInspectorModel</a>::<a href="XObjectInspectorModel.html#HandlerFactories">HandlerFactories</a>) for <em>every</em> of the objects, and compose their output.</p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::util::VetoException if the inspector cannot switch to another object set. This typically happens if one of the active <a href="XPropertyHandler.html">XPropertyHandler</a>'s raised a non-modal user interface, and vetoed suspension of this UI. </dd> <dt><b>See also</b></dt> <dd><a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#isComposable">isComposable</a>, <a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#onInteractivePropertySelection">onInteractivePropertySelection</a>, <a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#suspend">suspend</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="InspectorModel" class="membertitle">InspectorModel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XObjectInspectorModel.html">XObjectInspectorModel</a> <b>InspectorModel</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the current model of the inspector </dd> <dd><p>The model is mainly responsible for providing the property handlers. Additionally, it can provide user interface names and help URLs for property categories.</p> <p>Note that there are two ways of setting or retrieving the current model: You can either use ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a>::<a href="../frame/XModel.html#setModel">setModel</a>, or, if you do not want or need to implement the full-blown ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a> interface, you can use this property directly. Both approaches are semantically equivalent.</p> <p>If a new model is set at the inspector, the complete UI will be rebuilt to reflect the change, using the new property handlers provided by the new model.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="InspectorUI" class="membertitle">InspectorUI</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XObjectInspectorUI.html">XObjectInspectorUI</a> <b>InspectorUI</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the user interface of the object inspector. </dd> <dd><p>This interface can be used to access and manipulate various aspects of the user interface. For instance, you can enable and disable certain property controls (or parts thereof), or register observers for all property controls.</p> </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>
