udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.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_XMultiHierarchicalPropertySet_idl__
  20 #define __com_sun_star_beans_XMultiHierarchicalPropertySet_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/PropertyVetoException.idl>
  27
  28 #include <com/sun/star/lang/IllegalArgumentException.idl>
  29
  30 #include <com/sun/star/lang/WrappedTargetException.idl>
  31
  32
  33 module com {  module sun {  module star {  module beans {
  34
  35
  36 /** provides access to multiple properties which form a hierarchy.
  37
  38     @see XHierarchicalPropertySet
  39  */
  40 published interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterface
  41 {
  42
  43     /** retrieve information about the hierarchy of properties
  44
  45         @returns
  46                 the XHierarchicalPropertySetInfo interface,
  47                 which describes the property hierarchy of the object which
  48                 supplies this interface.
  49
  50         @returns
  51                 `NULL` if the implementation cannot or will
  52                 not provide information about the properties; otherwise the
  53                 interface XHierarchicalPropertySetInfo is returned.
  54
  55         @see XHierarchicalPropertySet::getHierarchicalPropertySetInfo
  56      */
  57     com::sun::star::beans::XHierarchicalPropertySetInfo getHierarchicalPropertySetInfo();
  58
  59
  60     /** sets the values of the properties with the specified nested names.
  61
  62         <p> The values of the properties must change before bound
  63             events are fired. The values of constrained properties
  64             should change after the vetoable events are fired, if no
  65             exception occurs.  </p>
  66
  67         <p> Unknown properties are ignored.  </p>
  68
  69         @param  aHierarchicalPropertyNames
  70                 This parameter specifies the names of the properties.
  71
  72         @param  Values
  73                 This parameter specifies the new values for the properties.
  74
  75         @throws PropertyVetoException
  76                 if one of the properties is constrained and the change is
  77                 vetoed by a XVetoableChangeListener.
  78
  79         @throws com::sun::star::lang::IllegalArgumentException
  80                 if one of the values is not a legal value for the
  81                 corresponding property or if one of the names
  82                 is not a well-formed nested name for this hierarchy.
  83                 An implementation is not required to detect the latter
  84                 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 XHierarchicalPropertySet::setHierarchicalPropertyValue
  92         @see XMultiPropertySet::setPropertyValues
  93      */
  94
  95
  96     void setHierarchicalPropertyValues( [in] sequence<string> aHierarchicalPropertyNames,
  97              [in] sequence<any> Values )
  98             raises( com::sun::star::beans::PropertyVetoException,
  99                     com::sun::star::lang::IllegalArgumentException,
 100                     com::sun::star::lang::WrappedTargetException );
 101
 102
 103     /** @returns
 104             a sequence of all values of the properties which are specified
 105             by their nested names.
 106
 107         <p> The order of the values in the returned sequence will be the same
 108             as the order of the names in the argument.  </p>
 109
 110         <p> Unknown properties are ignored, in their place `NULL` will be returned.  </p>
 111
 112         @throws com::sun::star::lang::IllegalArgumentException
 113                 if one of the names is not a well-formed
 114                 nested name for this hierarchy.
 115                 An implementation is not required to detect this
 116                 condition.
 117
 118         @throws com::sun::star::lang::WrappedTargetException
 119                 if the implementation has an internal reason for the exception.
 120                 In this case the original exception is wrapped into that
 121                 com::sun::star::lang::WrappedTargetException.
 122
 123         @see XHierarchicalPropertySet::getHierarchicalPropertyValue
 124         @see XMultiPropertySet::setPropertyValues
 125      */
 126     sequence<any> getHierarchicalPropertyValues( [in] sequence<string> aPropertyNames )
 127             raises( com::sun::star::lang::IllegalArgumentException ,
 128                     com::sun::star::lang::WrappedTargetException );
 129
 130
 131 };
 132
 133
 134 }; }; }; };
 135
 136 #endif
 137
 138 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */