offapi/com/sun/star/sheet/XDataPilotTables.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_XDataPilotTables_idl__
  21 #define __com_sun_star_sheet_XDataPilotTables_idl__
  22
  23 #include <com/sun/star/container/XNameAccess.idl>
  24 #include <com/sun/star/sheet/XDataPilotDescriptor.idl>
  25 #include <com/sun/star/table/CellAddress.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** provides access to the data pilot tables via name and inserting and
  32     removing data pilot tables.
  33
  34     <p>This interface extends the interface
  35     com::sun::star::container::XNameAccess which provides
  36     access to existing data pilot tables in the collection.</p>
  37
  38     @see com::sun::star::sheet::DataPilotTables
  39     @see com::sun::star::sheet::DataPilotTable
  40  */
  41 published interface XDataPilotTables: com::sun::star::container::XNameAccess
  42 {
  43
  44     /** creates a data pilot descriptor.
  45
  46         <p>This descriptor can be used with
  47         XDataPilotTables::addTable().</p>
  48
  49         @see com::sun::star::sheet::DataPilotDescriptor
  50      */
  51     com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor();
  52
  53
  54     /** creates a new data pilot table and adds it to the collection.
  55
  56         @param aName
  57             the name of the data pilot table used in the collection.
  58
  59         @param OutputAddress
  60             the top left cell of the location of the data pilot table in
  61             the spreadsheet document.
  62
  63         @param xDescriptor
  64             the descriptor containing the settings of the data pilot table.
  65
  66         @see com::sun::star::sheet::DataPilotDescriptor
  67      */
  68     void insertNewByName(
  69             [in] string aName,
  70             [in] com::sun::star::table::CellAddress OutputAddress,
  71             [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor );
  72
  73
  74     /** deletes a data pilot table from the collection.
  75      */
  76     void removeByName( [in] string aName );
  77
  78 };
  79
  80
  81 }; }; }; };
  82
  83 #endif
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */