summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/table/XCell.idl
blob: a4bf1be6b14a1ed2e0b332ede20305a0ca01524f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*************************************************************************
 *
 *  $RCSfile: XCell.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:17:34 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_table_XCell_idl__
#define __com_sun_star_table_XCell_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_table_CellContentType_idl__
#include <com/sun/star/table/CellContentType.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module table {

//=============================================================================

// DocMerge from xml: interface com::sun::star::table::XCell
/** represents a cell in a table.@see service com::sun::star::table::Cell
 */
[ uik(E2281100-33D6-11D1-AABE00A0-249D5590), ident( "XCell", 1.0 ) ]
interface XCell: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR XCell::getFormula

    // DocMerge from xml: method com::sun::star::table::XCell::getFormula
    /** returns the formula of a cell.



        <p>Even if the cell does not contain a formula, an
        assignment of this attribute's value to another cell's
        formula attribute would create the same cell content.
        This is because this attribute contains the original
        text value of a string cell. The value of a <em>value cell</em>
        will be formatted using the number format's default format
        or the formula string, including "=", of a formula
        cell.</p>
     */
    [const] string getFormula();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::table::XCell::setFormula
    /** sets a formula into the cell.



        <p>When assigned, the string will be interpreted and
        a value, text or formula cell is created, depending
        on the text and the number format.</p>
     */
    void setFormula( [in] string aFormula );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::table::XCell::getValue
    /** returns the floating point value of the cell.



        <p>For a <em>value cell</em> the value is returnd, for a
        <em>string cell</em> zero is returned and for a <em>formula cell</em>
        the result value of a formula is returned.</p>
     */
    [const] double getValue();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::table::XCell::setValue
    /** sets a floating point value into the cell.



        <p>After a call to this method the type of the cell is
        <const>CellContentType::VALUE</const>.</p>
     */
    void setValue( [in] double nValue );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::table::XCell::getType
    /** returns the type of the cell.
     */
    [const] com::sun::star::table::CellContentType getType();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::table::XCell::getError
    /** @returns
                the error value of the cell.

                <P>If the cell does not contain a formula, the error
                is always zero.
     */
    [const] long getError();

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.2  2000/10/09 14:25:01  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)

    Revision 1.1.1.1  2000/09/18 23:35:55  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:58  mi
    documentation merged from XML

    Revision 1.3  2000/03/24 13:19:37  nn
    #74032# documentation added

    Revision 1.2  2000/02/07 11:24:59  mi
    zu #70728# missing documentation marked

    Revision 1.1.1.1  1999/11/11 09:48:46  jsc
    new


=============================================================================*/
#endif