99 lines
3.5 KiB
Text
99 lines
3.5 KiB
Text
/* -*- 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 .
|
|
*/
|
|
|
|
|
|
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
|
|
DataPilotFieldGroupItem.</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 com::sun::star::container::XNameContainer
|
|
and com::sun::star::container::XNameReplace
|
|
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 com::sun::star::container::XNameReplace::replaceByName
|
|
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 `string` specifying the new name of the
|
|
group member.</li>
|
|
<li>an object supporting the com::sun::star::container::XNamed
|
|
interface, for example an instance of
|
|
DataPilotFieldGroupItem received from another group.</li>
|
|
</ul></p>
|
|
|
|
<p>The method com::sun::star::container::XNameContainer::insertByName()
|
|
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 com::sun::star::container::XNameContainer::removeByName()
|
|
can be used to remove an existing member name.</p>
|
|
*/
|
|
[optional] interface com::sun::star::container::XNameContainer;
|
|
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|