<html> <head> <title>Service ItemDescriptor</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="ItemDescriptor-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">Included Services</td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' 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">ui</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">service ItemDescriptor</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>describes a user interface item that is part of a user interface element. </dd> <dd><p>Common examples for such elements are: <ul> <li>menus</li> <li>tool bars</li> <li>status bars</li> </ul> No assumption is made about any graphical representation: You could have a menu or a toolbox working with the same item descriptor. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</dd> </dl> </td> </tr> </table> <hr> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Type">Type</a></td> <td class="imsum_right">specifies which type this item descriptor belongs to. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Label">Label</a></td> <td class="imsum_right">the text of the user interface item. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#CommandURL">CommandURL</a></td> <td class="imsum_right">contains the command URL which specifies which action should be accomplished. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HelpURL">HelpURL</a></td> <td class="imsum_right">contains the a URL that points to a help text. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Style">Style</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>different styles which influence the appearance of the item and its behavior. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Offset">Offset</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the pixel distance by which the text of the item is shifted on the x-axis. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a><br> <a href="#ItemDescriptorContainer">ItemDescriptorContainer</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies an optional sub container. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsVisible">IsVisible</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if this item is visible or not. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Width">Width</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies a pixel width for this item inside the user interface element. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="Type" class="membertitle">Type</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Type</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies which type this item descriptor belongs to.</dd> <dd><p>See constant definition <a href="ItemType.html">ItemType</a>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Label" class="membertitle">Label</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Label</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>the text of the user interface item. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CommandURL" class="membertitle">CommandURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>CommandURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the command URL which specifies which action should be accomplished. </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>contains the a URL that points to a help text. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Style" class="membertitle">Style</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Style</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>different styles which influence the appearance of the item and its behavior. </dd> <dd><p>This property is only valid if the item describes a toolbar or statusbar item. See <a href="ItemStyle.html">ItemStyle</a> for more information about possible styles.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Offset" class="membertitle">Offset</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Offset</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the pixel distance by which the text of the item is shifted on the x-axis. </dd> <dd><p>This property is only valid if the item describes a statusbar item.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ItemDescriptorContainer" class="membertitle">ItemDescriptorContainer</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="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a> <b>ItemDescriptorContainer</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies an optional sub container. </dd> <dd><p>This property is valid for menus only. It can be used to define sub menus.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsVisible" class="membertitle">IsVisible</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsVisible</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if this item is visible or not. </dd> <dd><p>This property is only valid if the item describes a toolbar or statusbar item.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Width" class="membertitle">Width</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Width</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies a pixel width for this item inside the user interface element. </dd> <dd><p>This property is only valid if the item describes a toolbar or statusbar item.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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>