offapi/com/sun/star/configuration/SetAccess.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: SetAccess.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_SetAccess_idl__
  31 #define __com_sun_star_configuration_SetAccess_idl__
  32
  33 #ifndef __com_sun_star_configuration_HierarchyAccess_idl__
  34 #include <com/sun/star/configuration/HierarchyAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_SimpleSetAccess_idl__
  38 #include <com/sun/star/configuration/SimpleSetAccess.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_XContainer_idl__
  42 #include <com/sun/star/container/XContainer.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module configuration {
  48
  49 //=============================================================================
  50 /** provides access to a dynamic, homogeneous set of values or nested
  51  trees within a hierarchy.
  52
  53  <p>Also provides information about the template for elements.
  54  Allows normalizing externally generated names.
  55  </p>
  56
  57  <p><em>Sets</em> are dynamic containers within the hierarchy.</p>
  58
  59  <p>The number and names of contained elements are not fixed in advance,
  60  but all elements have to be of one predetermined type.
  61  </p>
  62
  63  @see com::sun::star::configuration::SetElement
  64     Child objects of this service generally implement <type>SetElement</type>.
  65     The template name returned by the child from
  66     <member>XTemplateInstance::getTemplateName()</member>
  67     corresponds to the name returned by the set from
  68     <member>XTemplateContainer::getElementTemplateName()</member>.
  69
  70  @see com::sun::star::configuration::GroupAccess
  71     A complementary service that provides for static heterogeneous groups of
  72     elements within the hierarchy.
  73
  74 */
  75 published service SetAccess
  76 {
  77 /** is the basic service for accessing child and descendent nodes in a hierarchy.
  78
  79  <p>External names (from foreign namespaces) should be normalized using
  80  <member scope="com::sun::star::util">XStringEscape::escapeString()</member>
  81  (if available) before using them as element names.
  82  </p>
  83 */
  84     service HierarchyAccess;
  85
  86 /** is the basic service providing information about and access to elements
  87  of a not necessarily hierarchical <em>set</em>.
  88
  89  <p>Interface <type scope="com::sun::star::configuration">XTemplateContainer</type>,
  90  which is optional in <type>SimpleSetAccess</type> must always be implemented
  91  in this service, if the elements are of object type.  </p>
  92 */
  93     service SimpleSetAccess;
  94
  95 /** allows attaching listeners to this node to monitor changes to the set.
  96
  97  <p>In this service, support for notifications is mandatory.
  98  </p>
  99 */
 100     interface com::sun::star::container::XContainer;
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif