offapi/com/sun/star/sheet/XSheetLinkable.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XSheetLinkable_idl__
  21 #define __com_sun_star_sheet_XSheetLinkable_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/SheetLinkMode.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** enables a sheet to refer to another sheet in a different document.
  31
  32     <p>To insert a sheet link, the sheet used as linked sheet has to exist
  33     already. The method XSheetLinkable::link() creates a
  34     SheetLink object in the document's SheetLinks
  35     collection and links the sheet to the specified external sheet.</p>
  36
  37     @see com::sun::star::sheet::SheetLinks
  38     @see com::sun::star::sheet::SheetLink
  39
  40     @deprecated
  41  */
  42 published interface XSheetLinkable: com::sun::star::uno::XInterface
  43 {
  44
  45     /** returns the link mode of the spreadsheet.
  46
  47         <p>If the returned value is SheetLinkMode::NORMAL,
  48         formulas are copied. With SheetLinkMode::VALUE,
  49         only results of formulas are used.</p>
  50      */
  51     com::sun::star::sheet::SheetLinkMode getLinkMode();
  52
  53
  54     /** enables the linking of the sheet and controls whether formulas
  55         are copied.
  56
  57         @param nLinkMode
  58             the value specifying the link mode for this spreadsheet.
  59
  60             <p>If the value is SheetLinkMode::NORMAL,
  61             formulas are copied.  With SheetLinkMode::VALUE,
  62             only results of formulas are used.</p>
  63      */
  64     void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode );
  65
  66
  67     /** returns the target URL of the link.
  68      */
  69     string getLinkUrl();
  70
  71
  72     /** sets the target URL of the link.
  73
  74         <p>A SheetLink object with the same file name must
  75         exist already or the link will not work.</p>
  76      */
  77     void setLinkUrl( [in] string aLinkUrl );
  78
  79
  80     /** returns the sheet name of the sheet in the source document.
  81      */
  82     string getLinkSheetName();
  83
  84
  85     /** sets the name of the linked sheet in the source document.
  86
  87         <p>This method sets the sheet name in the SheetLink
  88         object, it does not modify the sheet name in the source document.</p>
  89      */
  90     void setLinkSheetName( [in] string aLinkSheetName );
  91
  92
  93     /** links the sheet to another sheet in another document.
  94
  95         <p>A SheetLink object is created if it does not exist,
  96         and the link mode, the URL of the linked document and the linked
  97         sheet name are set.</p>
  98      */
  99     void link( [in] string aUrl,
 100              [in] string aSheetName,
 101              [in] string aFilterName,
 102              [in] string aFilterOptions,
 103              [in] com::sun::star::sheet::SheetLinkMode nMode );
 104
 105 };
 106
 107
 108 }; }; }; };
 109
 110 #endif
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */