<html> <head> <title>Service HierarchyAccess</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="HierarchyAccess-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"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub">Properties' Summary</td> <td class="navisub">Properties' 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">configuration</a> :: </p> </td> </tr> <tr> <td class="title">service HierarchyAccess</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to a hierarchy of descendant elements. </dd> <dd><p>Subnodes are accessed by their name. Values that are direct or indirect descendants of this tree node can be retrieved. Non-value subnodes can be navigated using container interfaces. Other interfaces provide access to information about this node. Changes to values in the subtree can be monitored by event listeners. </p> <p>Elements of this container that are not simple values are similar containers themselves, thus (recursively) forming a hierarchical tree. </p> <p>Implementations of this service usually also implement service <a href="HierarchyElement.html">HierarchyElement</a>, which concerns the complementary role of being accessible as an element of the hierarchy. </p> </dd> </dl> </td> </tr> </table> <hr> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows access to immediate children of this node. </dd> <dd><p>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a>::<a href="../container/XNameAccess.html#getByName">getByName()</a> returns an <code>any</code> holding either a simple value or an interface on another HierarchyAccess if the child is not a simple value. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XHierarchicalNameAccess.html">XHierarchicalNameAccess</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows access to all descendants of this node </dd> <dd><p>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XHierarchicalNameAccess.html">XHierarchicalNameAccess</a>::<a href="../container/XHierarchicalNameAccess.html#getByHierarchicalName">getByHierarchicalName()</a> returns an <code>any</code> holding either a simple value or an interface on another HierarchyAccess if the descendant is not a simple value. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XContainer.html">XContainer</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows attaching listeners to this node to monitor changes to immediate child nodes. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XExactName.html">XExactName</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides support for inexact names. </dd> <dd><p>Exact names can be obtained for simple or hierarchical names for use in ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a>, ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XHierarchicalNameAccess.html">XHierarchicalNameAccess</a>, ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a> or any other interfaces that allow access to or manipulation of subnodes selected by name or hierarchical name. </p> <p>If an inexact name could be matched to either a simple or a hierachical name, the simple (immediate child) name is preferred. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySetInfo.html">XPropertySetInfo</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>provides information about immediate children of this node. [optional] </dd> <dd><p>This interface may be missing, if the hierarchy supports no traits that are described by ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyAttribute.html">PropertyAttribute</a> values or if the same information is available by other means, e.g. if the implementation supports ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a>::<a href="../beans/XPropertySet.html#getPropertySetInfo">getPropertySetInfo()</a>. </p> <p>If a child of this node is an object that implements ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XProperty.html">XProperty</a>, then this implementation returns the same ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/Property.html">Property</a> for that child as the child itself. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertyState.html">XPropertyState</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>provides access to the state of child elements of an implementation. [optional] </dd> <dd><p>This interface may be missing if the hierarchy (or a hierarchy fragment that contains this implementation as element) does not support default values or if the node does not support accessing the default state of individual children. </p> <p>If elements that are not simple values, but objects themselves, support a default state (as indicated by <b>PropertyAttribute::MAYBEDEFAULT</b>), they should implement ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertyWithState.html">XPropertyWithState</a>, in which case the ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyState.html">PropertyState</a> applies to all their children and recursively to all descendants. </p> <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, attempts to change property states will fail. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XMultiPropertyStates.html">XMultiPropertyStates</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>provides access to the states of multiple child elements of an implementation. [optional] </dd> <dd><p>This interface may be missing if the hierarchy (or a hierarchy fragment that contains this implementation as element) does not support default values if the node does not support accessing the default state of individual children. </p> <p>If elements that are not simple values, but objects themselves, support a default state (as indicated by <b>PropertyAttribute::MAYBEDEFAULT</b>), they should implement ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertyWithState.html">XPropertyWithState</a>, in which case the ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyState.html">PropertyState</a> applies to all their children and recursively to all descendants. </p> <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, attempts to change property states will fail. </p> </dd> </dl> </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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
1926
