offapi/com/sun/star/sheet/XAreaLink.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_XAreaLink_idl__
  21 #define __com_sun_star_sheet_XAreaLink_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides methods to change the settings of a linked cell range.
  31
  32     @see com::sun::star::sheet::CellAreaLink
  33  */
  34 published interface XAreaLink: com::sun::star::uno::XInterface
  35 {
  36
  37     /** returns the source of the range within the source document.
  38
  39         <p>This can be the address of a cell or range in the form
  40         "Sheet1.A1:C5", or the name of a named range or database range.</p>
  41      */
  42     string getSourceArea();
  43
  44
  45     /** sets the source of the range within the source document.
  46
  47         <p>This can be the address of a cell or range in the form
  48         "Sheet1.A1:C5", or the name of a named range or database range.</p>
  49      */
  50     void setSourceArea( [in] string aSourceArea );
  51
  52
  53     /** returns the position of the linked range in the destination
  54         document.
  55      */
  56     com::sun::star::table::CellRangeAddress getDestArea();
  57
  58
  59     /** sets the position of the linked range in the destination document.
  60      */
  61     void setDestArea( [in] com::sun::star::table::CellRangeAddress aDestArea );
  62
  63 };
  64
  65
  66 }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */