/* -*- 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 .
 */

#ifndef __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
#define __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__

#include <com/sun/star/sheet/XDataPilotField.idl>


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


/** Provides access to the DataPilotField used to layout
    multiple data fields.

    <p>This data field can be inserted into the rows dimension or columns
    dimension by changing its DataPilotField::Orientation
    property. This interface can be used to access the data layout field
    before multiple data fields are inserted into the DataPilot table. It
    remains invisible as long as the DataPilot table contains at most one data
    field.</p>

    @see com::sun::star::sheet::DataPilotDescriptor
    @see com::sun::star::sheet::DataPilotTable
 */
published interface XDataPilotDataLayoutFieldSupplier
{

    /** Returns the DataPilotField used to layout multiple data
        fields.

        <p>If the field does not exist yet, it will be created. It is possible
        to insert this field into the rows or columns dimension by changing
        its DataPilotField::Orientation property.</p>
     */
    XDataPilotField getDataLayoutField();

};


}; }; }; };

#endif

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