offapi/com/sun/star/sheet/CellAreaLink.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_CellAreaLink_idl__
  21 #define __com_sun_star_sheet_CellAreaLink_idl__
  22
  23 #include <com/sun/star/sheet/XAreaLink.idl>
  24 #include <com/sun/star/util/XRefreshable.idl>
  25 #include <com/sun/star/beans/XPropertySet.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** represents a linked cell range.
  32
  33     <p>A linked cell range is a range which is linked to an equal-sized
  34     range in an external document. The contents of the external range is
  35     copied into the range of this document.</p>
  36
  37     @see com::sun::star::sheet::CellAreaLinks
  38  */
  39 published service CellAreaLink
  40 {
  41
  42     /** provides methods to change the settings of the linked cell range.
  43      */
  44     interface com::sun::star::sheet::XAreaLink;
  45
  46
  47     /** provides methods to reload the external data.
  48      */
  49     interface com::sun::star::util::XRefreshable;
  50
  51
  52 //!published service PropertySet
  53     /** provides access to the properties.
  54      */
  55     interface com::sun::star::beans::XPropertySet;
  56
  57
  58     /** specifies the URL of the source document.
  59      */
  60     [property] string Url;
  61
  62
  63     /** specifies the name of the filter used to load the source document.
  64      */
  65     [property] string Filter;
  66
  67
  68     /** specifies the filter options needed to load the source document.
  69      */
  70     [property] string FilterOptions;
  71
  72
  73     /** specifies the delay time between two refresh actions in seconds.
  74
  75     @deprecated
  76
  77      */
  78     [property] long RefreshDelay;
  79
  80
  81     /** specifies the time between two refresh actions in seconds.
  82
  83         @since OOo 2.0
  84      */
  85     [optional, property] long RefreshPeriod;
  86
  87
  88 };
  89
  90
  91 }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */