<html> <head> <title>Interface XObjectInspectorModel</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="XObjectInspectorModel-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 XObjectInspectorModel</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>describes the model of an <a href="ObjectInspector.html">ObjectInspector</a> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 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="#describeCategories">describeCategories</a></td> <td class="imsum_right">describes the property categories used by the property handlers. </td> </tr> <tr> <td class="imsum_left"><a href="#getPropertyOrderIndex">getPropertyOrderIndex</a></td> <td class="imsum_right">retrieves an index in a global property ordering, for a given property name </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="#HandlerFactories">HandlerFactories</a></td> <td class="imsum_right">describes a set of factories for creating <a href="XPropertyHandler.html">XPropertyHandler</a>s </td> </tr> <tr> <td class="imsum_left"><a href="#HasHelpSection">HasHelpSection</a></td> <td class="imsum_right">indicates that the object inspector should have a help section. </td> </tr> <tr> <td class="imsum_left"><a href="#MinHelpTextLines">MinHelpTextLines</a></td> <td class="imsum_right">denotes the minimum number of lines of text to be reserved for the help section. </td> </tr> <tr> <td class="imsum_left"><a href="#MaxHelpTextLines">MaxHelpTextLines</a></td> <td class="imsum_right">denotes the maximum number of lines of text to be reserved for the help section. </td> </tr> <tr> <td class="imsum_left"><a href="#IsReadOnly">IsReadOnly</a></td> <td class="imsum_right">determines whether the object inspector's UI should be read-only. </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="describeCategories" class="membertitle">describeCategories</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< <a href="PropertyCategoryDescriptor.html">PropertyCategoryDescriptor</a> ></td> </tr> <tr> <td valign="top"><b>describeCategories</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>describes the property categories used by the property handlers. </dd> <dd><p>Properties can be sorted into different categories, described by the <a href="LineDescriptor.html">LineDescriptor</a>::<a href="LineDescriptor.html#Category">Category</a> attribute, which is filled in <a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#describePropertyLine">describePropertyLine</a> method of your property handler.<br/> Those names provided by the handlers are programmatic names. All other information about categories is part of the <a href="PropertyCategoryDescriptor.html">PropertyCategoryDescriptor</a>, and <a href="#describeCategories">describeCategories</a> assembles information about all categories which all property handlers provided by the model use.</p> </dd> <dt><b>Returns</b></dt> <dd>a sequence of category descriptors. Their relative ordering also describes the relative ordering of the categories in the <a href="ObjectInspector.html">ObjectInspector</a>'s user interface.<br/> The sequence must not contain two entries with the same programmatic name.<br/> <br/> The model implementation might return an empty sequence here, in this case, the ObjectInspector automatically builds its category information from the categories provided by the property handlers. </dd> <dt><b>See also</b></dt> <dd><a href="PropertyCategoryDescriptor.html">PropertyCategoryDescriptor</a>, <a href="LineDescriptor.html">LineDescriptor</a>::<a href="LineDescriptor.html#Category">Category</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPropertyOrderIndex" class="membertitle">getPropertyOrderIndex</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">long</td> </tr> <tr> <td valign="top"><b>getPropertyOrderIndex</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves an index in a global property ordering, for a given property name </dd> <dd><p>In the user interface of an ObjectInspector, single properties are represented by single lines, and those lines are displayed successively. To determine an order of the property lines, the inspector model can associate an "order index" with each property. The <a href="ObjectInspector.html">ObjectInspector</a> will then sort the property lines in a way that they have the same relative ordering as the "order indexes" of their properties.</p> <p>Note that the concrete value the model returns for a given property does not matter. All what matters is that if you want a certain property <code>Foo</code> to be displayed after another property <code>Bar</code>, then the order index of <code>Foo</code> should be greater than the order index of <code>Bar</code>. <p>If for two different properties the same order index is returned, the <a href="ObjectInspector.html">ObjectInspector</a> will assume the order in which those properties were provided by the respective property handler (<a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#getSupportedProperties">getSupportedProperties</a>).<br/> If two such properties originate from different handlers, they will be ordered according to the order of the handlers, as provided in the <a href="#HandlerFactories">HandlerFactories</a> attribute.</p> </dd> <dt><b>Parameter PropertyName</b></dt> <dd>the property whose global order index should be retrieved </dd> <dt><b>Returns</b></dt> <dd>the global order index of <arg>PropertyName</arg>. </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="HandlerFactories" class="membertitle">HandlerFactories</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] sequence< any > <b>HandlerFactories</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>describes a set of factories for creating <a href="XPropertyHandler.html">XPropertyHandler</a>s </dd> <dd><p>Every element of the sequence must contain information to create a <a href="XPropertyHandler.html">XPropertyHandler</a> instance. Two ways are currently supported: <ul> <li>A sevice name:</br> If a sequence element contains a string, this string is interpreted as service name, and an ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiComponentFactory.html">XMultiComponentFactory</a> is asked to create an instance of this service.</li> <li>A factory:<br/> If a sequence element contains an instance implementing the ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XSingleComponentFactory.html">XSingleComponentFactory</a> interface, this factory is used to create a property handler.</li> </ul></p> <p>This attribute is usually only evaluated by the <a href="ObjectInspector.html">ObjectInspector</a> instance which the model is currently bound to.</p> <p>The order of factories is important: If two property handlers declare themself responsible for the same property, the one whose factory is listed <strong>last</strong> wins. Also, if a handler <code>B</code> wants to supersede a property of another handler <code>A</code>, <code>A</code>'s factory must precede the factory of <code>B</code>.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#getSupportedProperties">getSupportedProperties</a>, <a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#getSupersededProperties">getSupersededProperties</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HasHelpSection" class="membertitle">HasHelpSection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>HasHelpSection</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates that the object inspector should have a help section. </dd> <dd><p>The object inspector displays lines of property/values, optionally grouped into categories, as described by the property handlers.<br/> Additionally, the inspector can optionally display a section dedicated to help texts. Clients could use this section to display context-sensitive help, for instance short texts explaining the currently selected property.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.2</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MinHelpTextLines" class="membertitle">MinHelpTextLines</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>MinHelpTextLines</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the minimum number of lines of text to be reserved for the help section. </dd> <dd><p>This property is ignored by the <a href="ObjectInspector.html">ObjectInspector</a> if <a href="#HasHelpSection">HasHelpSection</a> is <b>false</b>.</p> <p>The layout of the <a href="ObjectInspector.html">ObjectInspector</a> is undefined if <a href="#MinHelpTextLines">MinHelpTextLines</a> is larger than <a href="#MaxHelpTextLines">MaxHelpTextLines</a>.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.2</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MaxHelpTextLines" class="membertitle">MaxHelpTextLines</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>MaxHelpTextLines</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the maximum number of lines of text to be reserved for the help section. </dd> <dd><p>This property is ignored by the <a href="ObjectInspector.html">ObjectInspector</a> if <a href="#HasHelpSection">HasHelpSection</a> is <b>false</b>.</p> <p>The layout of the <a href="ObjectInspector.html">ObjectInspector</a> is undefined if <a href="#MaxHelpTextLines">MaxHelpTextLines</a> is smaller than <a href="#MinHelpTextLines">MinHelpTextLines</a>.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.2</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsReadOnly" class="membertitle">IsReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>IsReadOnly</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the object inspector's UI should be read-only. </dd> <dd><p>In this case, the user is able to browse through all properties, but cannot change any of them.</p> <p>In a read-only object inspector, the property controls are readonly or disabled themself, and the primary and secondary buttons of a property line are both disabled.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XPropertyControl.html">XPropertyControl</a>, <a href="LineDescriptor.html">LineDescriptor</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
3909
