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 #ifndef __com_sun_star_beans_XHierarchicalPropertySet_idl__
  20 #define __com_sun_star_beans_XHierarchicalPropertySet_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/XHierarchicalPropertySetInfo.idl>
  25
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27
  28 #include <com/sun/star/beans/PropertyVetoException.idl>
  29
  30 #include <com/sun/star/lang/IllegalArgumentException.idl>
  31
  32 #include <com/sun/star/lang/WrappedTargetException.idl>
  33
  34
  35
  36 module com {  module sun {  module star {  module beans {
  37
  38
  39 /** provides information about and access to the
  40     a hierarchy of properties from an implementation.
  41
  42     <p> Usually an object that implements this interface
  43         also implements XPropertySet and at
  44         least some of the properties have subproperties.  </p>
  45
  46     <p> This interface allows direct access to subsubproperties, ...
  47         up to an arbitrary nesting depth. Often the intermediate
  48         elements of the hierarchy implement XProperty.  </p>
  49
  50     <p> Each implementation specifies how the
  51         hierarchical property names, that are
  52         used to access the elements of the hierarchy,
  53         are formed.  </p>
  54
  55     <p> Commonly a notation similar to filesystem paths
  56         (separated by '/' slashes) or nested module names
  57         (separated by dots '.' or '::') is used.  </p>
  58
  59  */
  60 published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
  61 {
  62
  63     /** retrieve information about the hierarchy of properties
  64
  65         @returns
  66                 the XHierarchicalPropertySetInfo interface,
  67                 which describes the property hierarchy of the object which
  68                 supplies this interface.
  69
  70         @returns
  71                 `NULL` if the implementation cannot or will
  72                 not provide information about the properties; otherwise the
  73                 interface XHierarchicalPropertySetInfo is returned.
  74      */
  75     com::sun::star::beans::XHierarchicalPropertySetInfo
  76                 getHierarchicalPropertySetInfo();
  77
  78
  79     /** sets the value of the property with the specified nested name.
  80
  81         @param  aHierarchicalPropertyName
  82                 This parameter specifies the name of the property.
  83
  84         @param  aValue
  85                 This parameter specifies the new value for the property.
  86
  87         @throws UnknownPropertyException
  88                 if the property does not exist.
  89
  90         @throws PropertyVetoException
  91                 if the property is constrained and the change is vetoed by a
  92                 XVetoableChangeListener.
  93
  94         @throws com::sun::star::uno::lang::IllegalArgumentException
  95                 if <var>aValue</var> is not a legal value for this property or
  96                 if <var>aHierarchicalPropertyName</var> is not a well-formed
  97                 nested name for this hierarchy.
  98                 An implementation is not required to detect the latter condition.
  99
 100         @throws com::sun::star::lang::WrappedTargetException
 101                 if the implementation has an internal reason for the exception.
 102                 In this case the original exception is wrapped into that
 103                 com::sun::star::lang::WrappedTargetException.
 104
 105         @see XPropertySet::setPropertyValue
 106      */
 107     void setHierarchicalPropertyValue( [in] string aHierarchicalPropertyName,
 108              [in] any aValue )
 109             raises( com::sun::star::beans::UnknownPropertyException,
 110                     com::sun::star::beans::PropertyVetoException,
 111                     com::sun::star::lang::IllegalArgumentException,
 112                     com::sun::star::lang::WrappedTargetException );
 113
 114
 115     /** @returns
 116                 the value of the property with the specified nested name.
 117
 118         @param  aHierarchicalPropertyName
 119                 This parameter specifies the name of the property.
 120
 121         @throws UnknownPropertyException
 122                 if the property does not exist.
 123
 124         @throws com::sun::star::uno::lang::IllegalArgumentException
 125                 if <var>aHierarchicalPropertyName</var> is not a well-formed
 126                 nested name for this hierarchy.
 127                    An implementation is not required to detect this
 128                 condition.
 129
 130         @throws com::sun::star::lang::WrappedTargetException
 131                 if the implementation has an internal reason for the exception.
 132                 In this case the original exception is wrapped into that
 133                 com::sun::star::lang::WrappedTargetException.
 134
 135         @see XPropertySet::getPropertyValue
 136      */
 137     any getHierarchicalPropertyValue( [in] string aHierarchicalPropertyName )
 138             raises( com::sun::star::beans::UnknownPropertyException,
 139                     com::sun::star::lang::IllegalArgumentException,
 140                     com::sun::star::lang::WrappedTargetException );
 141
 142
 143 };
 144
 145
 146 }; }; }; };
 147
 148 #endif
 149
 150 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */