offapi/com/sun/star/sheet/DataPilotFields.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_DataPilotFields_idl__
  21 #define __com_sun_star_sheet_DataPilotFields_idl__
  22
  23 #include <com/sun/star/container/XNameAccess.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 fields in a data pilot table.
  32
  33     <p>If the data pilot table is based on a spreadsheet cell range, the
  34     fields are represented by the columns of the range and are named using
  35     the first row of the range.</p>
  36
  37     @see com::sun::star::sheet::DataPilotField
  38  */
  39 published service DataPilotFields
  40 {
  41
  42     /** provides access to the data pilot fields in the collection via index.
  43      */
  44     interface com::sun::star::container::XIndexAccess;
  45
  46
  47     /** creates an enumeration of all data pilot fields.
  48
  49         @see com::sun::star::sheet::DataPilotItemsEnumeration
  50      */
  51     interface com::sun::star::container::XEnumerationAccess;
  52
  53
  54     /** provides access to the data pilot fields in the collection via name.
  55      */
  56     interface com::sun::star::container::XNameAccess;
  57
  58 };
  59
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */