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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a collection of members in a data pilot field group.
  25
  26     <p>The members (also called items) of this collection are instances of
  27     DataPilotFieldGroupItem.</p>
  28
  29     @see DataPilotField
  30     @see DataPilotFieldGroups
  31     @see DataPilotFieldGroupItem
  32  */
  33 published service DataPilotFieldGroup
  34 {
  35
  36     /** provides access to the name of the data pilot field group.
  37
  38         <p>It is possible to change the name of this field group as long as
  39         the new name is not used in the collection of groups in the field.</p>
  40      */
  41     interface com::sun::star::container::XNamed;
  42
  43
  44     /** provides access to the data pilot field group members in the
  45         collection via index.
  46      */
  47     interface com::sun::star::container::XIndexAccess;
  48
  49
  50     /** creates an enumeration of all data pilot field group members.
  51
  52         @see DataPilotFieldGroupEnumeration
  53      */
  54     interface com::sun::star::container::XEnumerationAccess;
  55
  56
  57     /** provides access to the data pilot field group members in the
  58         collection via name.
  59      */
  60     interface com::sun::star::container::XNameAccess;
  61
  62
  63     /** provides read/write access to the data pilot field group members in
  64         the collection via name.
  65
  66         <p>The com::sun::star::container::XNameContainer
  67         and com::sun::star::container::XNameReplace
  68         interfaces can be used to manage the members that this group contains.
  69         It is possible to insert, remove, and replace members.</p>
  70
  71         <p>The method com::sun::star::container::XNameReplace::replaceByName
  72         can be used to rename the
  73         specified member. To do so, the new name has to be passed as second
  74         argument. An implementation should support the following data types:
  75
  76         <ul>
  77         <li>a non-empty `string` specifying the new name of the
  78         group member.</li>
  79         <li>an object supporting the com::sun::star::container::XNamed
  80         interface, for example an instance of
  81         DataPilotFieldGroupItem received from another group.</li>
  82         </ul></p>
  83
  84         <p>The method com::sun::star::container::XNameContainer::insertByName()
  85         can be used to insert a new
  86         member into this field group. An implementation should ignore the
  87         second argument and insert the specified member name.</p>
  88
  89         <p>The method com::sun::star::container::XNameContainer::removeByName()
  90         can be used to remove an existing member name.</p>
  91      */
  92     [optional] interface com::sun::star::container::XNameContainer;
  93
  94 };
  95
  96
  97 }; }; }; };
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */