<html> <head> <title>Interface XHierarchicalPropertySet</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="XHierarchicalPropertySet-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' 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">beans</a> :: </p> </td> </tr> <tr> <td class="title">interface XHierarchicalPropertySet</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides information about and access to the a hierarchy of properties from an implementation. </dd> <dd><p> Usually an object that implements this interface also implements <a href="XPropertySet.html">XPropertySet</a> and at least some of the properties have subproperties. </p> <p> This interface allows direct access to subsubproperties, ... up to an arbitrary nesting depth. Often the intermediate elements of the hierarchy implement <a href="XProperty.html">XProperty</a>. </p> <p> Each implementation specifies how the hierarchical property names, that are used to access the elements of the hierarchy, are formed. </p> <p> Commonly a notation similar to filesystem pathes (separated by '/' slashes) or nested module names (separated by dots '.' or '::') is used. </p> </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="#getHierarchicalPropertySetInfo">getHierarchicalPropertySetInfo</a></td> <td class="imsum_right">retrieve information about the hierarchy of properties </td> </tr> <tr> <td class="imsum_left"><a href="#setHierarchicalPropertyValue">setHierarchicalPropertyValue</a></td> <td class="imsum_right">sets the value of the property with the specified nested name. </td> </tr> <tr> <td class="imsum_left"><a href="#getHierarchicalPropertyValue">getHierarchicalPropertyValue</a></td> <td class="imsum_right"> </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="getHierarchicalPropertySetInfo" class="membertitle">getHierarchicalPropertySetInfo</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"><a href="XHierarchicalPropertySetInfo.html">XHierarchicalPropertySetInfo</a></td> </tr> <tr> <td valign="top"><b>getHierarchicalPropertySetInfo</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieve information about the hierarchy of properties </dd> <dt><b>Returns</b></dt> <dd>the <a href="XHierarchicalPropertySetInfo.html">XHierarchicalPropertySetInfo</a> interface, which describes the property hierarchy of the object which supplies this interface. </dd> <dt><b>Returns</b></dt> <dd><b>NULL</b> if the implementation cannot or will not provide information about the properties; otherwise the interface <a href="XHierarchicalPropertySetInfo.html">XHierarchicalPropertySetInfo</a> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setHierarchicalPropertyValue" class="membertitle">setHierarchicalPropertyValue</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">void</td> </tr> <tr> <td valign="top"><b>setHierarchicalPropertyValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aHierarchicalPropertyName,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> aValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br> <a href="PropertyVetoException.html">PropertyVetoException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the value of the property with the specified nested name. </dd> <dt><b>Parameter aHierarchicalPropertyName</b></dt> <dd>This parameter specifies the name of the property. </dd> <dt><b>Parameter aValue</b></dt> <dd>This parameter specifies the new value for the property. </dd> <dt><b>Throws</b></dt> <dd>UnknownPropertyException if the property does not exist. </dd> <dt><b>Throws</b></dt> <dd>PropertyVetoException if the property is constrained and the change is vetoed by a <a href="XVetoableChangeListener.html">XVetoableChangeListener</a>. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::lang::IllegalArgumentException if <var>aValue</var> is not a legal value for this property or if <var>aHierarchicalPropertyName</var> is not a well-formed nested name for this hierarchy. An implementation is not required to detect the latter condition. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if the implementation has an internal reason for the exception. In this case the original exception is wrapped into that ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>. </dd> <dt><b>See also</b></dt> <dd><a href="XPropertySet.html">XPropertySet</a>::<a href="XPropertySet.html#setPropertyValue">setPropertyValue</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHierarchicalPropertyValue" class="membertitle">getHierarchicalPropertyValue</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">any</td> </tr> <tr> <td valign="top"><b>getHierarchicalPropertyValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aHierarchicalPropertyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the value of the property with the specified nested name. </dd> <dt><b>Parameter aHierarchicalPropertyName</b></dt> <dd>This parameter specifies the name of the property. </dd> <dt><b>Throws</b></dt> <dd>UnknownPropertyException if the property does not exist. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::lang::IllegalArgumentException if <var>aHierarchicalPropertyName</var> is not a well-formed nested name for this hierarchy. An implementation is not required to detect this condition. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if the implementation has an internal reason for the exception. In this case the original exception is wrapped into that ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>. </dd> <dt><b>See also</b></dt> <dd><a href="XPropertySet.html">XPropertySet</a>::<a href="XPropertySet.html#getPropertyValue">getPropertyValue</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
>
1404
