libstaroffice-doc 0.0.5-1 / usr / share / doc / libstaroffice / html / classSTOFFDocument.html

This file is indexed.

/usr/share/doc/libstaroffice/html/classSTOFFDocument.html is in libstaroffice-doc 0.0.5-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>STOFFDocument Class Reference documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classSTOFFDocument.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classSTOFFDocument-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">STOFFDocument Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class provides all the functions an application would need to parse StarOffice documents.  
 <a href="classSTOFFDocument.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="STOFFDocument_8hxx_source.html">STOFFDocument.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:adaca10c91a76dd03bed483f5ad91e52c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52c">Confidence</a> { <a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52ca072e2de49191b98a64e7a0448f196bd4">STOFF_C_NONE</a> =0, 
<a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52cabc2d1db9afe2b6d9fc14a615803a0605">STOFF_C_UNSUPPORTED_ENCRYPTION</a>, 
<a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52ca4f80a701dfbaff2c823a5bf094247995">STOFF_C_SUPPORTED_ENCRYPTION</a>, 
<a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52cad960a6b547064948a3c55c90af49b0c8">STOFF_C_EXCELLENT</a>
 }<tr class="memdesc:adaca10c91a76dd03bed483f5ad91e52c"><td class="mdescLeft">&#160;</td><td class="mdescRight">an enum which defines if we have confidence that a file is supported  <a href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52c">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:adaca10c91a76dd03bed483f5ad91e52c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bb6791a5a9bbcd698b8e2473961ba8d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8d">Kind</a> { <br />
&#160;&#160;<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8da8ef50df6dc0c1c8d2cbd573ee90cf911">STOFF_K_UNKNOWN</a> =0, 
<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8da85863d9c7d07ddb357a4e1321b9ec829">STOFF_K_BITMAP</a>, 
<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8da0925a5fb1d8a429367a358ae8c53b8d2">STOFF_K_CHART</a>, 
<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8da206ddc427f2715344dcafde44403e4d5">STOFF_K_DATABASE</a>, 
<br />
&#160;&#160;<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8daa37ffa1a454d609f71227dca45a6e64e">STOFF_K_DRAW</a>, 
<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8dacde80f4deaaed91eee5930f42e5271ff">STOFF_K_MATH</a>, 
<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8dacccba504e12d639d788c00f3c04131fe">STOFF_K_PRESENTATION</a>, 
<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8daf1e8d138cfd5a55620025c17313b069a">STOFF_K_SPREADSHEET</a>, 
<br />
&#160;&#160;<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8dabf8b2ecc0f301684dbcdba54f6da2866">STOFF_K_TEXT</a>, 
<a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8da4917fb7a99f9f4696da3d5a3a88b2ab8">STOFF_K_GRAPHIC</a>
<br />
 }<tr class="memdesc:a3bb6791a5a9bbcd698b8e2473961ba8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">an enum to define the kind of document  <a href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8d">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a3bb6791a5a9bbcd698b8e2473961ba8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd7ccfe6d8d926f791fa34147152a866"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">Result</a> { <br />
&#160;&#160;<a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866a71880a3148c24098ed83f9c5c7eebd5c">STOFF_R_OK</a> =0, 
<a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866a6413c5d280255baba989c14aad282c61">STOFF_R_FILE_ACCESS_ERROR</a>, 
<a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866a6e9f4cceefbfd4fbebf29b127aabe68b">STOFF_R_OLE_ERROR</a>, 
<a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866a9e407c111cfba8adcc6957ec8b9aca8c">STOFF_R_PARSE_ERROR</a>, 
<br />
&#160;&#160;<a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866ab3b98e8fc84abce3f66524668f03604c">STOFF_R_PASSWORD_MISSMATCH_ERROR</a>, 
<a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866ac045df479c85019a34b21b1a780a7e1f">STOFF_R_UNKNOWN_ERROR</a>
<br />
 }<tr class="memdesc:acd7ccfe6d8d926f791fa34147152a866"><td class="mdescLeft">&#160;</td><td class="mdescRight">an enum which defines the result of the file parsing  <a href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:acd7ccfe6d8d926f791fa34147152a866"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab073299f5ac377b131dcf8cad62e3252"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> <a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52c">Confidence</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#ab073299f5ac377b131dcf8cad62e3252">isFileFormatSupported</a> (librevenge::RVNGInputStream *input, <a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8d">Kind</a> &amp;kind)</td></tr>
<tr class="memdesc:ab073299f5ac377b131dcf8cad62e3252"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analyzes the content of an input stream to see if it can be parsed.  <a href="#ab073299f5ac377b131dcf8cad62e3252">More...</a><br /></td></tr>
<tr class="separator:ab073299f5ac377b131dcf8cad62e3252"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80a653b27031e22981522dd19a48a724"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> <a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#a80a653b27031e22981522dd19a48a724">parse</a> (librevenge::RVNGInputStream *input, librevenge::RVNGTextInterface *documentInterface, char const *password=nullptr)</td></tr>
<tr class="memdesc:a80a653b27031e22981522dd19a48a724"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the input stream content.  <a href="#a80a653b27031e22981522dd19a48a724">More...</a><br /></td></tr>
<tr class="separator:a80a653b27031e22981522dd19a48a724"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb39272b2566692f5aa9903ac9e00e5d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> <a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#afb39272b2566692f5aa9903ac9e00e5d">parse</a> (librevenge::RVNGInputStream *input, librevenge::RVNGDrawingInterface *documentInterface, char const *password=nullptr)</td></tr>
<tr class="memdesc:afb39272b2566692f5aa9903ac9e00e5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the input stream content.  <a href="#afb39272b2566692f5aa9903ac9e00e5d">More...</a><br /></td></tr>
<tr class="separator:afb39272b2566692f5aa9903ac9e00e5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc41357907fd9ea2332bdb7d06ee019"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> <a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#a4bc41357907fd9ea2332bdb7d06ee019">parse</a> (librevenge::RVNGInputStream *input, librevenge::RVNGPresentationInterface *documentInterface, char const *password=nullptr)</td></tr>
<tr class="memdesc:a4bc41357907fd9ea2332bdb7d06ee019"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the input stream content.  <a href="#a4bc41357907fd9ea2332bdb7d06ee019">More...</a><br /></td></tr>
<tr class="separator:a4bc41357907fd9ea2332bdb7d06ee019"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a036e07ae8b605daa62a36a6e1e694374"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> <a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#a036e07ae8b605daa62a36a6e1e694374">parse</a> (librevenge::RVNGInputStream *input, librevenge::RVNGSpreadsheetInterface *documentInterface, char const *password=nullptr)</td></tr>
<tr class="memdesc:a036e07ae8b605daa62a36a6e1e694374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the input stream content.  <a href="#a036e07ae8b605daa62a36a6e1e694374">More...</a><br /></td></tr>
<tr class="separator:a036e07ae8b605daa62a36a6e1e694374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab98251814eb7c2f6fefcdb02cf188b32"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#ab98251814eb7c2f6fefcdb02cf188b32">decodeGraphic</a> (librevenge::RVNGBinaryData const &amp;binary, librevenge::RVNGDrawingInterface *documentInterface)</td></tr>
<tr class="memdesc:ab98251814eb7c2f6fefcdb02cf188b32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the graphic contained in the binary data and called documentInterface to reconstruct a graphic.  <a href="#ab98251814eb7c2f6fefcdb02cf188b32">More...</a><br /></td></tr>
<tr class="separator:ab98251814eb7c2f6fefcdb02cf188b32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f07a48f9c5912522f4a161e09ef3f39"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#a5f07a48f9c5912522f4a161e09ef3f39">decodeSpreadsheet</a> (librevenge::RVNGBinaryData const &amp;binary, librevenge::RVNGSpreadsheetInterface *documentInterface)</td></tr>
<tr class="memdesc:a5f07a48f9c5912522f4a161e09ef3f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the spreadsheet contained in the binary data and called documentInterface to reconstruct a spreadsheet.  <a href="#a5f07a48f9c5912522f4a161e09ef3f39">More...</a><br /></td></tr>
<tr class="separator:a5f07a48f9c5912522f4a161e09ef3f39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b5047cfe6a15434a8f236aa544380c6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="STOFFDocument_8hxx.html#a9994086050c2b8b8ec671ef852472c6a">STOFFLIB</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSTOFFDocument.html#a1b5047cfe6a15434a8f236aa544380c6">decodeText</a> (librevenge::RVNGBinaryData const &amp;binary, librevenge::RVNGTextInterface *documentInterface)</td></tr>
<tr class="memdesc:a1b5047cfe6a15434a8f236aa544380c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the text contained in the binary data and called documentInterface to reconstruct a text.  <a href="#a1b5047cfe6a15434a8f236aa544380c6">More...</a><br /></td></tr>
<tr class="separator:a1b5047cfe6a15434a8f236aa544380c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides all the functions an application would need to parse StarOffice documents. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="adaca10c91a76dd03bed483f5ad91e52c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adaca10c91a76dd03bed483f5ad91e52c">&#9670;&nbsp;</a></span>Confidence</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52c">STOFFDocument::Confidence</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>an enum which defines if we have confidence that a file is supported </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adaca10c91a76dd03bed483f5ad91e52ca072e2de49191b98a64e7a0448f196bd4"></a>STOFF_C_NONE&#160;</td><td class="fielddoc"><p>not supported </p>
</td></tr>
<tr><td class="fieldname"><a id="adaca10c91a76dd03bed483f5ad91e52cabc2d1db9afe2b6d9fc14a615803a0605"></a>STOFF_C_UNSUPPORTED_ENCRYPTION&#160;</td><td class="fielddoc"><p>encryption not supported </p>
</td></tr>
<tr><td class="fieldname"><a id="adaca10c91a76dd03bed483f5ad91e52ca4f80a701dfbaff2c823a5bf094247995"></a>STOFF_C_SUPPORTED_ENCRYPTION&#160;</td><td class="fielddoc"><p>encryption supported </p>
</td></tr>
<tr><td class="fieldname"><a id="adaca10c91a76dd03bed483f5ad91e52cad960a6b547064948a3c55c90af49b0c8"></a>STOFF_C_EXCELLENT&#160;</td><td class="fielddoc"><p>supported </p>
</td></tr>
</table>

</div>
</div>
<a id="a3bb6791a5a9bbcd698b8e2473961ba8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bb6791a5a9bbcd698b8e2473961ba8d">&#9670;&nbsp;</a></span>Kind</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8d">STOFFDocument::Kind</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>an enum to define the kind of document </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8da8ef50df6dc0c1c8d2cbd573ee90cf911"></a>STOFF_K_UNKNOWN&#160;</td><td class="fielddoc"><p>unknown </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8da85863d9c7d07ddb357a4e1321b9ec829"></a>STOFF_K_BITMAP&#160;</td><td class="fielddoc"><p>bitmap/image </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8da0925a5fb1d8a429367a358ae8c53b8d2"></a>STOFF_K_CHART&#160;</td><td class="fielddoc"><p>chart </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8da206ddc427f2715344dcafde44403e4d5"></a>STOFF_K_DATABASE&#160;</td><td class="fielddoc"><p>database </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8daa37ffa1a454d609f71227dca45a6e64e"></a>STOFF_K_DRAW&#160;</td><td class="fielddoc"><p>vectorized graphic: .sda </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8dacde80f4deaaed91eee5930f42e5271ff"></a>STOFF_K_MATH&#160;</td><td class="fielddoc"><p>math </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8dacccba504e12d639d788c00f3c04131fe"></a>STOFF_K_PRESENTATION&#160;</td><td class="fielddoc"><p>presentation </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8daf1e8d138cfd5a55620025c17313b069a"></a>STOFF_K_SPREADSHEET&#160;</td><td class="fielddoc"><p>spreadsheet: .sdc </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8dabf8b2ecc0f301684dbcdba54f6da2866"></a>STOFF_K_TEXT&#160;</td><td class="fielddoc"><p>word processing file </p>
</td></tr>
<tr><td class="fieldname"><a id="a3bb6791a5a9bbcd698b8e2473961ba8da4917fb7a99f9f4696da3d5a3a88b2ab8"></a>STOFF_K_GRAPHIC&#160;</td><td class="fielddoc"><p>gallery graphic: .sdg </p>
</td></tr>
</table>

</div>
</div>
<a id="acd7ccfe6d8d926f791fa34147152a866"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd7ccfe6d8d926f791fa34147152a866">&#9670;&nbsp;</a></span>Result</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">STOFFDocument::Result</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>an enum which defines the result of the file parsing </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acd7ccfe6d8d926f791fa34147152a866a71880a3148c24098ed83f9c5c7eebd5c"></a>STOFF_R_OK&#160;</td><td class="fielddoc"><p>conversion ok </p>
</td></tr>
<tr><td class="fieldname"><a id="acd7ccfe6d8d926f791fa34147152a866a6413c5d280255baba989c14aad282c61"></a>STOFF_R_FILE_ACCESS_ERROR&#160;</td><td class="fielddoc"><p>problem when accessing file </p>
</td></tr>
<tr><td class="fieldname"><a id="acd7ccfe6d8d926f791fa34147152a866a6e9f4cceefbfd4fbebf29b127aabe68b"></a>STOFF_R_OLE_ERROR&#160;</td><td class="fielddoc"><p>problem when reading the OLE structure </p>
</td></tr>
<tr><td class="fieldname"><a id="acd7ccfe6d8d926f791fa34147152a866a9e407c111cfba8adcc6957ec8b9aca8c"></a>STOFF_R_PARSE_ERROR&#160;</td><td class="fielddoc"><p>problem when parsing the file </p>
</td></tr>
<tr><td class="fieldname"><a id="acd7ccfe6d8d926f791fa34147152a866ab3b98e8fc84abce3f66524668f03604c"></a>STOFF_R_PASSWORD_MISSMATCH_ERROR&#160;</td><td class="fielddoc"><p>problem when using the given password </p>
</td></tr>
<tr><td class="fieldname"><a id="acd7ccfe6d8d926f791fa34147152a866ac045df479c85019a34b21b1a780a7e1f"></a>STOFF_R_UNKNOWN_ERROR&#160;</td><td class="fielddoc"><p>unknown error </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab98251814eb7c2f6fefcdb02cf188b32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab98251814eb7c2f6fefcdb02cf188b32">&#9670;&nbsp;</a></span>decodeGraphic()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool STOFFDocument::decodeGraphic </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGBinaryData const &amp;&#160;</td>
          <td class="paramname"><em>binary</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">librevenge::RVNGDrawingInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parses the graphic contained in the binary data and called documentInterface to reconstruct a graphic. </p>
<p>The input is normally send to a librevenge::RVNGXXXInterface with mimeType="image/stoff-odg", ie. it must correspond to a picture created by the <a class="el" href="classSTOFFGraphicEncoder.html" title="main class used to define store librevenge::RVNGDrawingInterface lists of command in a librevenge::RV...">STOFFGraphicEncoder</a> class via a STOFFPropertyEncoder.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">binary</td><td>a list of librevenge::RVNGDrawingInterface stored in a documentInterface, </td></tr>
    <tr><td class="paramname">documentInterface</td><td>the RVNGDrawingInterface which will convert the graphic is some specific format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Reserved for future use. Actually, it only returns false. </dd></dl>

</div>
</div>
<a id="a5f07a48f9c5912522f4a161e09ef3f39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f07a48f9c5912522f4a161e09ef3f39">&#9670;&nbsp;</a></span>decodeSpreadsheet()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool STOFFDocument::decodeSpreadsheet </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGBinaryData const &amp;&#160;</td>
          <td class="paramname"><em>binary</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">librevenge::RVNGSpreadsheetInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parses the spreadsheet contained in the binary data and called documentInterface to reconstruct a spreadsheet. </p>
<p>The input is normally send to a librevenge::RVNGXXXInterface with mimeType="image/stoff-ods", ie. it must correspond to a spreadsheet created by the STOFFSpreadsheetInterface class via a STOFFPropertyEncoder.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">binary</td><td>a list of librevenge::RVNGSpreadsheetInterface stored in a documentInterface, </td></tr>
    <tr><td class="paramname">documentInterface</td><td>the RVNGSpreadsheetInterface which will convert the spreadsheet is some specific format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Reserved for future use. Actually, it only returns false. </dd></dl>

</div>
</div>
<a id="a1b5047cfe6a15434a8f236aa544380c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b5047cfe6a15434a8f236aa544380c6">&#9670;&nbsp;</a></span>decodeText()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool STOFFDocument::decodeText </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGBinaryData const &amp;&#160;</td>
          <td class="paramname"><em>binary</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">librevenge::RVNGTextInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parses the text contained in the binary data and called documentInterface to reconstruct a text. </p>
<p>The input is normally send to a librevenge::RVNGXXXInterface with mimeType="image/stoff-odt", ie. it must correspond to a text created by the STOFFTextInterface class via a STOFFPropertyEncoder.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">binary</td><td>a list of librevenge::RVNGTextInterface stored in a documentInterface, </td></tr>
    <tr><td class="paramname">documentInterface</td><td>the RVNGTextInterface which will convert the text is some specific format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Reserved for future use. Actually, it only returns false. </dd></dl>

</div>
</div>
<a id="ab073299f5ac377b131dcf8cad62e3252"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab073299f5ac377b131dcf8cad62e3252">&#9670;&nbsp;</a></span>isFileFormatSupported()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSTOFFDocument.html#adaca10c91a76dd03bed483f5ad91e52c">STOFFDocument::Confidence</a> STOFFDocument::isFileFormatSupported </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGInputStream *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classSTOFFDocument.html#a3bb6791a5a9bbcd698b8e2473961ba8d">Kind</a> &amp;&#160;</td>
          <td class="paramname"><em>kind</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Analyzes the content of an input stream to see if it can be parsed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>The input stream </td></tr>
    <tr><td class="paramname">kind</td><td>The document kind ( filled if the file is supported ) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A confidence value which represents the likelyhood that the content from the input stream can be parsed </dd></dl>

</div>
</div>
<a id="a80a653b27031e22981522dd19a48a724"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80a653b27031e22981522dd19a48a724">&#9670;&nbsp;</a></span>parse() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">STOFFDocument::Result</a> STOFFDocument::parse </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGInputStream *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">librevenge::RVNGTextInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char const *&#160;</td>
          <td class="paramname"><em>password</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parses the input stream content. </p>
<p>It will make callbacks to the functions provided by a librevenge::RVNGTextInterface class implementation when needed. This is often commonly called the 'main parsing routine'. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>The input stream </td></tr>
    <tr><td class="paramname">documentInterface</td><td>A RVNGTextInterface implementation </td></tr>
    <tr><td class="paramname">password</td><td>The file password</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Reserved for future use. Actually, it only returns false </dd></dl>

</div>
</div>
<a id="afb39272b2566692f5aa9903ac9e00e5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb39272b2566692f5aa9903ac9e00e5d">&#9670;&nbsp;</a></span>parse() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">STOFFDocument::Result</a> STOFFDocument::parse </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGInputStream *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">librevenge::RVNGDrawingInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char const *&#160;</td>
          <td class="paramname"><em>password</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parses the input stream content. </p>
<p>It will make callbacks to the functions provided by a librevenge::RVNGDrawingInterface class implementation when needed. This is often commonly called the 'main parsing routine'. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>The input stream </td></tr>
    <tr><td class="paramname">documentInterface</td><td>A RVNGDrawingInterface implementation </td></tr>
    <tr><td class="paramname">password</td><td>The file password</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Reserved for future use. Actually, it only returns false. </dd></dl>

</div>
</div>
<a id="a4bc41357907fd9ea2332bdb7d06ee019"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bc41357907fd9ea2332bdb7d06ee019">&#9670;&nbsp;</a></span>parse() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">STOFFDocument::Result</a> STOFFDocument::parse </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGInputStream *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">librevenge::RVNGPresentationInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char const *&#160;</td>
          <td class="paramname"><em>password</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parses the input stream content. </p>
<p>It will make callbacks to the functions provided by a librevenge::RVNGPresentationInterface class implementation when needed. This is often commonly called the 'main parsing routine'. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>The input stream </td></tr>
    <tr><td class="paramname">documentInterface</td><td>A RVNGPresentationInterface implementation </td></tr>
    <tr><td class="paramname">password</td><td>The file password</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Reserved for future use. Actually, it only returns false. </dd></dl>

</div>
</div>
<a id="a036e07ae8b605daa62a36a6e1e694374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a036e07ae8b605daa62a36a6e1e694374">&#9670;&nbsp;</a></span>parse() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSTOFFDocument.html#acd7ccfe6d8d926f791fa34147152a866">STOFFDocument::Result</a> STOFFDocument::parse </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGInputStream *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">librevenge::RVNGSpreadsheetInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char const *&#160;</td>
          <td class="paramname"><em>password</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parses the input stream content. </p>
<p>It will make callbacks to the functions provided by a librevenge::RVNGSpreadsheetInterface class implementation when needed. This is often commonly called the 'main parsing routine'. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>The input stream </td></tr>
    <tr><td class="paramname">documentInterface</td><td>A RVNGSpreadsheetInterface implementation </td></tr>
    <tr><td class="paramname">password</td><td>The file password</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Can only convert some basic documents: retrieving more cells' contents but no formating. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="STOFFDocument_8hxx_source.html">STOFFDocument.hxx</a></li>
<li><a class="el" href="STOFFDocument_8cxx.html">STOFFDocument.cxx</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<hr size="1"><address style="align: right;"><small>
Generated on Wed Nov 8 2017 17:52:38 for libstaroffice by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.8.13</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.