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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDataPilotDataLayoutFieldSupplier.idl,v $
  10  * $Revision: 1.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
  32 #define __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
  33
  34 #ifndef __com_sun_star_sheet_XDataPilotField_idl__
  35 #include <com/sun/star/sheet/XDataPilotField.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** Provides access to the <type>DataPilotField</type> used to layout
  45     multiple data fields.
  46
  47     <p>This data field can be inserted into the rows dimension or columns
  48     dimension by changing its <member scope="DataPilotField">Orientation</member>
  49     property. This interface can be used to access the data layout field
  50     before multiple data fields are inserted into the DataPilot table. It
  51     remains invisible as long as the DataPilot table contains at most one data
  52     field.</p>
  53
  54     @see com::sun::star::sheet::DataPilotDescriptor
  55     @see com::sun::star::sheet::DataPilotTable
  56  */
  57 published interface XDataPilotDataLayoutFieldSupplier
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** Returns the <type>DataPilotField</type> used to layout multiple data
  62         fields.
  63
  64         <p>If the field does not exist yet, it will be created. It is possible
  65         to insert this field into the rows or columns dimension by changing
  66         its <member scope="DataPilotField">Orientation</member> property.</p>
  67      */
  68     XDataPilotField getDataLayoutField();
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif
  77