offapi/com/sun/star/configuration/HierarchyElement.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: HierarchyElement.idl,v $
  10  * $Revision: 1.8 $
  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_HierarchyElement_idl__
  31 #define __com_sun_star_configuration_HierarchyElement_idl__
  32
  33 #ifndef __com_sun_star_container_XNamed_idl__
  34 #include <com/sun/star/container/XNamed.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XHierarchicalName_idl__
  38 #include <com/sun/star/container/XHierarchicalName.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XProperty_idl__
  42 #include <com/sun/star/beans/XProperty.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_XPropertyWithState_idl__
  46 #include <com/sun/star/beans/XPropertyWithState.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_container_XChild_idl__
  50 #include <com/sun/star/container/XChild.idl>
  51 #endif
  52
  53 //=============================================================================
  54
  55 module com { module sun { module star { module configuration {
  56
  57 //=============================================================================
  58 /** provides information about an element within a hierarchy.
  59
  60  <p>The local name and the full hierarchical name can be retrieved.
  61  Attributes detailing the role of the element can be queried.
  62  The state of the element (regarding defaults) can be accessed.
  63  </p>
  64
  65  <p>Implementations of this service usually also implement
  66  service <type>HierarchyAccess</type>, which concerns the complementary role
  67  of providing access to subelements of the hierarchy.
  68  </p>
  69 */
  70 published service HierarchyElement
  71 {
  72 /** provides the complete hierarchical name of this element
  73  within the hierarchy tree.
  74 */
  75     interface com::sun::star::container::XHierarchicalName;
  76
  77 /** provides the local name of this element within its parent.
  78
  79  <p><em>Renaming an element is generally not supported.</em></p>
  80 */
  81     interface com::sun::star::container::XNamed;
  82
  83 /** provides a property descriptor for this element.[optional]
  84
  85  <p>This interface may be missing, if the hierarchy supports no traits that are
  86  described by <type scope="com::sun::star::beans">PropertyAttribute</type>
  87  values.
  88  </p>
  89
  90  <p>If the parent of this object implements
  91  <type scope="com::sun::star::beans">XPropertySetInfo</type>, then this returns
  92  the same <type scope="com::sun::star::beans">Property</type> as the
  93  <type scope="com::sun::star::beans">XPropertySetInfo</type> of the parent.
  94  </p>
  95 */
  96     [optional] interface com::sun::star::beans::XProperty;
  97
  98 /** provides access to the default state of this element. [optional]
  99
 100  <p>This interface may be missing, if the hierarchy supports access to
 101  a default state and values only for simple values or not at all.
 102  </p>
 103
 104  <p>If the parent of this object implements
 105  <type scope="com::sun::star::beans">XPropertyState</type>, then members
 106  of this interface have the same effect as corresponding members of the parent.
 107  </p>
 108
 109  <p>If an implementation is part of a <em>read-only</em> view of the hierarchy,
 110  attempts to change property states will fail.
 111  </p>
 112 */
 113     [optional] interface com::sun::star::beans::XPropertyWithState;
 114
 115 /** provides access to the parent of this element [optional].
 116
 117  <p>This interface may be missing if this object is not obtained
 118  as a child or descendant of another tree node, for example, directly from a factory or provider.
 119  </p>
 120
 121  <p><member scope="com::sun::star::container">XChild::getParent()</member>
 122  returns NULL, if this object is currently not contained in another node.
 123  </p>
 124
 125  <p><em>Setting a different parent is, generally, not supported.</em></p>
 126 */
 127     [optional] interface com::sun::star::container::XChild;
 128
 129 };
 130
 131 //=============================================================================
 132
 133 }; }; }; };
 134
 135 #endif