udkapi/com/sun/star/beans/XMultiPropertyStates.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 /** makes it possible to query information about the state of
  25     one or more properties.
  26
  27     <p>The state of a property contains information about the source of
  28     the value, e.g. the object itself, a default or a stylesheet.
  29     For more information see PropertyState.
  30 */
  31 published interface XMultiPropertyStates: com::sun::star::uno::XInterface
  32 {
  33     /** @returns
  34             a sequence of the states of the properties which are specified
  35             by their names.
  36
  37         <p>The order of the states is correlating to the order of the
  38         given property names.
  39
  40         @param aPropertyName
  41             specifies the names of the properties. All names must be unique.
  42             This sequence must be alphabetically sorted.
  43     */
  44     sequence<com::sun::star::beans::PropertyState> getPropertyStates(
  45             [in] sequence<string> aPropertyName )
  46         raises( com::sun::star::beans::UnknownPropertyException );
  47
  48     /** sets all properties to their default values.
  49
  50         <p>Each value depends on the implementation of this interface.
  51         If it is a bound property, you must change the value before
  52         the change events are fired.  If it is a constrained property, you
  53         must fire the vetoable event before you change the property value.
  54         </p>
  55     */
  56     void setAllPropertiesToDefault();
  57
  58     /** sets the specified properties to their default values.
  59
  60         <p>Each value depends on the implementation of this interface.
  61         If it is a bound property, you must change the value before
  62         the change events are fired.  If it is a constrained property, you
  63         must fire the vetoable event before you change the property value. </p>
  64
  65         @param aPropertyNames
  66             specifies the names of the properties. All names must be unique.
  67             This sequence must be alphabetically sorted.
  68
  69         @throws UnknownPropertyException
  70             if one of the properties does not exist.
  71     */
  72     void setPropertiesToDefault( [in] sequence<string> aPropertyNames )
  73             raises( com::sun::star::beans::UnknownPropertyException );
  74
  75     /** @returns
  76             the default values of the properties with the specified names.
  77
  78         <p>If no default exists, is not known, or is void,
  79         then the return type at the corresponding position in the
  80         sequence returned is `void`. </p>
  81
  82         @param aPropertyNames
  83             specifies the names of the properties. All names must be unique.
  84             This sequence must be alphabetically sorted.
  85
  86         @throws UnknownPropertyException
  87             if one of the properties does not exist.
  88
  89         @throws  com::sun::star::lang::WrappedTargetException
  90             if the implementation has an internal reason for the exception.
  91             In this case the original exception is wrapped into that
  92             com::sun::star::lang::WrappedTargetException.
  93     */
  94     sequence<any> getPropertyDefaults(
  95                 [in] sequence<string> aPropertyNames )
  96             raises( com::sun::star::beans::UnknownPropertyException,
  97                     com::sun::star::lang::WrappedTargetException );
  98 };
  99
 100
 101 }; }; }; };
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */