offapi/com/sun/star/configuration/PropertyHierarchy.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_configuration_PropertyHierarchy_idl__
  20 #define __com_sun_star_configuration_PropertyHierarchy_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23 #include <com/sun/star/beans/XMultiPropertySet.idl>
  24 #include <com/sun/star/beans/XHierarchicalPropertySet.idl>
  25 #include <com/sun/star/beans/XMultiHierarchicalPropertySet.idl>
  26
  27
  28 module com { module sun { module star { module configuration {
  29
  30 /** provides access to and information about properties and subproperties
  31  of an implementation.
  32
  33  <p>Properties in a property set may be full-fledged objects that have
  34  properties themselves (and so on recursively), thereby forming a hierarchy
  35  of properties. This service describes such a hierarchy, and allows
  36  direct access even to subproperties.
  37  </p>
  38
  39  @see com::sun::star::beans::XProperty
  40  Properties of an implementation that are objects themselves will often
  41  implement <type scope="com::sun::star::beans">XProperty</type> to allow
  42  direct access to information about the object.
  43  If such objects have properties of their own, they should fully implement
  44  <type>PropertyHierarchy</type> again.
  45 */
  46 published service PropertyHierarchy
  47 {
  48 /** provides access to and information about the immediate properties of an implementation.
  49 */
  50     interface com::sun::star::beans::XPropertySet;
  51
  52 /** provides access to and information about the immediate properties
  53  of an implementation.
  54
  55  <p>This interface allows retrieving or setting multiple properties at once.
  56  Accesses are guaranteed to occur as single atomic operations even if
  57  multiple threads are accessing the object simultaneously.
  58  </p>
  59 */
  60     interface com::sun::star::beans::XMultiPropertySet;
  61
  62 /** provides access to and information about the whole hierarchy
  63  of properties and subproperties of an implementation.
  64 */
  65     interface com::sun::star::beans::XHierarchicalPropertySet;
  66
  67 /** provides access to and information about the whole hierarchy
  68  of properties and subproperties of an implementation.
  69
  70  <p>This interface allows retrieving or setting multiple properties at once.
  71  Accesses are guaranteed to occur as single atomic operations even if
  72  multiple threads are accessing the object simultaneously.
  73  </p>
  74 */
  75     interface com::sun::star::beans::XMultiHierarchicalPropertySet;
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */