offapi/com/sun/star/sheet/DataPilotFieldGroups.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 groups in a data pilot field.
  25
  26     <p>The members of this collection are instances of DataPilotFieldGroup
  27     containing the names of all items in the group.</p>
  28
  29     @see DataPilotField
  30     @see DataPilotFieldGroup
  31     @see DataPilotFieldGroupInfo
  32  */
  33 published service DataPilotFieldGroups
  34 {
  35
  36     /** provides access to the data pilot field groups in the collection via
  37         index.
  38      */
  39     interface com::sun::star::container::XIndexAccess;
  40
  41
  42     /** creates an enumeration of all data pilot field groups.
  43
  44         @see DataPilotFieldGroupsEnumeration
  45      */
  46     interface com::sun::star::container::XEnumerationAccess;
  47
  48
  49     /** provides access to the data pilot field groups in the collection via
  50         name.
  51      */
  52     interface com::sun::star::container::XNameAccess;
  53
  54
  55     /** provides read/write access to the data pilot field groups in the
  56         collection via name.
  57
  58         <p>The com::sun::star::container::XNameContainer
  59         and com::sun::star::container::XNameReplace
  60         interfaces can be used to manage the item groups. It is possible to
  61         insert, remove, and replace item groups.</p>
  62
  63         <p>The method com::sun::star::container::XNameReplace::replaceByName()
  64         can be used to replace the item
  65         names in an existing group with a new collection of item names. An
  66         implementation should support the following data types:
  67
  68         <ul>
  69         <li>an empty `any` to remove all items and leave the
  70         group empty. The group can be filled later with new item names.</li>
  71         <li>a `string[]` containing all item names that will
  72         be part of the group.</li>
  73         <li>an object supporting com::sun::star::container::XIndexAccess
  74         containing elements that provide an item name per element via the
  75         interface com::sun::star::container::XNamed,
  76         for example an instance of DataPilotFieldGroup.</li>
  77         </ul></p>
  78
  79         <p>The method com::sun::star::container::XNameContainer::insertByName()
  80         can be used to insert a new
  81         field group with the passed collection of item names. An
  82         implementation should support the same data types as described above
  83         for the method
  84         com::sun::star::container::XNameReplace::replaceByName().</p>
  85
  86         <p>The method com::sun::star::container::XNameContainer::removeByName()
  87         can be used to remove an existing field group.</p>
  88      */
  89     [optional] interface com::sun::star::container::XNameContainer;
  90
  91 };
  92
  93
  94 }; }; }; };
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */