offapi/com/sun/star/configuration/SimpleSetAccess.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_configuration_SimpleSetAccess_idl__
  28 #define __com_sun_star_configuration_SimpleSetAccess_idl__
  29
  30 #ifndef __com_sun_star_container_XNameAccess_idl__
  31 #include <com/sun/star/container/XNameAccess.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_configuration_XTemplateContainer_idl__
  35 #include <com/sun/star/configuration/XTemplateContainer.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_XStringEscape_idl__
  39 #include <com/sun/star/util/XStringEscape.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_container_XContainer_idl__
  43 #include <com/sun/star/container/XContainer.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module configuration {
  49
  50 //=============================================================================
  51 /** provides access to a dynamic, homogeneous, nonhierarchical set of values
  52  or objects.
  53
  54  <p>Also provides information about the template for elements.
  55  Allows normalizing externally generated names.
  56  </p>
  57
  58  <p><em>Sets</em> are dynamic containers.</p>
  59
  60  <p>The number and names of contained elements is not fixed in advance,
  61  but all elements have to be of one predetermined type.
  62  </p>
  63 */
  64 published service SimpleSetAccess
  65 {
  66 /** is the basic service for accessing child and descendent nodes.
  67
  68  <p>External names from foreign namespaces should be normalized using
  69  <member scope="com::sun::star::util">XStringEscape::escapeString()</member>,
  70  if available, before using them as element names.
  71  </p>
  72 */
  73     interface com::sun::star::container::XNameAccess;
  74
  75 /** provides additional information about the element type. [optional]
  76
  77  <p>All set elements, if they are not just simple values, but whole trees,
  78  must have a predetermined structure (their <em>type</em>)
  79  that is described by and can be generated from a <em>template</em>.
  80  The semantics of the information provided about the template depends on the
  81  implementation.
  82  </p>
  83
  84  <p>This interface may be missing, if the implementation can support only
  85  one predefined type or if the elements are of a simple type and
  86  no further information is available.  In the latter case,
  87  <member scope="com::sun::star::container">XElementAccess::getElementType()</member>
  88  provides all the information there is about the element's type.
  89  </p>
  90 */
  91     [optional] interface com::sun::star::configuration::XTemplateContainer;
  92
  93 /** allows normalizing and denormalizing external names. [optional]
  94
  95  <p>Elements of a <em>set</em> often correspond to external entities,
  96  for example, files, web pages, and people whose names obey different rules and
  97  restrictions than names that are valid in the hierarchical naming scheme.
  98  </p>
  99
 100  <p>This interface may be missing if there are no naming restrictions,
 101  if the implementation handles any such conversions internally,
 102  or if clients must enforce such restrictions themselves. In the last case,
 103  the naming scheme documentation must fully document any restrictions.
 104  </p>
 105 */
 106     [optional] interface com::sun::star::util::XStringEscape;
 107
 108 /** allows attaching listeners to this node to monitor changes to the set. [optional]
 109
 110  <p>This interface may be missing if the implementation does not support
 111  notifications.
 112  </p>
 113 */
 114     [optional] interface com::sun::star::container::XContainer;
 115
 116 };
 117
 118 //=============================================================================
 119
 120 }; }; }; };
 121
 122 #endif