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