<html>
<head>
<title>Service HierarchyDataReadAccess</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="HierarchyDataReadAccess-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">Services' Summary</td>
<td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td>
<td class="navisub">Properties' Summary</td>
<td class="navisub">Services' Details</td>
<td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></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">ucb</a> :: </p>
</td>
</tr>
<tr>
<td class="title">service HierarchyDataReadAccess</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides read access to a fragment of the hierarchy data.
</dd>
<dd><p>A hierarchy data source provides access to a tree of hierarchy data
nodes. Each hierarchy data node, except the root node, has a parent that
is a hierarchy data node too. A hierarchy data node has a name.
<p>Each hierarchy data node has three data members:
<ul>
<li>"Title", which is of type <code>string</code>. It contains a title
for the node. This value must not be empty.
<li>"TargetURL", which is of type <code>string</code></li> It may contain
any URL, which will be treated as the target of a hierarchy link.
<li>"Children", which is of type <a href="HierarchyDataReadAccess.html">HierarchyDataReadAccess</a> or
of type <a href="HierarchyDataReadWriteAccess.html">HierarchyDataReadWriteAccess</a></li>, depending on the
type of the node. This member provides access to the children of a node.
</ul>
</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Summary</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"><p>gives access to the data members of a hierarchy data node.
(<a href="#XNameAccess">details</a>)</p>
</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"><p>gives access to the data members of a hierarchy data node as well
as to any child nodes or to the data members of child nodes using a
hierarchical name.
(<a href="#XHierarchicalNameAccess">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XChangesNotifier.html">XChangesNotifier</a></td>
<td class="imsum_right"><p>allows registering listeners that observe the hierarchy data source.
(<a href="#XChangesNotifier">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td>
<td class="imsum_right"><p>allows controlling or observing the lifetime of the hierarchy data
access object.
</p>
</td>
</tr>
</table>
<a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XNameAccess" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>gives access to the data members of a hierarchy data node.
</dd>
<dd><p>Examples:
<ul>
<li><code>getByName( "Title" )</code> will return an <code>any</code>
containing a string containing the title of the node.
</li>
<li><code>getByName( "Children" )</code> will return an <code>any</code>
containing an implementation of service
<a href="HierarchyDataReadAccess.html">HierarchyDataReadAccess</a>, if it was called on a read-only
node. It will return an implementation of service
<a href="HierarchyDataReadWriteAccess.html">HierarchyDataReadWriteAccess</a> if it was called on a
writable node.
</li>
</ul>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XHierarchicalNameAccess" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XHierarchicalNameAccess.html">XHierarchicalNameAccess</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>gives access to the data members of a hierarchy data node as well
as to any child nodes or to the data members of child nodes using a
hierarchical name.
</dd>
<dd><p>A hierarchical name consists of segments that are separated by a
single slash ("/"). There is neither a leading nor a trailing slash
allowed.
<ul>
<li>
path = segment ( '/' segment )*
</li>
<li>
segment = '[' quoted-string ']'
</li>
<li>
quoted-string = "'" escaped-string "'"
</li>
<li>
escaped-string = escaped according to XML attribute naming conventions
</li>
</ul>
<p>Examples:
<ul>
<li>
<code>getByHierarchicalName( "Title" )</code> will return an
<code>any</code> containing a string containing the title of the node
itself.
</li>
<li>
<code>getByHierarchicalName( "Children/['subnode1']" )</code> will give
access to the child node named "subnode1" of the node. It will return
an <code>any</code> containing an implementation of service
<a href="HierarchyDataReadAccess.html">HierarchyDataReadAccess</a>, if it was called on a read-only
node. It will return an implementation of service
<a href="HierarchyDataReadWriteAccess.html">HierarchyDataReadWriteAccess</a> if it was called on a
writable node.
</li>
<li>
<code>getByHierarchicalName( "Children/['subnode2']/TargetURL" )</code>
will give direct access to the "TargetURL" data member of the child node
named "subnode2" of the node. It will return an <code>any</code>
containing a <code>string</code> containing the target URL of the node.
</li>
<li>
<code>getByHierarchicalName( "Children/['subnode3']/Children" )</code>
will give direct access to the "Children" data member of the child node
named "subnode3" of the node. It will return an <code>any</code>
containing an implementation of service
<a href="HierarchyDataReadAccess.html">HierarchyDataReadAccess</a>, if it was called on a read-only
node. It will return an implementation of service
<a href="HierarchyDataReadWriteAccess.html">HierarchyDataReadWriteAccess</a> if it was called on a
writable node.
</li>
</ul>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XChangesNotifier" class="membertitle">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XChangesNotifier.html">XChangesNotifier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>allows registering listeners that observe the hierarchy data source.
</dd>
<dd><p>A client can register an
::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XChangesListener.html">XChangesListener</a>, which will
receive notifications for any changes within the hierarchy (fragment)
this object represents.
<p>An implementation should collect as many changes as possible into a
single ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/ChangesEvent.html">ChangesEvent</a>.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XComponent" class="membertitle">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>allows controlling or observing the lifetime of the hierarchy data
access object.
</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 © 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>
