blob: 11d6250764407e25c047c9ab23874cb2c57e755b (
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_sheet_DataPilotFieldGroups_idl__
#define __com_sun_star_sheet_DataPilotFieldGroups_idl__
#include <com/sun/star/container/XNameContainer.idl>
#include <com/sun/star/container/XEnumerationAccess.idl>
#include <com/sun/star/container/XIndexAccess.idl>
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** represents a collection of groups in a data pilot field.
<p>The members of this collection are instances of <type>DataPilotFieldGroup</type>
containing the names of all items in the group.</p>
@see DataPilotField
@see DataPilotFieldGroup
@see DataPilotFieldGroupInfo
*/
published service DataPilotFieldGroups
{
//-------------------------------------------------------------------------
/** provides access to the data pilot field groups in the collection via
index.
*/
interface com::sun::star::container::XIndexAccess;
//-------------------------------------------------------------------------
/** creates an enumeration of all data pilot field groups.
@see DataPilotFieldGroupsEnumeration
*/
interface com::sun::star::container::XEnumerationAccess;
//-------------------------------------------------------------------------
/** provides access to the data pilot field groups in the collection via
name.
*/
interface com::sun::star::container::XNameAccess;
//-------------------------------------------------------------------------
/** provides read/write access to the data pilot field groups 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 item groups. It is possible to
insert, remove, and replace item groups.</p>
<p>The method <member scope="com::sun::star::container">
XNameReplace::replaceByName</member> can be used to replace the item
names in an existing group with a new collection of item names. An
implementation should support the following data types:
<ul>
<li>an empty <atom>any</atom> to remove all items and leave the
group empty. The group can be filled later with new item names.</li>
<li>a <atom dim="[]">string</atom> containing all item names that will
be part of the group.</li>
<li>an object supporting <type scope="com::sun::star::container">
XIndexAccess</type> containing elements that provide an item name per
element via the interface <type scope="com::sun::star::container">
XNamed</type>, for example an instance of <type>DataPilotFieldGroup
</type>.</li>
</ul></p>
<p>The method <member scope="com::sun::star::container">
XNameContainer::insertByName</member> can be used to insert a new
field group with the passed collection of item names. An
implementation should support the same data types as described above
for the method <member scope="com::sun::star::container">
XNameReplace::replaceByName</member>.</p>
<p>The method <member scope="com::sun::star::container">
XNameContainer::removeByName</member> can be used to remove an
existing field group.</p>
*/
[optional] interface com::sun::star::container::XNameContainer;
};
//=============================================================================
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
