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