offapi/com/sun/star/configuration/PropertyHierarchy.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PropertyHierarchy.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_configuration_PropertyHierarchy_idl__
  31 #define __com_sun_star_configuration_PropertyHierarchy_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XMultiPropertySet_idl__
  38 #include <com/sun/star/beans/XMultiPropertySet.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XHierarchicalPropertySet_idl__
  42 #include <com/sun/star/beans/XHierarchicalPropertySet.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_XMultiHierarchicalPropertySet_idl__
  46 #include <com/sun/star/beans/XMultiHierarchicalPropertySet.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module configuration {
  52
  53 //=============================================================================
  54 /** provides access to and information about properties and subproperties
  55  of an implementation.
  56
  57  <p>Properties in a property set may be full-fledged objects that have
  58  properties themselves (and so on recursively), thereby forming a hierarchy
  59  of properties. This service describes such a hierarchy, and allows
  60  direct access even to subproperties.
  61  </p>
  62
  63  @see com::sun::star::beans::XProperty
  64  Properties of an implementation that are objects themselves will often
  65  implement <type scope="com::sun::star::beans">XProperty</type> to allow
  66  direct access to information about the object.
  67  If such objects have properties of their own, they should fully implement
  68  <type>PropertyHierarchy</type> again.
  69 */
  70 published service PropertyHierarchy
  71 {
  72 /** provides access to and information about the immediate properties of an implementation.
  73 */
  74     interface com::sun::star::beans::XPropertySet;
  75
  76 /** provides access to and information about the immediate properties
  77  of an implementation.
  78
  79  <p>This interface allows retrieving or setting multiple properties at once.
  80  Accesses are guaranteed to occur as single atomic operations even if
  81  multiple threads are accessing the object simultaneously.
  82  </p>
  83 */
  84     interface com::sun::star::beans::XMultiPropertySet;
  85
  86 /** provides access to and information about the whole hierarchy
  87  of properties and subproperties of an implementation.
  88 */
  89     interface com::sun::star::beans::XHierarchicalPropertySet;
  90
  91 /** provides access to and information about the whole hierarchy
  92  of properties and subproperties of an implementation.
  93
  94  <p>This interface allows retrieving or setting multiple properties at once.
  95  Accesses are guaranteed to occur as single atomic operations even if
  96  multiple threads are accessing the object simultaneously.
  97  </p>
  98 */
  99     interface com::sun::star::beans::XMultiHierarchicalPropertySet;
 100
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 #endif