/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSheetLinkable.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:20:30 $
 *
 *  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_XSheetLinkable_idl__
#define __com_sun_star_sheet_XSheetLinkable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_SheetLinkMode_idl__
#include <com/sun/star/sheet/SheetLinkMode.idl>
#endif

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

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

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

/** enables a sheet to refer to another sheet in a different document.

    <p>To insert a sheet link, the sheet used as linked sheet has to exist
    already. The method <member>XSheetLinkable::link</member> creates a
    <type>SheetLink</type> object in the document's <type>SheetLinks</type>
    collection and links the sheet to the specified external sheet.</p>

    @see com::sun::star::sheet::SheetLinks
    @see com::sun::star::sheet::SheetLink

    @deprecated
 */
published interface XSheetLinkable: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the link mode of the spreadsheet.

        <p>If the returned value is <const>SheetLinkMode::NORMAL</const>,
        formulas are copied. With <const>SheetLinkMode::VALUE</const>,
        only results of formulas are used.</p>
     */
    com::sun::star::sheet::SheetLinkMode getLinkMode();

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

    /** enables the linking of the sheet and controls whether formulas
        are copied.

        @param nLinkMode
            the value specifying the link mode for this spreadsheet.

            <p>If the value is <const>SheetLinkMode::NORMAL</const>,
            formulas are copied.  With <const>SheetLinkMode::VALUE</const>,
            only results of formulas are used.</p>
     */
    void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode );

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

    /** returns the target URL of the link.
     */
    string getLinkUrl();

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

    /** sets the target URL of the link.

        <p>A <type>SheetLink</type> object with the same file name must
        exist already or the link will not work.</p>
     */
    void setLinkUrl( [in] string aLinkUrl );

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

    /** returns the sheet name of the sheet in the source document.
     */
    string getLinkSheetName();

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

    /** sets the name of the linked sheet in the source document.

        <p>This method sets the sheet name in the <type>SheetLink</type>
        object, it does not modify the sheet name in the source document.</p>
     */
    void setLinkSheetName( [in] string aLinkSheetName );

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

    /** links the sheet to another sheet in another document.

        <p>A <type>SheetLink</type> object is created if it does not exist,
        and the link mode, the URL of the linked document and the linked
        sheet name are set.</p>
     */
    void link( [in] string aUrl,
             [in] string aSheetName,
             [in] string aFilterName,
             [in] string aFilterOptions,
             [in] com::sun::star::sheet::SheetLinkMode nMode );

};

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

}; }; }; };

#endif

