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