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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XAreaLink_idl__
  29 #define __com_sun_star_sheet_XAreaLink_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  36 #include <com/sun/star/table/CellRangeAddress.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** provides methods to change the settings of a linked cell range.
  46
  47     @see com::sun::star::sheet::CellAreaLink
  48  */
  49 published interface XAreaLink: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** returns the source of the range within the source document.
  54
  55         <p>This can be the address of a cell or range in the form
  56         "Sheet1.A1:C5", or the name of a named range or database range.</p>
  57      */
  58     string getSourceArea();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** sets the source of the range within the source document.
  63
  64         <p>This can be the address of a cell or range in the form
  65         "Sheet1.A1:C5", or the name of a named range or database range.</p>
  66      */
  67     void setSourceArea( [in] string aSourceArea );
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** returns the position of the linked range in the destination
  72         document.
  73      */
  74     com::sun::star::table::CellRangeAddress getDestArea();
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** sets the position of the linked range in the destination document.
  79      */
  80     void setDestArea( [in] com::sun::star::table::CellRangeAddress aDestArea );
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif
  89