Quelle  XDataPilotTables.idl   Sprache: unbekannt

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


module com {  module sun {  module star {  module sheet {


/** provides access to the data pilot tables via name and inserting and
    removing data pilot tables.

    <p>This interface extends the interface
    com::sun::star::container::XNameAccess which provides
    access to existing data pilot tables in the collection.</p>

    @see com::sun::star::sheet::DataPilotTables
    @see com::sun::star::sheet::DataPilotTable
 */
published interface XDataPilotTables: com::sun::star::container::XNameAccess
{

    /** creates a data pilot descriptor.

        <p>This descriptor can be used with
        XDataPilotTables::addTable().</p>

        @see com::sun::star::sheet::DataPilotDescriptor
     */
    com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor();


    /** creates a new data pilot table and adds it to the collection.

        @param aName
            the name of the data pilot table used in the collection.

        @param OutputAddress
            the top left cell of the location of the data pilot table in
            the spreadsheet document.

        @param xDescriptor
            the descriptor containing the settings of the data pilot table.

        @see com::sun::star::sheet::DataPilotDescriptor
     */
    void insertNewByName(
            [in] string aName,
            [in] com::sun::star::table::CellAddress OutputAddress,
            [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor );


    /** deletes a data pilot table from the collection.
     */
    void removeByName( [in] string aName );

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */