offapi/com/sun/star/configuration/SetAccess.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 access to a dynamic, homogeneous set of values or nested
  24  trees within a hierarchy.
  25
  26  <p>Also provides information about the template for elements.
  27  Allows normalizing externally generated names.
  28  </p>
  29
  30  <p><em>Sets</em> are dynamic containers within the hierarchy.</p>
  31
  32  <p>The number and names of contained elements are not fixed in advance,
  33  but all elements have to be of one predetermined type.
  34  </p>
  35
  36  @see com::sun::star::configuration::SetElement
  37     Child objects of this service generally implement SetElement.
  38     The template name returned by the child from
  39     XTemplateInstance::getTemplateName()
  40     corresponds to the name returned by the set from
  41     XTemplateContainer::getElementTemplateName().
  42
  43  @see com::sun::star::configuration::GroupAccess
  44     A complementary service that provides for static heterogeneous groups of
  45     elements within the hierarchy.
  46
  47 */
  48 published service SetAccess
  49 {
  50 /** is the basic service for accessing child and descendent nodes in a hierarchy.
  51
  52  <p>External names (from foreign namespaces) should be normalized using
  53  com::sun::star::util::XStringEscape::escapeString()
  54  (if available) before using them as element names.
  55  </p>
  56 */
  57     service HierarchyAccess;
  58
  59 /** is the basic service providing information about and access to elements
  60  of a not necessarily hierarchical <em>set</em>.
  61
  62  <p>Interface com::sun::star::configuration::XTemplateContainer,
  63  which is optional in SimpleSetAccess must always be implemented
  64  in this service, if the elements are of object type.  </p>
  65 */
  66     service SimpleSetAccess;
  67
  68 /** allows attaching listeners to this node to monitor changes to the set.
  69
  70  <p>In this service, support for notifications is mandatory.
  71  </p>
  72 */
  73     interface com::sun::star::container::XContainer;
  74
  75 };
  76
  77
  78 }; }; }; };
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */