/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XNamedRange.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:12:56 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XNamedRange_idl__
#define __com_sun_star_sheet_XNamedRange_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

//=============================================================================

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

//=============================================================================

/** provides access to the settings of a named range in a spreadsheet
    document.

    @see com::sun::star::sheet::NamedRange
 */
published interface XNamedRange: com::sun::star::container::XNamed
{
    //-------------------------------------------------------------------------

    /** returns the content of the named range.

        <p>The content can be a reference to a cell or cell range
        or any formula expression.</p>
     */
    string getContent();

    //-------------------------------------------------------------------------

    /** sets the content of the named range.

        <p>The content can be a reference to a cell or cell range
        or any formula expression.</p>
     */
    void setContent( [in] string aContent );

    //-------------------------------------------------------------------------

    /** returns the position in the document which is used as a
        base for relative references in the content.
     */
    com::sun::star::table::CellAddress getReferencePosition();

    //-------------------------------------------------------------------------

    /** sets the position in the document which is used as a
        base for relative references in the content.
     */
    void setReferencePosition(
            [in] com::sun::star::table::CellAddress aReferencePosition );

    //-------------------------------------------------------------------------

    /** returns the type of the named range.

        <p>This is a combination of flags as defined in
        <type>NamedRangeFlag</type>.</p>
     */
    long getType();

    //-------------------------------------------------------------------------

    /** sets the type of the named range.

        @param nType
            a combination of flags that specify the type of a named range,
            as defined in <type>NamedRangeFlag</type>.
     */
    void setType( [in] long nType );

};

//=============================================================================

}; }; }; };

#endif

