offapi/com/sun/star/sheet/XAreaLinks.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: XAreaLinks.idl,v $
  10  * $Revision: 1.9 $
  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_XAreaLinks_idl__
  32 #define __com_sun_star_sheet_XAreaLinks_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellAddress_idl__
  39 #include <com/sun/star/table/CellAddress.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides access via index to a collection of area links and inserting
  49     and removing area links.
  50
  51     @see com::sun::star::sheet::CellAreaLinks
  52     @see com::sun::star::sheet::CellAreaLink
  53  */
  54 published interface XAreaLinks: com::sun::star::container::XIndexAccess
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** creates an area link and adds it to the collection.
  59
  60         @param aDestPos
  61             the address of the first cell of the range inside the current
  62             document.
  63
  64         @param aFileName
  65             the URL of the source document.
  66
  67         @param aSourceArea
  68             the name of the range in the source document.
  69
  70             <p>This can be the address of a cell or range in the form
  71             "Sheet1.A1:C5", or the name of a named range or database range.</p>
  72
  73         @param aFilter
  74             the name of the filter used to load the source document.
  75
  76         @param aFilterOptions
  77             optional filter options for the specified filter.
  78      */
  79     void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos,
  80              [in] string aFileName,
  81              [in] string aSourceArea,
  82              [in] string aFilter,
  83              [in] string aFilterOptions );
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** removes an area link from the collection.
  88      */
  89     void removeByIndex( [in] long nIndex );
  90
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif
  98