blob: f520e0d5644e85529ae2c01d010126cdff3c40da (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: DataPilotFieldGroup.idl,v $
* $Revision: 1.4 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_sheet_DataPilotFieldGroup_idl__
#define __com_sun_star_sheet_DataPilotFieldGroup_idl__
#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
#ifndef __com_sun_star_container_XNameContainer_idl__
#include <com/sun/star/container/XNameContainer.idl>
#endif
#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif
#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** represents a collection of members in a data pilot field group.
<p>The members (also called items) of this collection are instances of
<type>DataPilotFieldGroupItem</type>.</p>
@see DataPilotField
@see DataPilotFieldGroups
@see DataPilotFieldGroupItem
*/
published service DataPilotFieldGroup
{
//-------------------------------------------------------------------------
/** provides access to the name of the data pilot field group.
<p>It is possible to change the name of this field group as long as
the new name is not used in the collection of groups in the field.</p>
*/
interface com::sun::star::container::XNamed;
//-------------------------------------------------------------------------
/** provides access to the data pilot field group members in the
collection via index.
*/
interface com::sun::star::container::XIndexAccess;
//-------------------------------------------------------------------------
/** creates an enumeration of all data pilot field group members.
@see DataPilotFieldGroupEnumeration
*/
interface com::sun::star::container::XEnumerationAccess;
//-------------------------------------------------------------------------
/** provides access to the data pilot field group members in the
collection via name.
*/
interface com::sun::star::container::XNameAccess;
//-------------------------------------------------------------------------
/** provides read/write access to the data pilot field group members in
the collection via name.
<p>The <type scope="com::sun::star::container">XNameContainer</type>
and <type scope="com::sun::star::container">XNameReplace</type>
interfaces can be used to manage the members that this group contains.
It is possible to insert, remove, and replace members.</p>
<p>The method <member scope="com::sun::star::container">
XNameReplace::replaceByName</member> can be used to rename the
specified member. To do so, the new name has to be passed as second
argument. An implementation should support the following data types:
<ul>
<li>a non-empty <atom>string</atom> specifying the new name of the
group member.</li>
<li>an object supporting the <type scope="com::sun::star::container">
XNamed</type> interface, for example an instance of
<type>DataPilotFieldGroupItem</type> received from another group.</li>
</ul></p>
<p>The method <member scope="com::sun::star::container">
XNameContainer::insertByName</member> can be used to insert a new
member into this field group. An implementation should ignore the
second argument and insert the specified member name.</p>
<p>The method <member scope="com::sun::star::container">
XNameContainer::removeByName</member> can be used to remove an
existing member name.</p>
*/
[optional] interface com::sun::star::container::XNameContainer;
};
//=============================================================================
}; }; }; };
#endif
|
