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