offapi/com/sun/star/sheet/XAreaLinks.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_XAreaLinks_idl__
  21 #define __com_sun_star_sheet_XAreaLinks_idl__
  22
  23 #include <com/sun/star/container/XIndexAccess.idl>
  24 #include <com/sun/star/table/CellAddress.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides access via index to a collection of area links and inserting
  31     and removing area links.
  32
  33     @see com::sun::star::sheet::CellAreaLinks
  34     @see com::sun::star::sheet::CellAreaLink
  35  */
  36 published interface XAreaLinks: com::sun::star::container::XIndexAccess
  37 {
  38
  39     /** creates an area link and adds it to the collection.
  40
  41         @param aDestPos
  42             the address of the first cell of the range inside the current
  43             document.
  44
  45         @param aFileName
  46             the URL of the source document.
  47
  48         @param aSourceArea
  49             the name of the range in the source document.
  50
  51             <p>This can be the address of a cell or range in the form
  52             "Sheet1.A1:C5", or the name of a named range or database range.</p>
  53
  54         @param aFilter
  55             the name of the filter used to load the source document.
  56
  57         @param aFilterOptions
  58             optional filter options for the specified filter.
  59      */
  60     void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos,
  61              [in] string aFileName,
  62              [in] string aSourceArea,
  63              [in] string aFilter,
  64              [in] string aFilterOptions );
  65
  66
  67     /** removes an area link from the collection.
  68      */
  69     void removeByIndex( [in] long nIndex );
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */