offapi/com/sun/star/sheet/DataPilotFieldGroup.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
  28 #ifndef __com_sun_star_sheet_DataPilotFieldGroup_idl__
  29 #define __com_sun_star_sheet_DataPilotFieldGroup_idl__
  30
  31 #ifndef __com_sun_star_container_XNamed_idl__
  32 #include <com/sun/star/container/XNamed.idl>
  33 #endif
  34 #ifndef __com_sun_star_container_XNameContainer_idl__
  35 #include <com/sun/star/container/XNameContainer.idl>
  36 #endif
  37 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  38 #include <com/sun/star/container/XEnumerationAccess.idl>
  39 #endif
  40 #ifndef __com_sun_star_container_XIndexAccess_idl__
  41 #include <com/sun/star/container/XIndexAccess.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46 module com {  module sun {  module star {  module sheet {
  47
  48 //=============================================================================
  49
  50 /** represents a collection of members in a data pilot field group.
  51
  52     <p>The members (also called items) of this collection are instances of
  53     <type>DataPilotFieldGroupItem</type>.</p>
  54
  55     @see DataPilotField
  56     @see DataPilotFieldGroups
  57     @see DataPilotFieldGroupItem
  58  */
  59 published service DataPilotFieldGroup
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /** provides access to the name of the data pilot field group.
  64
  65         <p>It is possible to change the name of this field group as long as
  66         the new name is not used in the collection of groups in the field.</p>
  67      */
  68     interface com::sun::star::container::XNamed;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** provides access to the data pilot field group members in the
  73         collection via index.
  74      */
  75     interface com::sun::star::container::XIndexAccess;
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** creates an enumeration of all data pilot field group members.
  80
  81         @see DataPilotFieldGroupEnumeration
  82      */
  83     interface com::sun::star::container::XEnumerationAccess;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** provides access to the data pilot field group members in the
  88         collection via name.
  89      */
  90     interface com::sun::star::container::XNameAccess;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** provides read/write access to the data pilot field group members in
  95         the collection via name.
  96
  97         <p>The <type scope="com::sun::star::container">XNameContainer</type>
  98         and <type scope="com::sun::star::container">XNameReplace</type>
  99         interfaces can be used to manage the members that this group contains.
 100         It is possible to insert, remove, and replace members.</p>
 101
 102         <p>The method <member scope="com::sun::star::container">
 103         XNameReplace::replaceByName</member> can be used to rename the
 104         specified member. To do so, the new name has to be passed as second
 105         argument. An implementation should support the following data types:
 106
 107         <ul>
 108         <li>a non-empty <atom>string</atom> specifying the new name of the
 109         group member.</li>
 110         <li>an object supporting the <type scope="com::sun::star::container">
 111         XNamed</type> interface, for example an instance of
 112         <type>DataPilotFieldGroupItem</type> received from another group.</li>
 113         </ul></p>
 114
 115         <p>The method <member scope="com::sun::star::container">
 116         XNameContainer::insertByName</member> can be used to insert a new
 117         member into this field group. An implementation should ignore the
 118         second argument and insert the specified member name.</p>
 119
 120         <p>The method <member scope="com::sun::star::container">
 121         XNameContainer::removeByName</member> can be used to remove an
 122         existing member name.</p>
 123      */
 124     [optional] interface com::sun::star::container::XNameContainer;
 125
 126 };
 127
 128 //=============================================================================
 129
 130 }; }; }; };
 131
 132 #endif
 133