1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_DataPilotFieldGroup_idl__
25#define __com_sun_star_sheet_DataPilotFieldGroup_idl__
26
27#ifndef __com_sun_star_container_XNamed_idl__
28#include <com/sun/star/container/XNamed.idl>
29#endif
30#ifndef __com_sun_star_container_XNameContainer_idl__
31#include <com/sun/star/container/XNameContainer.idl>
32#endif
33#ifndef __com_sun_star_container_XEnumerationAccess_idl__
34#include <com/sun/star/container/XEnumerationAccess.idl>
35#endif
36#ifndef __com_sun_star_container_XIndexAccess_idl__
37#include <com/sun/star/container/XIndexAccess.idl>
38#endif
39
40//=============================================================================
41
42module com {  module sun {  module star {  module sheet {
43
44//=============================================================================
45
46/** represents a collection of members in a data pilot field group.
47
48    <p>The members (also called items) of this collection are instances of
49    <type>DataPilotFieldGroupItem</type>.</p>
50
51    @see DataPilotField
52    @see DataPilotFieldGroups
53    @see DataPilotFieldGroupItem
54 */
55published service DataPilotFieldGroup
56{
57	//-------------------------------------------------------------------------
58
59	/** provides access to the name of the data pilot field group.
60
61        <p>It is possible to change the name of this field group as long as
62        the new name is not used in the collection of groups in the field.</p>
63	 */
64	interface com::sun::star::container::XNamed;
65
66    //-------------------------------------------------------------------------
67
68    /** provides access to the data pilot field group members in the
69        collection via index.
70	 */
71	interface com::sun::star::container::XIndexAccess;
72
73	//-------------------------------------------------------------------------
74
75	/** creates an enumeration of all data pilot field group members.
76
77        @see DataPilotFieldGroupEnumeration
78	 */
79	interface com::sun::star::container::XEnumerationAccess;
80
81	//-------------------------------------------------------------------------
82
83    /** provides access to the data pilot field group members in the
84        collection via name.
85	 */
86	interface com::sun::star::container::XNameAccess;
87
88    //-------------------------------------------------------------------------
89
90    /** provides read/write access to the data pilot field group members in
91        the collection via name.
92
93        <p>The <type scope="com::sun::star::container">XNameContainer</type>
94        and <type scope="com::sun::star::container">XNameReplace</type>
95        interfaces can be used to manage the members that this group contains.
96        It is possible to insert, remove, and replace members.</p>
97
98        <p>The method <member scope="com::sun::star::container">
99        XNameReplace::replaceByName</member> can be used to rename the
100        specified member. To do so, the new name has to be passed as second
101        argument. An implementation should support the following data types:
102
103        <ul>
104        <li>a non-empty <atom>string</atom> specifying the new name of the
105        group member.</li>
106        <li>an object supporting the <type scope="com::sun::star::container">
107        XNamed</type> interface, for example an instance of
108        <type>DataPilotFieldGroupItem</type> received from another group.</li>
109        </ul></p>
110
111        <p>The method <member scope="com::sun::star::container">
112        XNameContainer::insertByName</member> can be used to insert a new
113        member into this field group. An implementation should ignore the
114        second argument and insert the specified member name.</p>
115
116        <p>The method <member scope="com::sun::star::container">
117        XNameContainer::removeByName</member> can be used to remove an
118        existing member name.</p>
119     */
120    [optional] interface com::sun::star::container::XNameContainer;
121
122};
123
124//=============================================================================
125
126}; }; }; };
127
128#endif
129
130