offapi/com/sun/star/sheet/CellAreaLink.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: CellAreaLink.idl,v $
  10  * $Revision: 1.10 $
  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_CellAreaLink_idl__
  32 #define __com_sun_star_sheet_CellAreaLink_idl__
  33
  34 #ifndef __com_sun_star_sheet_XAreaLink_idl__
  35 #include <com/sun/star/sheet/XAreaLink.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_XRefreshable_idl__
  39 #include <com/sun/star/util/XRefreshable.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module sheet {
  49
  50 //=============================================================================
  51
  52 /** represents a linked cell range.
  53
  54     <p>A linked cell range is a range which is linked to an equal-sized
  55     range in an external document. The contents of the external range is
  56     copied into the range of this document.</p>
  57
  58     @see com::sun::star::sheet::CellAreaLinks
  59  */
  60 published service CellAreaLink
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** provides methods to change the settings of the linked cell range.
  65      */
  66     interface com::sun::star::sheet::XAreaLink;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** provides methods to reload the external data.
  71      */
  72     interface com::sun::star::util::XRefreshable;
  73
  74     //-------------------------------------------------------------------------
  75
  76 //!published service PropertySet
  77     /** provides access to the properties.
  78      */
  79     interface com::sun::star::beans::XPropertySet;
  80
  81      //========================================================================
  82
  83     /** specifies the URL of the source document.
  84      */
  85     [property] string Url;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** specifies the name of the filter used to load the source document.
  90      */
  91     [property] string Filter;
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** specifies the filter options needed to load the source document.
  96      */
  97     [property] string FilterOptions;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** specifies the delay time between two refresh actions in seconds.
 102
 103     @deprecated
 104
 105      */
 106     [property] long RefreshDelay;
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** specifies the time between two refresh actions in seconds.
 111
 112         @since OOo 2.0.0
 113      */
 114     [optional, property] long RefreshPeriod;
 115
 116
 117 };
 118
 119 //=============================================================================
 120
 121 }; }; }; };
 122
 123 #endif
 124