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