offapi/com/sun/star/configuration/AccessRootElement.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 the root element of a hierarchy and
  24     about the hierarchy as a whole.
  25
  26  <p>Provides information about the element and the whole hierarchy.
  27  Allows controlling the lifetime of the hierarchy.
  28  Allows observing changes in the hierarchy as a whole.
  29  </p>
  30
  31  <p>When access to a hierarchy is first obtained from a factory or provider,
  32  this is the initial object that is created by the factory.
  33  It represents the <em>root</em> of the accessible part of the hierarchy.
  34  </p>
  35
  36  <p><em><strong>NOTE:</strong> In this description "hierarchy" may actually
  37  designate a part or fragment of a larger hierarchy. It is that part that is
  38  rooted in the element represented by an implementation of this service
  39  and that is accessible starting from this element.</em>
  40  </p>
  41
  42  <p>Generally it is not possible to navigate the parent or siblings, if any,
  43  of this element, so com::sun::star::container::XChild is
  44  not supported.
  45  </p>
  46
  47  @see com::sun::star::configuration::UpdateRootElement
  48     Implementations that support modifying data in the hierarchy
  49     implement service UpdateRootElement.
  50
  51  @see com::sun::star::configuration::SetElement
  52     A complementary service, for children of a dynamic homogeneous container.
  53
  54  @see com::sun::star::configuration::GroupElement
  55     A complementary service, for children of a static heterogeneous collection.
  56
  57  @see com::sun::star::configuration::ConfigurationProvider
  58     Objects provided by a ConfigurationProvider implement this service.
  59 */
  60 published service AccessRootElement
  61 {
  62 /** the basic service for accessing information about an element in the
  63  hierarchy.
  64 */
  65     service HierarchyElement;
  66
  67 /** allows controlling or observing the lifetime of the whole hierarchy.
  68
  69  <p>The owner of the hierarchy may dispose of this object
  70  using com::sun::star::lang::XComponent::dispose().
  71  As this object owns its child elements and, recursively, the whole hierarchy,
  72  any descendant elements obtained, directly or indirectly, from this object
  73  will also be disposed. Disposing of the object does not affect a persistent
  74  representation of the hierarchy.
  75  </p>
  76
  77  <p>When an implementation is obtained from a factory or provider, ownership
  78  of it is usually transferred to the client. See the documentation
  79  of the particular provider or factory service for details.
  80  </p>
  81
  82  <p>The provider of this object may still dispose of this object, when the
  83  lifetime of the provider ends or if these objects represent
  84  the root of only a fragment of an enclosing hierarchy and
  85  this fragment is removed from the complete hierarchy by an outside source.
  86  </p>
  87
  88  <p>Clients may register a com::sun::star::lang::XEventListener
  89  to be notified when the object is disposed for either cause.
  90  </p>
  91 */
  92     interface com::sun::star::lang::XComponent;
  93
  94 /** allows registering listeners that observe the whole hierarchy.
  95
  96  <p>A client can register an
  97  com::sun::star::util::XChangesListener,
  98  which will receive notifications for any changes within the
  99  hierarchy (fragment) this object represents.
 100  </p>
 101
 102  <p>An implementation will collect as many changes as possible into a single
 103  com::sun::star::util::ChangesEvent. For Example:
 104  </p>
 105
 106  <p>
 107  If com::sun::star::beans::XMultiPropertySet::setPropertyValues()
 108  or com::sun::star::beans::XMultiHierarchicalPropertySet::setHierarchicalPropertyValues()
 109  is used on an element of the hierarchy to change multiple values within
 110  the hierarchy, all changes will be notified with a single event.
 111  </p>
 112
 113  <p>If an outside source uses
 114  com::sun::star::util::XChangesBatch::commitChanges()
 115  on an overlapping hierarchy access, all relevant changes will be notified
 116  with a single event.
 117  </p>
 118
 119  @see UpdateRootElement
 120  @see com::sun::star::util::XChangesBatch
 121 */
 122     interface com::sun::star::util::XChangesNotifier;
 123
 124 /** provides access to the locale that applies to locale-dependent data
 125  in this hierarchy. [optional]
 126
 127  <p>This interface may be missing if the implementation does not support
 128  locale-dependent data in the hierarchy or if the (partial) hierarchy rooted
 129  in this object does not contain any locale-dependent elements.
 130  </p>
 131
 132  <p><em>Changing the locale is generally not supported.</em> If it is supported,
 133  there is no guarantee that values already loaded into the hierarchy, or an
 134  application cache, are refreshed to reflect the new locale. Use of
 135  com::sun::star::lang::XLocalizable::setLocale()
 136  is therefore not recommended.
 137  </p>
 138 */
 139     [optional] interface com::sun::star::lang::XLocalizable;
 140
 141 };
 142
 143
 144 }; }; }; };
 145
 146 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */