offapi/com/sun/star/sheet/XSheetLinkable.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: XSheetLinkable.idl,v $
  10  * $Revision: 1.8 $
  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_XSheetLinkable_idl__
  32 #define __com_sun_star_sheet_XSheetLinkable_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_SheetLinkMode_idl__
  39 #include <com/sun/star/sheet/SheetLinkMode.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** enables a sheet to refer to another sheet in a different document.
  49
  50     <p>To insert a sheet link, the sheet used as linked sheet has to exist
  51     already. The method <member>XSheetLinkable::link</member> creates a
  52     <type>SheetLink</type> object in the document's <type>SheetLinks</type>
  53     collection and links the sheet to the specified external sheet.</p>
  54
  55     @see com::sun::star::sheet::SheetLinks
  56     @see com::sun::star::sheet::SheetLink
  57
  58     @deprecated
  59  */
  60 published interface XSheetLinkable: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** returns the link mode of the spreadsheet.
  65
  66         <p>If the returned value is <const>SheetLinkMode::NORMAL</const>,
  67         formulas are copied. With <const>SheetLinkMode::VALUE</const>,
  68         only results of formulas are used.</p>
  69      */
  70     com::sun::star::sheet::SheetLinkMode getLinkMode();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** enables the linking of the sheet and controls whether formulas
  75         are copied.
  76
  77         @param nLinkMode
  78             the value specifying the link mode for this spreadsheet.
  79
  80             <p>If the value is <const>SheetLinkMode::NORMAL</const>,
  81             formulas are copied.  With <const>SheetLinkMode::VALUE</const>,
  82             only results of formulas are used.</p>
  83      */
  84     void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** returns the target URL of the link.
  89      */
  90     string getLinkUrl();
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** sets the target URL of the link.
  95
  96         <p>A <type>SheetLink</type> object with the same file name must
  97         exist already or the link will not work.</p>
  98      */
  99     void setLinkUrl( [in] string aLinkUrl );
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** returns the sheet name of the sheet in the source document.
 104      */
 105     string getLinkSheetName();
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** sets the name of the linked sheet in the source document.
 110
 111         <p>This method sets the sheet name in the <type>SheetLink</type>
 112         object, it does not modify the sheet name in the source document.</p>
 113      */
 114     void setLinkSheetName( [in] string aLinkSheetName );
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** links the sheet to another sheet in another document.
 119
 120         <p>A <type>SheetLink</type> object is created if it does not exist,
 121         and the link mode, the URL of the linked document and the linked
 122         sheet name are set.</p>
 123      */
 124     void link( [in] string aUrl,
 125              [in] string aSheetName,
 126              [in] string aFilterName,
 127              [in] string aFilterOptions,
 128              [in] com::sun::star::sheet::SheetLinkMode nMode );
 129
 130 };
 131
 132 //=============================================================================
 133
 134 }; }; }; };
 135
 136 #endif
 137