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