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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_DataPilotFields_idl__
  29 #define __com_sun_star_sheet_DataPilotFields_idl__
  30
  31 #ifndef __com_sun_star_container_XNameAccess_idl__
  32 #include <com/sun/star/container/XNameAccess.idl>
  33 #endif
  34 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  35 #include <com/sun/star/container/XEnumerationAccess.idl>
  36 #endif
  37 #ifndef __com_sun_star_container_XIndexAccess_idl__
  38 #include <com/sun/star/container/XIndexAccess.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module sheet {
  44
  45 //=============================================================================
  46
  47 /** represents a collection of fields in a data pilot table.
  48
  49     <p>If the data pilot table is based on a spreadsheet cell range, the
  50     fields are representred by the columns of the range and are named using
  51     the first row of the range.</p>
  52
  53     @see com::sun::star::sheet::DataPilotField
  54  */
  55 published service DataPilotFields
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** provides access to the data pilot fields in the collection via index.
  60      */
  61     interface com::sun::star::container::XIndexAccess;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** creates an enumeration of all data pilot fields.
  66
  67         @see com::sun::star::sheet::DataPilotItemsEnumeration
  68      */
  69     interface com::sun::star::container::XEnumerationAccess;
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** provides access to the data pilot fields in the collection via name.
  74      */
  75     interface com::sun::star::container::XNameAccess;
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif
  84