offapi/com/sun/star/configuration/HierarchyElement.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 configuration {
  22
  23 /** provides information about an element within a hierarchy.
  24
  25  <p>The local name and the full hierarchical name can be retrieved.
  26  Attributes detailing the role of the element can be queried.
  27  The state of the element (regarding defaults) can be accessed.
  28  </p>
  29
  30  <p>Implementations of this service usually also implement
  31  service HierarchyAccess, which concerns the complementary role
  32  of providing access to subelements of the hierarchy.
  33  </p>
  34 */
  35 published service HierarchyElement
  36 {
  37 /** provides the complete hierarchical name of this element
  38  within the hierarchy tree.
  39 */
  40     interface com::sun::star::container::XHierarchicalName;
  41
  42 /** provides the local name of this element within its parent.
  43
  44  <p><em>Renaming an element is generally not supported.</em></p>
  45 */
  46     interface com::sun::star::container::XNamed;
  47
  48 /** provides a property descriptor for this element.[optional]
  49
  50  <p>This interface may be missing, if the hierarchy supports no traits that are
  51  described by com::sun::star::beans::PropertyAttribute
  52  values.
  53  </p>
  54
  55  <p>If the parent of this object implements
  56  com::sun::star::beans::XPropertySetInfo, then this returns
  57  the same com::sun::star::beans::Property as the
  58  com::sun::star::beans::XPropertySetInfo of the parent.
  59  </p>
  60 */
  61     [optional] interface com::sun::star::beans::XProperty;
  62
  63 /** provides access to the default state of this element. [optional]
  64
  65  <p>This interface may be missing, if the hierarchy supports access to
  66  a default state and values only for simple values or not at all.
  67  </p>
  68
  69  <p>If the parent of this object implements
  70  com::sun::star::beans::XPropertyState, then members
  71  of this interface have the same effect as corresponding members of the parent.
  72  </p>
  73
  74  <p>If an implementation is part of a <em>read-only</em> view of the hierarchy,
  75  attempts to change property states will fail.
  76  </p>
  77 */
  78     [optional] interface com::sun::star::beans::XPropertyWithState;
  79
  80 /** provides access to the parent of this element [optional].
  81
  82  <p>This interface may be missing if this object is not obtained
  83  as a child or descendant of another tree node, for example, directly from a factory or provider.
  84  </p>
  85
  86  <p>com::sun::star::container::XChild::getParent()
  87  returns NULL, if this object is currently not contained in another node.
  88  </p>
  89
  90  <p><em>Setting a different parent is, generally, not supported.</em></p>
  91 */
  92     [optional] interface com::sun::star::container::XChild;
  93
  94 };
  95
  96
  97 }; }; }; };
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */