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