offapi/com/sun/star/configuration/SimpleSetAccess.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: SimpleSetAccess.idl,v $
  10  * $Revision: 1.9 $
  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_SimpleSetAccess_idl__
  31 #define __com_sun_star_configuration_SimpleSetAccess_idl__
  32
  33 #ifndef __com_sun_star_container_XNameAccess_idl__
  34 #include <com/sun/star/container/XNameAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_XTemplateContainer_idl__
  38 #include <com/sun/star/configuration/XTemplateContainer.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_XStringEscape_idl__
  42 #include <com/sun/star/util/XStringEscape.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_container_XContainer_idl__
  46 #include <com/sun/star/container/XContainer.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module configuration {
  52
  53 //=============================================================================
  54 /** provides access to a dynamic, homogeneous, nonhierarchical set of values
  55  or objects.
  56
  57  <p>Also provides information about the template for elements.
  58  Allows normalizing externally generated names.
  59  </p>
  60
  61  <p><em>Sets</em> are dynamic containers.</p>
  62
  63  <p>The number and names of contained elements is not fixed in advance,
  64  but all elements have to be of one predetermined type.
  65  </p>
  66 */
  67 published service SimpleSetAccess
  68 {
  69 /** is the basic service for accessing child and descendent nodes.
  70
  71  <p>External names from foreign namespaces should be normalized using
  72  <member scope="com::sun::star::util">XStringEscape::escapeString()</member>,
  73  if available, before using them as element names.
  74  </p>
  75 */
  76     interface com::sun::star::container::XNameAccess;
  77
  78 /** provides additional information about the element type. [optional]
  79
  80  <p>All set elements, if they are not just simple values, but whole trees,
  81  must have a predetermined structure (their <em>type</em>)
  82  that is described by and can be generated from a <em>template</em>.
  83  The semantics of the information provided about the template depends on the
  84  implementation.
  85  </p>
  86
  87  <p>This interface may be missing, if the implementation can support only
  88  one predefined type or if the elements are of a simple type and
  89  no further information is available.  In the latter case,
  90  <member scope="com::sun::star::container">XElementAccess::getElementType()</member>
  91  provides all the information there is about the element's type.
  92  </p>
  93 */
  94     [optional] interface com::sun::star::configuration::XTemplateContainer;
  95
  96 /** allows normalizing and denormalizing external names. [optional]
  97
  98  <p>Elements of a <em>set</em> often correspond to external entities,
  99  for example, files, web pages, and people whose names obey different rules and
 100  restrictions than names that are valid in the hierarchical naming scheme.
 101  </p>
 102
 103  <p>This interface may be missing if there are no naming restrictions,
 104  if the implementation handles any such conversions internally,
 105  or if clients must enforce such restrictions themselves. In the last case,
 106  the naming scheme documentation must fully document any restrictions.
 107  </p>
 108 */
 109     [optional] interface com::sun::star::util::XStringEscape;
 110
 111 /** allows attaching listeners to this node to monitor changes to the set. [optional]
 112
 113  <p>This interface may be missing if the implementation does not support
 114  notifications.
 115  </p>
 116 */
 117     [optional] interface com::sun::star::container::XContainer;
 118
 119 };
 120
 121 //=============================================================================
 122
 123 }; }; }; };
 124
 125 #endif