udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module beans {
  23
  24
  25 /** provides information about and access to the
  26     a hierarchy of properties from an implementation.
  27
  28     <p> Usually an object that implements this interface
  29         also implements XPropertySet and at
  30         least some of the properties have subproperties.  </p>
  31
  32     <p> This interface allows direct access to subsubproperties, ...
  33         up to an arbitrary nesting depth. Often the intermediate
  34         elements of the hierarchy implement XProperty.  </p>
  35
  36     <p> Each implementation specifies how the
  37         hierarchical property names, that are
  38         used to access the elements of the hierarchy,
  39         are formed.  </p>
  40
  41     <p> Commonly a notation similar to filesystem paths
  42         (separated by '/' slashes) or nested module names
  43         (separated by dots '.' or '::') is used.  </p>
  44
  45  */
  46 published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
  47 {
  48
  49     /** retrieve information about the hierarchy of properties
  50
  51         @returns
  52                 the XHierarchicalPropertySetInfo interface,
  53                 which describes the property hierarchy of the object which
  54                 supplies this interface.
  55
  56         @returns
  57                 `NULL` if the implementation cannot or will
  58                 not provide information about the properties; otherwise the
  59                 interface XHierarchicalPropertySetInfo is returned.
  60      */
  61     com::sun::star::beans::XHierarchicalPropertySetInfo
  62                 getHierarchicalPropertySetInfo();
  63
  64
  65     /** sets the value of the property with the specified nested name.
  66
  67         @param  aHierarchicalPropertyName
  68                 This parameter specifies the name of the property.
  69
  70         @param  aValue
  71                 This parameter specifies the new value for the property.
  72
  73         @throws UnknownPropertyException
  74                 if the property does not exist.
  75
  76         @throws PropertyVetoException
  77                 if the property is constrained and the change is vetoed by a
  78                 XVetoableChangeListener.
  79
  80         @throws com::sun::star::uno::lang::IllegalArgumentException
  81                 if <var>aValue</var> is not a legal value for this property or
  82                 if <var>aHierarchicalPropertyName</var> is not a well-formed
  83                 nested name for this hierarchy.
  84                 An implementation is not required to detect the latter condition.
  85
  86         @throws com::sun::star::lang::WrappedTargetException
  87                 if the implementation has an internal reason for the exception.
  88                 In this case the original exception is wrapped into that
  89                 com::sun::star::lang::WrappedTargetException.
  90
  91         @see XPropertySet::setPropertyValue
  92      */
  93     void setHierarchicalPropertyValue( [in] string aHierarchicalPropertyName,
  94              [in] any aValue )
  95             raises( com::sun::star::beans::UnknownPropertyException,
  96                     com::sun::star::beans::PropertyVetoException,
  97                     com::sun::star::lang::IllegalArgumentException,
  98                     com::sun::star::lang::WrappedTargetException );
  99
 100
 101     /** @returns
 102                 the value of the property with the specified nested name.
 103
 104         @param  aHierarchicalPropertyName
 105                 This parameter specifies the name of the property.
 106
 107         @throws UnknownPropertyException
 108                 if the property does not exist.
 109
 110         @throws com::sun::star::uno::lang::IllegalArgumentException
 111                 if <var>aHierarchicalPropertyName</var> is not a well-formed
 112                 nested name for this hierarchy.
 113                    An implementation is not required to detect this
 114                 condition.
 115
 116         @throws com::sun::star::lang::WrappedTargetException
 117                 if the implementation has an internal reason for the exception.
 118                 In this case the original exception is wrapped into that
 119                 com::sun::star::lang::WrappedTargetException.
 120
 121         @see XPropertySet::getPropertyValue
 122      */
 123     any getHierarchicalPropertyValue( [in] string aHierarchicalPropertyName )
 124             raises( com::sun::star::beans::UnknownPropertyException,
 125                     com::sun::star::lang::IllegalArgumentException,
 126                     com::sun::star::lang::WrappedTargetException );
 127
 128
 129 };
 130
 131
 132 }; }; }; };
 133
 134 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */