offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.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_XDataPilotDataLayoutFieldSupplier_idl__
  29 #define __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
  30
  31 #ifndef __com_sun_star_sheet_XDataPilotField_idl__
  32 #include <com/sun/star/sheet/XDataPilotField.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module sheet {
  38
  39 //=============================================================================
  40
  41 /** Provides access to the <type>DataPilotField</type> used to layout
  42     multiple data fields.
  43
  44     <p>This data field can be inserted into the rows dimension or columns
  45     dimension by changing its <member scope="DataPilotField">Orientation</member>
  46     property. This interface can be used to access the data layout field
  47     before multiple data fields are inserted into the DataPilot table. It
  48     remains invisible as long as the DataPilot table contains at most one data
  49     field.</p>
  50
  51     @see com::sun::star::sheet::DataPilotDescriptor
  52     @see com::sun::star::sheet::DataPilotTable
  53  */
  54 published interface XDataPilotDataLayoutFieldSupplier
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** Returns the <type>DataPilotField</type> used to layout multiple data
  59         fields.
  60
  61         <p>If the field does not exist yet, it will be created. It is possible
  62         to insert this field into the rows or columns dimension by changing
  63         its <member scope="DataPilotField">Orientation</member> property.</p>
  64      */
  65     XDataPilotField getDataLayoutField();
  66
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif
  74