offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.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_XDataPilotDataLayoutFieldSupplier_idl__
  21 #define __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
  22
  23 #include <com/sun/star/sheet/XDataPilotField.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** Provides access to the DataPilotField used to layout
  30     multiple data fields.
  31
  32     <p>This data field can be inserted into the rows dimension or columns
  33     dimension by changing its DataPilotField::Orientation
  34     property. This interface can be used to access the data layout field
  35     before multiple data fields are inserted into the DataPilot table. It
  36     remains invisible as long as the DataPilot table contains at most one data
  37     field.</p>
  38
  39     @see com::sun::star::sheet::DataPilotDescriptor
  40     @see com::sun::star::sheet::DataPilotTable
  41  */
  42 published interface XDataPilotDataLayoutFieldSupplier
  43 {
  44
  45     /** Returns the DataPilotField used to layout multiple data
  46         fields.
  47
  48         <p>If the field does not exist yet, it will be created. It is possible
  49         to insert this field into the rows or columns dimension by changing
  50         its DataPilotField::Orientation property.</p>
  51      */
  52     XDataPilotField getDataLayoutField();
  53
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */