offapi/com/sun/star/sheet/XDataPilotTables.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: XDataPilotTables.idl,v $
  10  * $Revision: 1.11 $
  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_XDataPilotTables_idl__
  32 #define __com_sun_star_sheet_XDataPilotTables_idl__
  33
  34 #ifndef __com_sun_star_container_XNameAccess_idl__
  35 #include <com/sun/star/container/XNameAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
  39 #include <com/sun/star/sheet/XDataPilotDescriptor.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_CellAddress_idl__
  43 #include <com/sun/star/table/CellAddress.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module sheet {
  49
  50 //=============================================================================
  51
  52 /** provides access to the data pilot tables via name and inserting and
  53     removing data pilot tables.
  54
  55     <p>This interface extends the interface
  56     <type scope="com::sun::star::container">XNameAccess</type> which provides
  57     access to existing data pilot tables in the collection.</p>
  58
  59     @see com::sun::star::sheet::DataPilotTables
  60     @see com::sun::star::sheet::DataPilotTable
  61  */
  62 published interface XDataPilotTables: com::sun::star::container::XNameAccess
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** creates a data pilot descriptor.
  67
  68         <p>This descriptor can be used with
  69         <member>XDataPilotTables::addTable</member>.</p>
  70
  71         @see com::sun::star::sheet::DataPilotDescriptor
  72      */
  73     com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor();
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** creates a new data pilot table and adds it to the collection.
  78
  79         @param aName
  80             the name of the data pilot table used in the collection.
  81
  82         @param aAoutputAddress
  83             the top left cell of the location of the data pilot table in
  84             the spreadsheet document.
  85
  86         @param xDescriptor
  87             the descriptor containing the settings of the data pilot table.
  88
  89         @see com::sun::star::sheet::DataPilotDescriptor
  90      */
  91     void insertNewByName(
  92             [in] string aName,
  93             [in] com::sun::star::table::CellAddress aOutputAddress,
  94             [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor );
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** deletes a data pilot table from the collection.
  99      */
 100     void removeByName( [in] string aName );
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif
 109