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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** enables a sheet to refer to another sheet in a different document.
  25
  26     <p>To insert a sheet link, the sheet used as linked sheet has to exist
  27     already. The method XSheetLinkable::link() creates a
  28     SheetLink object in the document's SheetLinks
  29     collection and links the sheet to the specified external sheet.</p>
  30
  31     @see com::sun::star::sheet::SheetLinks
  32     @see com::sun::star::sheet::SheetLink
  33
  34     @deprecated
  35  */
  36 published interface XSheetLinkable: com::sun::star::uno::XInterface
  37 {
  38
  39     /** returns the link mode of the spreadsheet.
  40
  41         <p>If the returned value is SheetLinkMode::NORMAL,
  42         formulas are copied. With SheetLinkMode::VALUE,
  43         only results of formulas are used.</p>
  44      */
  45     com::sun::star::sheet::SheetLinkMode getLinkMode();
  46
  47
  48     /** enables the linking of the sheet and controls whether formulas
  49         are copied.
  50
  51         @param nLinkMode
  52             the value specifying the link mode for this spreadsheet.
  53
  54             <p>If the value is SheetLinkMode::NORMAL,
  55             formulas are copied.  With SheetLinkMode::VALUE,
  56             only results of formulas are used.</p>
  57      */
  58     void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode );
  59
  60
  61     /** returns the target URL of the link.
  62      */
  63     string getLinkUrl();
  64
  65
  66     /** sets the target URL of the link.
  67
  68         <p>A SheetLink object with the same file name must
  69         exist already or the link will not work.</p>
  70      */
  71     void setLinkUrl( [in] string aLinkUrl );
  72
  73
  74     /** returns the sheet name of the sheet in the source document.
  75      */
  76     string getLinkSheetName();
  77
  78
  79     /** sets the name of the linked sheet in the source document.
  80
  81         <p>This method sets the sheet name in the SheetLink
  82         object, it does not modify the sheet name in the source document.</p>
  83      */
  84     void setLinkSheetName( [in] string aLinkSheetName );
  85
  86
  87     /** links the sheet to another sheet in another document.
  88
  89         <p>A SheetLink object is created if it does not exist,
  90         and the link mode, the URL of the linked document and the linked
  91         sheet name are set.</p>
  92      */
  93     void link( [in] string aUrl,
  94              [in] string aSheetName,
  95              [in] string aFilterName,
  96              [in] string aFilterOptions,
  97              [in] com::sun::star::sheet::SheetLinkMode nMode );
  98
  99 };
 100
 101
 102 }; }; }; };
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */