← Back to branch summary

~ubuntu-branches/ubuntu/edgy/koffice/edgy-updates

« back to all changes in this revision

Viewing changes to kspread/extensions/conversion.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ben Burton
  • Date: 2004-05-09 11:33:00 UTC
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040509113300-xi5t1z4yxe7n03x7
Tags: upstream-1.3.1
Import upstream version 1.3.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
kspread/extensions/conversion.xml
 
1
<!DOCTYPE KSpreadFunctions>
 
2
<KSpreadFunctions>
 
3
 
 
4
  <Group>
 
5
    <GroupName>Conversion</GroupName>
 
6
 
 
7
    <Function>
 
8
      <Name>BOOL2STRING</Name>
 
9
      <Type>String</Type>
 
10
      <Parameter>
 
11
        <Comment>Bool value to convert</Comment>
 
12
        <Type range="false">Boolean</Type>
 
13
      </Parameter>
 
14
      <Help>
 
15
        <Text>The BOOL2STRING() function returns a string value for a given boolean value. This method is intended for using a boolean in methods which require a string</Text>
 
16
        <Syntax>BOOL2STRING(value)</Syntax>
 
17
        <Example>BOOL2STRING(true) returns "True"</Example>
 
18
        <Example>BOOL2STRING(false) returns "False"</Example>
 
19
        <Example>upper(BOOL2STRING(find("nan";"banana"))) returns TRUE</Example>
 
20
        <Related>STRING2BOOL</Related>
 
21
      </Help>
 
22
    </Function>
 
23
 
 
24
    <Function>
 
25
      <Name>INT2BOOL</Name>
 
26
      <Type>Boolean</Type>
 
27
      <Parameter>
 
28
        <Comment>Integer value to convert</Comment>
 
29
        <Type range="false">Int</Type>
 
30
      </Parameter>
 
31
      <Help>
 
32
        <Text>The INT2BOOL() function returns a boolean value for a given integer number. This method is intended for using an integer in methods which require a boolean. It only accepts 0 or 1. If any other value is given, false is returned.</Text>
 
33
        <Syntax>INT2BOOL(value)</Syntax>
 
34
        <Example>INT2BOOL(1) returns true</Example>
 
35
        <Example>INT2BOOL(0) returns false</Example>
 
36
        <Example>OR(INT2BOOL(1); false) returns true</Example>
 
37
        <Related>BOOL2INT</Related>
 
38
      </Help>
 
39
    </Function>
 
40
 
 
41
    <Function>
 
42
      <Name>BOOL2INT</Name>
 
43
      <Type>Int</Type>
 
44
      <Parameter>
 
45
        <Comment>Bool value to convert</Comment>
 
46
        <Type range="false">Boolean</Type>
 
47
      </Parameter>
 
48
      <Help>
 
49
        <Text>The BOOL2INT() function returns an integer value for a given boolean value. This method is intended for using a boolean value in methods which require an integer.</Text>
 
50
        <Syntax>BOOL2INT(value)</Syntax>
 
51
        <Example>BOOL2INT(True) returns 1</Example>
 
52
        <Example>BOOL2INT(False) returns 0</Example>
 
53
        <Related>INT2BOOL</Related>
 
54
      </Help>
 
55
    </Function>
 
56
 
 
57
    <Function>
 
58
      <Name>NUM2STRING</Name>
 
59
      <Type>String</Type>
 
60
      <Parameter>
 
61
        <Comment>number to convert into string</Comment>
 
62
        <Type range="false">Float</Type>
 
63
      </Parameter>
 
64
      <Help>
 
65
        <Text>The NUM2STRING() function returns a string value for a given number. This method is intended for using a number in methods which require a string</Text>
 
66
        <Syntax>NUM2STRING(value)</Syntax>
 
67
        <Example>NUM2STRING(10) returns "10"</Example>
 
68
        <Example>NUM2STRING(2.05) returns "2.05"</Example>
 
69
        <Example>=find("101";NUM2STRING(A1)) (A1 = 2.010102) returns True</Example>
 
70
      </Help>
 
71
    </Function>
 
72
 
 
73
    <Function>
 
74
      <Name>CHARTOASCII</Name>
 
75
      <Type>Int</Type>
 
76
      <Parameter>
 
77
        <Comment>A one character string to convert</Comment>
 
78
        <Type>String</Type>
 
79
      </Parameter>
 
80
      <Help>
 
81
        <Text>The CHARTOASCII() function returns the ASCII code for the given character.</Text>
 
82
        <Syntax>CHARTOASCII(value)</Syntax>
 
83
        <Example>CHARTOASCII("v") returns 118</Example>
 
84
        <Example>CHARTOASCII(r) is an error. The character must be in quotes.</Example>
 
85
      </Help>
 
86
    </Function>
 
87
 
 
88
    <Function>
 
89
      <Name>ASCIITOCHAR</Name>
 
90
      <Type>String</Type>
 
91
      <Parameter>
 
92
        <Comment>The ASCII values to convert</Comment>
 
93
        <Type>Int</Type>
 
94
      </Parameter>
 
95
      <Help>
 
96
        <Text>The ASCIITOCHAR() function returns the character for each given ASCII code</Text>
 
97
        <Syntax>ASCIITOCHAR(value)</Syntax>
 
98
        <Example>ASCIITOCHAR(118) returns "v"</Example>
 
99
        <Example>ASCIITOCHAR(75; 68; 69) returns "KDE"</Example>
 
100
      </Help>
 
101
    </Function>
 
102
 
 
103
    <Function>
 
104
      <Name>POLR</Name>
 
105
      <Type>Double</Type>
 
106
      <Parameter>
 
107
        <Comment>Value in X</Comment>
 
108
        <Type>Double</Type>
 
109
      </Parameter>
 
110
      <Parameter>
 
111
        <Comment>Value in Y</Comment>
 
112
        <Type>Double</Type>
 
113
      </Parameter>
 
114
      <Help>
 
115
        <Text>The POLR() function returns the radius corresponding to the position of a point in a cartesian landmark.</Text>
 
116
        <Syntax>POLR(X;Y)</Syntax>
 
117
        <Example>POLR(12;12) returns 16.9705</Example>
 
118
        <Example>POLR(12;0) returns 12</Example>
 
119
        <Related>POLA</Related>
 
120
        <Related>CARX</Related>
 
121
        <Related>CARY</Related>
 
122
      </Help>
 
123
    </Function>
 
124
 
 
125
    <Function>
 
126
      <Name>POLA</Name>
 
127
      <Type>Double</Type>
 
128
      <Parameter>
 
129
        <Comment>Value in X</Comment>
 
130
        <Type>Double</Type>
 
131
      </Parameter>
 
132
      <Parameter>
 
133
        <Comment>Value in Y</Comment>
 
134
        <Type>Double</Type>
 
135
      </Parameter>
 
136
      <Help>
 
137
        <Text>The POLA() function returns the angle (in radians) corresponding to the position of a point in a cartesian landmark.</Text>
 
138
        <Syntax>POLA(X;Y)</Syntax>
 
139
        <Example>POLA(12;12) returns 0.78539816</Example>
 
140
        <Example>POLA(12;0) returns 0</Example>
 
141
            <Example>POLA(0;12) returns 1.5707</Example>
 
142
        <Related>POLR</Related>
 
143
        <Related>CARX</Related>
 
144
        <Related>CARY</Related>
 
145
      </Help>
 
146
    </Function>
 
147
 
 
148
    <Function>
 
149
      <Name>CARX</Name>
 
150
      <Type>Double</Type>
 
151
      <Parameter>
 
152
        <Comment>Radius</Comment>
 
153
        <Type>Double</Type>
 
154
      </Parameter>
 
155
      <Parameter>
 
156
        <Comment>Angle (radians)</Comment>
 
157
        <Type>Double</Type>
 
158
      </Parameter>
 
159
      <Help>
 
160
        <Text>The CARX() function returns the X position corresponding to the position of a point in a polar landmark.</Text>
 
161
        <Syntax>CARX(Radius;Angle)</Syntax>
 
162
        <Example>CARX(12;1.5707) returns 0.00115592</Example>
 
163
        <Example>CARX(12;0) returns 12</Example>
 
164
        <Related>CARY</Related>
 
165
        <Related>POLA</Related>
 
166
        <Related>POLR</Related>
 
167
      </Help>
 
168
    </Function>
 
169
 
 
170
    <Function>
 
171
      <Name>DECSEX</Name>
 
172
      <Type>Double</Type>
 
173
      <Parameter>
 
174
        <Comment>Value</Comment>
 
175
        <Type>Double</Type>
 
176
      </Parameter>
 
177
      <Help>
 
178
        <Text>The DECSEX() function converts a double value to a time value.</Text>
 
179
        <Syntax>DECSEX(double)</Syntax>
 
180
        <Example>DECSEX(1.6668) returns 1:40 </Example>
 
181
        <Example>DECSEX(7.8) returns 7:47</Example>
 
182
      </Help>
 
183
    </Function>
 
184
 
 
185
    <Function>
 
186
      <Name>SEXDEC</Name>
 
187
      <Type>Double</Type>
 
188
      <Parameter>
 
189
        <Comment>Hours</Comment>
 
190
        <Type>Int</Type>
 
191
      </Parameter>
 
192
      <Parameter>
 
193
        <Comment>Minutes</Comment>
 
194
        <Type>Int</Type>
 
195
      </Parameter>
 
196
      <Parameter>
 
197
        <Comment>Seconds</Comment>
 
198
        <Type>Int</Type>
 
199
      </Parameter>
 
200
      <Help>
 
201
        <Text>The SEXDEC() function returns a decimal value. You can also supply a time value.</Text>
 
202
        <Syntax>SEXDEC(time value) or SEXDEC(hours;minutes;seconds)</Syntax>
 
203
        <Example>SEXDEC(1;5;7) returns 1.0852778 </Example>
 
204
        <Example>DECSEX("8:05") returns 8.08333333</Example>
 
205
      </Help>
 
206
    </Function>
 
207
 
 
208
    <Function>
 
209
      <Name>CARY</Name>
 
210
      <Type>Double</Type>
 
211
      <Parameter>
 
212
        <Comment>Radius</Comment>
 
213
        <Type>Double</Type>
 
214
      </Parameter>
 
215
      <Parameter>
 
216
        <Comment>Angle (radians)</Comment>
 
217
        <Type>Double</Type>
 
218
      </Parameter>
 
219
      <Help>
 
220
        <Text>The CARY() function returns the Y position corresponding to the position of a point in a polar landmark.</Text>
 
221
        <Syntax>CARY(Radius;Angle)</Syntax>
 
222
        <Example>CARY(12;1.5707) returns 12</Example>
 
223
        <Example>CARY(12;0) returns 0</Example>
 
224
        <Related>CARX</Related>
 
225
        <Related>POLA</Related>
 
226
        <Related>POLR</Related>
 
227
      </Help>
 
228
    </Function>
 
229
 
 
230
 <Function>
 
231
      <Name>ROMAN</Name>
 
232
      <Type>String</Type>
 
233
      <Parameter>
 
234
        <Comment>Number</Comment>
 
235
        <Type>Int</Type>
 
236
      </Parameter>
 
237
      <Help>
 
238
        <Text>The ROMAN() function returns the number in roman format. Number should be positive and entire.</Text>
 
239
        <Syntax>ROMAN(Number)</Syntax>
 
240
        <Example>ROMAN(99) returns "XCIX"</Example>
 
241
        <Example>ROMAN(-55) returns "Err"</Example>
 
242
        <Related>ARABIC</Related>
 
243
      </Help>
 
244
    </Function>
 
245
 
 
246
    <Function>
 
247
      <Name>ARABIC</Name>
 
248
      <Type>Int</Type>
 
249
      <Parameter>
 
250
        <Comment>Numeral</Comment>
 
251
        <Type>String</Type>
 
252
      </Parameter>
 
253
      <Help>
 
254
        <Text>The ARABIC() function converts a roman numeral into a number.</Text>
 
255
        <Syntax>ARABIC(Numeral)</Syntax>
 
256
        <Example>ARABIC("IV") returns 4</Example>
 
257
        <Example>ARABIC("XCIX") returns 99</Example>
 
258
        <Related>ROMAN</Related>
 
259
      </Help>
 
260
    </Function>
 
261
 
 
262
  </Group>
 
263
 
 
264
</KSpreadFunctions>