offapi/com/sun/star/table/XCell.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 table {
  22
  23
  24 /** provides methods to access the contents of a cell in a table.
  25
  26     @see com::sun::star::table::Cell
  27  */
  28 published interface XCell: com::sun::star::uno::XInterface
  29 {
  30
  31     /** returns the formula string of a cell.
  32
  33         <p>Even if the cell does not contain a formula, an assignment of
  34         this attribute's value to another cell's formula attribute would
  35         create the same cell content. This is because this attribute contains
  36         the original text value of a string cell. The value of a
  37         <em>value cell</em> will be formatted using the number format's
  38         default format or the formula string, including "=", of a formula
  39         cell.</p>
  40      */
  41     string getFormula();
  42
  43
  44     /** sets a formula into the cell.
  45
  46         <p>When assigned, the string will be interpreted and a value, text
  47         or formula cell is created, depending on the text and the number
  48         format.</p>
  49      */
  50     void setFormula( [in] string aFormula );
  51
  52
  53     /** returns the floating point value of the cell.
  54
  55         <p>For a <em>value cell</em> the value is returned, for a
  56         <em>string cell</em> zero is returned and for a <em>formula cell</em>
  57         the result value of a formula is returned.</p>
  58      */
  59     double getValue();
  60
  61
  62     /** sets a floating point value into the cell.
  63
  64         <p>After a call to this method the type of the cell is
  65         CellContentType::VALUE.</p>
  66      */
  67     void setValue( [in] double nValue );
  68
  69
  70     /** returns the type of the cell.
  71      */
  72     com::sun::star::table::CellContentType getType();
  73
  74
  75     /** returns the error value of the cell.
  76
  77         <P>If the cell does not contain a formula, the error is always
  78         zero.</p>
  79      */
  80     long getError();
  81
  82 };
  83
  84
  85 }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */