offapi/com/sun/star/sheet/DataPilotFieldGroup.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_DataPilotFieldGroup_idl__
  21 #define __com_sun_star_sheet_DataPilotFieldGroup_idl__
  22
  23 #include <com/sun/star/container/XNamed.idl>
  24 #include <com/sun/star/container/XNameContainer.idl>
  25 #include <com/sun/star/container/XEnumerationAccess.idl>
  26 #include <com/sun/star/container/XIndexAccess.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** represents a collection of members in a data pilot field group.
  33
  34     <p>The members (also called items) of this collection are instances of
  35     DataPilotFieldGroupItem.</p>
  36
  37     @see DataPilotField
  38     @see DataPilotFieldGroups
  39     @see DataPilotFieldGroupItem
  40  */
  41 published service DataPilotFieldGroup
  42 {
  43
  44     /** provides access to the name of the data pilot field group.
  45
  46         <p>It is possible to change the name of this field group as long as
  47         the new name is not used in the collection of groups in the field.</p>
  48      */
  49     interface com::sun::star::container::XNamed;
  50
  51
  52     /** provides access to the data pilot field group members in the
  53         collection via index.
  54      */
  55     interface com::sun::star::container::XIndexAccess;
  56
  57
  58     /** creates an enumeration of all data pilot field group members.
  59
  60         @see DataPilotFieldGroupEnumeration
  61      */
  62     interface com::sun::star::container::XEnumerationAccess;
  63
  64
  65     /** provides access to the data pilot field group members in the
  66         collection via name.
  67      */
  68     interface com::sun::star::container::XNameAccess;
  69
  70
  71     /** provides read/write access to the data pilot field group members in
  72         the collection via name.
  73
  74         <p>The com::sun::star::container::XNameContainer
  75         and com::sun::star::container::XNameReplace
  76         interfaces can be used to manage the members that this group contains.
  77         It is possible to insert, remove, and replace members.</p>
  78
  79         <p>The method com::sun::star::container::XNameReplace::replaceByName
  80         can be used to rename the
  81         specified member. To do so, the new name has to be passed as second
  82         argument. An implementation should support the following data types:
  83
  84         <ul>
  85         <li>a non-empty `string` specifying the new name of the
  86         group member.</li>
  87         <li>an object supporting the com::sun::star::container::XNamed
  88         interface, for example an instance of
  89         DataPilotFieldGroupItem received from another group.</li>
  90         </ul></p>
  91
  92         <p>The method com::sun::star::container::XNameContainer::insertByName()
  93         can be used to insert a new
  94         member into this field group. An implementation should ignore the
  95         second argument and insert the specified member name.</p>
  96
  97         <p>The method com::sun::star::container::XNameContainer::removeByName()
  98         can be used to remove an existing member name.</p>
  99      */
 100     [optional] interface com::sun::star::container::XNameContainer;
 101
 102 };
 103
 104
 105 }; }; }; };
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */