offapi/com/sun/star/sheet/XExternalSheetCache.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: XExternalSheetCache.idl,v $
  10  * $Revision: 1.1.2.5 $
  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_XExternalSheetCache_idl__
  32 #define __com_sun_star_sheet_XExternalSheetCache_idl__
  33
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38 /** Primary interface for the <type scope="com::sun::star::sheet">ExternalSheetCache</type> service.
  39
  40     @see com::sun::star::sheet::ExternalSheetCache
  41
  42     @since OOo 3.1.0
  43  */
  44 interface XExternalSheetCache
  45 {
  46     /** It sets a cached value for a specified cell position.  The value is expected
  47         to be either of type <type>string</type> or of type <type>double</type>.  No
  48         other data types are supported.
  49
  50         @param nRow row position (0-based)
  51         @param nColumn column position (0-based)
  52         @param aValue cell value to be cached
  53      */
  54     void setCellValue( [in] long nColumn, [in] long nRow, [in] any aValue )
  55             raises (com::sun::star::lang::IllegalArgumentException);
  56
  57     /** It retrieves a cached value from a specified cell position.  The cached
  58         value can be either <type>string</type> or <type>double</type>.
  59
  60         @return any cached cell value
  61      */
  62     any getCellValue( [in] long nColumn, [in] long nRow )
  63             raises (com::sun::star::lang::IllegalArgumentException);
  64
  65     /** It returns a list of all row numbers where a cached cell or cells exist.
  66         The row numbers are sorted in ascending order.
  67
  68         @return sequence<long> list of all row numbers with cached cell(s)
  69      */
  70     sequence< long > getAllRows();
  71
  72     /** Given a row number, this method returns a list of all columns numbers
  73         that store cached cell values in that row.  The column numbers are
  74         sorted in ascending order.
  75
  76         @return sequence<long> list of all columns numbers with cached cell values
  77      */
  78     sequence< long > getAllColumns( [in] long nRow )
  79             raises (com::sun::star::lang::IllegalArgumentException);
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** Index corresponding to this instance of an external sheet cache for
  84         usage in formula tokens.
  85
  86         <p>This index to the external sheet cache is expected in the
  87         <member>SingleReference::Sheet</member> member if it is part of an
  88         external reference token.
  89
  90         <p>Each external sheet cache has a unique index value inside the
  91         <type>ExternalDocLink</type> instance.</p>
  92
  93         @see FormulaToken
  94         @see ExternalReference
  95      */
  96     [attribute, readonly] long TokenIndex;
  97
  98 };
  99
 100 }; }; }; };
 101
 102 #endif