<html>
<head>
<title>Struct LineDescriptor</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="LineDescriptor-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="#Elements" class="navisub">Elements' Summary</a></td>
<td class="navisub"><a href="#ElementDetails" class="navisub">Elements' 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">struct LineDescriptor</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>describes the appearance of a line representing a single property in an <a href="ObjectInspector.html">ObjectInspector</a>.
Such a line consists of
</dd>
<dd><ul><li>a label with a human-readable name for the property</li>
<li>a control which is used for user interaction - i.e. it displays the current property
value, and allows the user entering a new one.</li>
<li>(optional) one or two buttons which, when clicked, can start a more complex, interactive
property value input. For instance, if you have a property whose value is a path in the
file system, such a button could be used to let the user browse for a path with a
usual file picker.</li>
</ul>
</dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0.3</dd>
<dt><b>See also</b></dt>
<dd><a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#describePropertyLine">describePropertyLine</a>, <a href="PropertyLineElement.html">PropertyLineElement</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="Elements"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Elements' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#DisplayName">DisplayName</a></td>
<td class="imsum_right">denotes the human-readable display name used to present a property to the user
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#Control">Control</a></td>
<td class="imsum_right">denotes the control which should be used to represent the property at the UI.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#HelpURL">HelpURL</a></td>
<td class="imsum_right">specifies the URL to the help topic to be associated with the property
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#HasPrimaryButton">HasPrimaryButton</a></td>
<td class="imsum_right">detetrmines whether a button exists which can be used for a more complex, interactive
property value input.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#PrimaryButtonId">PrimaryButtonId</a></td>
<td class="imsum_right">describes a unique id to associate with the primary button
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#PrimaryButtonImageURL">PrimaryButtonImageURL</a></td>
<td class="imsum_right">describes the URL of an image to display on the primary button, if any.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#PrimaryButtonImage">PrimaryButtonImage</a></td>
<td class="imsum_right">describes a graphics to display at the primary button, if any.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#HasSecondaryButton">HasSecondaryButton</a></td>
<td class="imsum_right">detetrmines whether a secondary button exists which can be used for a more complex, interactive
property value input.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#SecondaryButtonId">SecondaryButtonId</a></td>
<td class="imsum_right">describes a unique id to associate with the primary button
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#SecondaryButtonImageURL">SecondaryButtonImageURL</a></td>
<td class="imsum_right">describes the URL of an image to display on the secondary button, if any.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#SecondaryButtonImage">SecondaryButtonImage</a></td>
<td class="imsum_right">describes a graphics to display at the secondary button, if any.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#IndentLevel">IndentLevel</a></td>
<td class="imsum_right">describes the indent level for the property
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#Category">Category</a></td>
<td class="imsum_right">describes the category into which the property should be sorted by the <a href="ObjectInspector.html">ObjectInspector</a>.
</td>
</tr>
</table>
<a name="ElementDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Elements' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="DisplayName" class="membertitle">DisplayName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>DisplayName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>denotes the human-readable display name used to present a property to the user
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Control" class="membertitle">Control</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="XPropertyControl.html">XPropertyControl</a> <b>Control</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>denotes the control which should be used to represent the property at the UI.
</dd>
<dt><b>See also</b></dt>
<dd><a href="XPropertyControlFactory.html">XPropertyControlFactory</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="HelpURL" class="membertitle">HelpURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>HelpURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the URL to the help topic to be associated with the property
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="HasPrimaryButton" class="membertitle">HasPrimaryButton</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>HasPrimaryButton</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>detetrmines whether a button exists which can be used for a more complex, interactive
property value input.
</dd>
<dd><p>If no image for the primary button is specified, but a primary button is present,
the three dots will be displayed on the button.</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#onInteractivePropertySelection">onInteractivePropertySelection</a>, <a href="#HasSecondaryButton">HasSecondaryButton</a>, <a href="#PrimaryButtonImageURL">PrimaryButtonImageURL</a>, <a href="#PrimaryButtonImage">PrimaryButtonImage</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="PrimaryButtonId" class="membertitle">PrimaryButtonId</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>PrimaryButtonId</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes a unique id to associate with the primary button
</dd>
<dd><p>In OpenOffice.org, UI elements sometimes require a so-called UniqueID, which can be
used to uniquely (within the whole application) identify this UI element. For instance,
automating the OpenOffice.org UI via a dedicated separate application ("TestTool") requires
such IDs.</p>
<p>If a primary button exists for a property's UI representation (<a href="#HasPrimaryButton">HasPrimaryButton</a>),
it gets the ID specified herein.</p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="PrimaryButtonImageURL" class="membertitle">PrimaryButtonImageURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>PrimaryButtonImageURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes the URL of an image to display on the primary button, if any.
</dd>
<dd><p>This URL will be used to obtain an actual ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a>
object from an ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/GraphicProvider.html">GraphicProvider</a>.</p>
<p>The property will be ignored if <a href="#HasPrimaryButton">HasPrimaryButton</a> is <b>false</b>.</p>
<p>If you need to specify a graphic which does not have an URL, but is available as
::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> only, then you must leave
<code>PrimaryButtonImageURL</code> empty, and use the <a href="#PrimaryButtonImage">PrimaryButtonImage</a> property.
</dd>
<dt><b>See also</b></dt>
<dd><a href="#PrimaryButtonImage">PrimaryButtonImage</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="PrimaryButtonImage" class="membertitle">PrimaryButtonImage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> <b>PrimaryButtonImage</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes a graphics to display at the primary button, if any.
</dd>
<dd><p>The property will be ignored if <a href="#HasPrimaryButton">HasPrimaryButton</a> is <b>false</b>, or
if <a href="#PrimaryButtonImageURL">PrimaryButtonImageURL</a> is a non-empty string.</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="#HasPrimaryButton">HasPrimaryButton</a>, <a href="#PrimaryButtonImageURL">PrimaryButtonImageURL</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="HasSecondaryButton" class="membertitle">HasSecondaryButton</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>HasSecondaryButton</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>detetrmines whether a secondary button exists which can be used for a more complex, interactive
property value input.
</dd>
<dd><p>A secondary button subordinated to the primary button. If no primary button exists
(<a href="#HasPrimaryButton">HasPrimaryButton</a>), this member is ignored.</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="XPropertyHandler.html">XPropertyHandler</a>::<a href="XPropertyHandler.html#onInteractivePropertySelection">onInteractivePropertySelection</a>, <a href="#HasSecondaryButton">HasSecondaryButton</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SecondaryButtonId" class="membertitle">SecondaryButtonId</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>SecondaryButtonId</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes a unique id to associate with the primary button
</dd>
<dd><p>If a secondary button exists for a property's UI representation (<a href="#HasSecondaryButton">HasSecondaryButton</a>),
it gets the ID specified herein.</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="#PrimaryButtonId">PrimaryButtonId</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SecondaryButtonImageURL" class="membertitle">SecondaryButtonImageURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>SecondaryButtonImageURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes the URL of an image to display on the secondary button, if any.
</dd>
<dd><p>This URL will be used to obtain an actual ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a>
object from an ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/GraphicProvider.html">GraphicProvider</a>.</p>
<p>The property will be ignored if <a href="#HasSecondaryButton">HasSecondaryButton</a> is <b>false</b>.</p>
<p>If you need to specify a graphic which does not have an URL, but is available as
::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> only, then you must leave
<code>SecondaryButtonImageURL</code> empty, and use the <a href="#SecondaryButtonImage">SecondaryButtonImage</a> property.
</dd>
<dt><b>See also</b></dt>
<dd><a href="#SecondaryButtonImage">SecondaryButtonImage</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SecondaryButtonImage" class="membertitle">SecondaryButtonImage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> <b>SecondaryButtonImage</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes a graphics to display at the secondary button, if any.
</dd>
<dd><p>The property will be ignored if <a href="#HasSecondaryButton">HasSecondaryButton</a> is <b>false</b>, or
if <a href="#SecondaryButtonImageURL">SecondaryButtonImageURL</a> is a non-empty string.</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="#HasSecondaryButton">HasSecondaryButton</a>, <a href="#SecondaryButtonImageURL">SecondaryButtonImageURL</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="IndentLevel" class="membertitle">IndentLevel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>IndentLevel</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes the indent level for the property
</dd>
<dd><p>If a given property semantically depends on another one, the indent level
can be used to visually represent this fact. For this, the dependent property's
indent level would be one larger than the indent level of the other property.</p>
<p>Normally, <a href="XPropertyHandler.html">XPropertyHandler</a>s will set this to <code>0</code> when describing
the UI for a normal property.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Category" class="membertitle">Category</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>Category</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes the category into which the property should be sorted by the <a href="ObjectInspector.html">ObjectInspector</a>.
</dd>
<dd><p>An <a href="ObjectInspector.html">ObjectInspector</a> can visually group properties which semantically belong
together (for instance using tab pages). The decision which properties actually belong together
is made using this <a href="#Category">Category</a> attribute.</p>
<p>For your implementation of <a href="XPropertyHandler.html">XPropertyHandler</a>, it's recommended that you document the programmatic
names used for property categories. This way, your handler might be re-used in
different contexts, where only the <a href="XObjectInspectorModel.html">XObjectInspectorModel</a> needs to provide consistent
UI names for the categories.</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="XObjectInspectorModel.html">XObjectInspectorModel</a>::<a href="XObjectInspectorModel.html#describeCategories">describeCategories</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 © 2008 Sun Microsystems, Inc.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
3816
