← Back to branch summary

~ubuntu-branches/ubuntu/precise/ipe/precise

« back to all changes in this revision

Viewing changes to doc/class_ipe_stream.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2004-06-08 00:44:02 UTC
  • Revision ID: james.westby@ubuntu.com-20040608004402-72yu51xlh7vt6p9m
Tags: upstream-6.0pre16
Import upstream version 6.0pre16

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/class_ipe_stream.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>Ipelib: IpeStream class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
</head><body>
 
6
<!-- Generated by Doxygen 1.3.4 -->
 
7
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
 
8
<h1>IpeStream Class Reference<br>
 
9
<small>
 
10
[<a class="el" href="group__base.html">Ipe Base</a>]</small>
 
11
</h1>Abstract base class for output streams.  
 
12
<a href="#_details">More...</a>
 
13
<p>
 
14
Inherited by <a class="el" href="class_ipe_file_stream.html">IpeFileStream</a>, and <a class="el" href="class_ipe_string_stream.html">IpeStringStream</a>.
 
15
<p>
 
16
<a href="class_ipe_stream-members.html">List of all members.</a><h2>Public Member Functions</h2>
 
17
<ul>
 
18
<li>virtual <a class="el" href="class_ipe_stream.html#a0">~IpeStream</a> ()
 
19
<li>virtual void <a class="el" href="class_ipe_stream.html#a1">PutChar</a> (char ch)=0
 
20
<li>virtual void <a class="el" href="class_ipe_stream.html#a2">PutString</a> (<a class="el" href="class_ipe_string.html">IpeString</a> s)=0
 
21
<li>virtual void <a class="el" href="class_ipe_stream.html#a3">PutCString</a> (const  char *s)=0
 
22
<li>virtual void <a class="el" href="class_ipe_stream.html#a4">PutRaw</a> (const  char *data, int size)=0
 
23
<li><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp; <a class="el" href="class_ipe_stream.html#a5">operator&lt;&lt;</a> (char ch)
 
24
<li><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp; <a class="el" href="class_ipe_stream.html#a6">operator&lt;&lt;</a> (const  <a class="el" href="class_ipe_string.html">IpeString</a> &amp;s)
 
25
<li><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp; <a class="el" href="class_ipe_stream.html#a7">operator&lt;&lt;</a> (const  char *s)
 
26
<li><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp; <a class="el" href="class_ipe_stream.html#a8">operator&lt;&lt;</a> (int i)
 
27
<li><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp; <a class="el" href="class_ipe_stream.html#a9">operator&lt;&lt;</a> (double d)
 
28
<li>void <a class="el" href="class_ipe_stream.html#a10">PutHexByte</a> (char b)
 
29
<li>void <a class="el" href="class_ipe_stream.html#a11">PutXmlString</a> (<a class="el" href="class_ipe_string.html">IpeString</a> s)
 
30
</ul>
 
31
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
32
Abstract base class for output streams. 
 
33
<p>
 
34
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
35
<a class="anchor" name="a0" doxytag="IpeStream::~IpeStream" ></a><p>
 
36
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
37
  <tr>
 
38
    <td class="mdRow">
 
39
      <table cellpadding="0" cellspacing="0" border="0">
 
40
        <tr>
 
41
          <td class="md" nowrap valign="top"> IpeStream::~<a class="el" href="class_ipe_stream.html">IpeStream</a> </td>
 
42
          <td class="md" valign="top">(&nbsp;</td>
 
43
          <td class="mdname1" valign="top" nowrap>          </td>
 
44
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
45
          <td class="md" nowrap><code> [virtual]</code></td>
 
46
        </tr>
 
47
 
 
48
      </table>
 
49
    </td>
 
50
  </tr>
 
51
</table>
 
52
<table cellspacing=5 cellpadding=0 border=0>
 
53
  <tr>
 
54
    <td>
 
55
      &nbsp;
 
56
    </td>
 
57
    <td>
 
58
 
 
59
<p>
 
60
Virtual destructor, so you can delete using a pointer to IpeStream. 
 
61
<p>
 
62
    </td>
 
63
  </tr>
 
64
</table>
 
65
<hr><h2>Member Function Documentation</h2>
 
66
<a class="anchor" name="a1" doxytag="IpeStream::PutChar" ></a><p>
 
67
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
68
  <tr>
 
69
    <td class="mdRow">
 
70
      <table cellpadding="0" cellspacing="0" border="0">
 
71
        <tr>
 
72
          <td class="md" nowrap valign="top"> virtual void IpeStream::PutChar </td>
 
73
          <td class="md" valign="top">(&nbsp;</td>
 
74
          <td class="md" nowrap valign="top">char&nbsp;</td>
 
75
          <td class="mdname1" valign="top" nowrap> <em>ch</em>          </td>
 
76
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
77
          <td class="md" nowrap><code> [pure virtual]</code></td>
 
78
        </tr>
 
79
 
 
80
      </table>
 
81
    </td>
 
82
  </tr>
 
83
</table>
 
84
<table cellspacing=5 cellpadding=0 border=0>
 
85
  <tr>
 
86
    <td>
 
87
      &nbsp;
 
88
    </td>
 
89
    <td>
 
90
 
 
91
<p>
 
92
Output character. 
 
93
<p>
 
94
 
 
95
<p>
 
96
Implemented in <a class="el" href="class_ipe_string_stream.html#a1">IpeStringStream</a>, and <a class="el" href="class_ipe_file_stream.html#a1">IpeFileStream</a>.    </td>
 
97
  </tr>
 
98
</table>
 
99
<a class="anchor" name="a2" doxytag="IpeStream::PutString" ></a><p>
 
100
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
101
  <tr>
 
102
    <td class="mdRow">
 
103
      <table cellpadding="0" cellspacing="0" border="0">
 
104
        <tr>
 
105
          <td class="md" nowrap valign="top"> virtual void IpeStream::PutString </td>
 
106
          <td class="md" valign="top">(&nbsp;</td>
 
107
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
 
108
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
 
109
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
110
          <td class="md" nowrap><code> [pure virtual]</code></td>
 
111
        </tr>
 
112
 
 
113
      </table>
 
114
    </td>
 
115
  </tr>
 
116
</table>
 
117
<table cellspacing=5 cellpadding=0 border=0>
 
118
  <tr>
 
119
    <td>
 
120
      &nbsp;
 
121
    </td>
 
122
    <td>
 
123
 
 
124
<p>
 
125
Output string. 
 
126
<p>
 
127
 
 
128
<p>
 
129
Implemented in <a class="el" href="class_ipe_string_stream.html#a2">IpeStringStream</a>, and <a class="el" href="class_ipe_file_stream.html#a2">IpeFileStream</a>.    </td>
 
130
  </tr>
 
131
</table>
 
132
<a class="anchor" name="a3" doxytag="IpeStream::PutCString" ></a><p>
 
133
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
134
  <tr>
 
135
    <td class="mdRow">
 
136
      <table cellpadding="0" cellspacing="0" border="0">
 
137
        <tr>
 
138
          <td class="md" nowrap valign="top"> virtual void IpeStream::PutCString </td>
 
139
          <td class="md" valign="top">(&nbsp;</td>
 
140
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
 
141
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
 
142
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
143
          <td class="md" nowrap><code> [pure virtual]</code></td>
 
144
        </tr>
 
145
 
 
146
      </table>
 
147
    </td>
 
148
  </tr>
 
149
</table>
 
150
<table cellspacing=5 cellpadding=0 border=0>
 
151
  <tr>
 
152
    <td>
 
153
      &nbsp;
 
154
    </td>
 
155
    <td>
 
156
 
 
157
<p>
 
158
Output C string. 
 
159
<p>
 
160
 
 
161
<p>
 
162
Implemented in <a class="el" href="class_ipe_string_stream.html#a3">IpeStringStream</a>, and <a class="el" href="class_ipe_file_stream.html#a3">IpeFileStream</a>.    </td>
 
163
  </tr>
 
164
</table>
 
165
<a class="anchor" name="a4" doxytag="IpeStream::PutRaw" ></a><p>
 
166
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
167
  <tr>
 
168
    <td class="mdRow">
 
169
      <table cellpadding="0" cellspacing="0" border="0">
 
170
        <tr>
 
171
          <td class="md" nowrap valign="top"> virtual void IpeStream::PutRaw </td>
 
172
          <td class="md" valign="top">(&nbsp;</td>
 
173
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
 
174
          <td class="mdname" nowrap> <em>data</em>, </td>
 
175
        </tr>
 
176
        <tr>
 
177
          <td></td>
 
178
          <td></td>
 
179
          <td class="md" nowrap>int&nbsp;</td>
 
180
          <td class="mdname" nowrap> <em>size</em></td>
 
181
        </tr>
 
182
        <tr>
 
183
          <td></td>
 
184
          <td class="md">)&nbsp;</td>
 
185
          <td class="md" colspan="2"><code> [pure virtual]</code></td>
 
186
        </tr>
 
187
 
 
188
      </table>
 
189
    </td>
 
190
  </tr>
 
191
</table>
 
192
<table cellspacing=5 cellpadding=0 border=0>
 
193
  <tr>
 
194
    <td>
 
195
      &nbsp;
 
196
    </td>
 
197
    <td>
 
198
 
 
199
<p>
 
200
Output raw character data. 
 
201
<p>
 
202
 
 
203
<p>
 
204
Implemented in <a class="el" href="class_ipe_string_stream.html#a4">IpeStringStream</a>, and <a class="el" href="class_ipe_file_stream.html#a4">IpeFileStream</a>.    </td>
 
205
  </tr>
 
206
</table>
 
207
<a class="anchor" name="a5" doxytag="IpeStream::operator<<" ></a><p>
 
208
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
209
  <tr>
 
210
    <td class="mdRow">
 
211
      <table cellpadding="0" cellspacing="0" border="0">
 
212
        <tr>
 
213
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_stream.html">IpeStream</a>&amp; IpeStream::operator&lt;&lt; </td>
 
214
          <td class="md" valign="top">(&nbsp;</td>
 
215
          <td class="md" nowrap valign="top">char&nbsp;</td>
 
216
          <td class="mdname1" valign="top" nowrap> <em>ch</em>          </td>
 
217
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
218
          <td class="md" nowrap><code> [inline]</code></td>
 
219
        </tr>
 
220
 
 
221
      </table>
 
222
    </td>
 
223
  </tr>
 
224
</table>
 
225
<table cellspacing=5 cellpadding=0 border=0>
 
226
  <tr>
 
227
    <td>
 
228
      &nbsp;
 
229
    </td>
 
230
    <td>
 
231
 
 
232
<p>
 
233
Output character. 
 
234
<p>
 
235
    </td>
 
236
  </tr>
 
237
</table>
 
238
<a class="anchor" name="a6" doxytag="IpeStream::operator<<" ></a><p>
 
239
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
240
  <tr>
 
241
    <td class="mdRow">
 
242
      <table cellpadding="0" cellspacing="0" border="0">
 
243
        <tr>
 
244
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_stream.html">IpeStream</a>&amp; IpeStream::operator&lt;&lt; </td>
 
245
          <td class="md" valign="top">(&nbsp;</td>
 
246
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_string.html">IpeString</a> &amp;&nbsp;</td>
 
247
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
 
248
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
249
          <td class="md" nowrap><code> [inline]</code></td>
 
250
        </tr>
 
251
 
 
252
      </table>
 
253
    </td>
 
254
  </tr>
 
255
</table>
 
256
<table cellspacing=5 cellpadding=0 border=0>
 
257
  <tr>
 
258
    <td>
 
259
      &nbsp;
 
260
    </td>
 
261
    <td>
 
262
 
 
263
<p>
 
264
Output string. 
 
265
<p>
 
266
    </td>
 
267
  </tr>
 
268
</table>
 
269
<a class="anchor" name="a7" doxytag="IpeStream::operator<<" ></a><p>
 
270
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
271
  <tr>
 
272
    <td class="mdRow">
 
273
      <table cellpadding="0" cellspacing="0" border="0">
 
274
        <tr>
 
275
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_stream.html">IpeStream</a>&amp; IpeStream::operator&lt;&lt; </td>
 
276
          <td class="md" valign="top">(&nbsp;</td>
 
277
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
 
278
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
 
279
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
280
          <td class="md" nowrap><code> [inline]</code></td>
 
281
        </tr>
 
282
 
 
283
      </table>
 
284
    </td>
 
285
  </tr>
 
286
</table>
 
287
<table cellspacing=5 cellpadding=0 border=0>
 
288
  <tr>
 
289
    <td>
 
290
      &nbsp;
 
291
    </td>
 
292
    <td>
 
293
 
 
294
<p>
 
295
Output C string. 
 
296
<p>
 
297
    </td>
 
298
  </tr>
 
299
</table>
 
300
<a class="anchor" name="a8" doxytag="IpeStream::operator<<" ></a><p>
 
301
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
302
  <tr>
 
303
    <td class="mdRow">
 
304
      <table cellpadding="0" cellspacing="0" border="0">
 
305
        <tr>
 
306
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_stream.html">IpeStream</a> &amp; IpeStream::operator&lt;&lt; </td>
 
307
          <td class="md" valign="top">(&nbsp;</td>
 
308
          <td class="md" nowrap valign="top">int&nbsp;</td>
 
309
          <td class="mdname1" valign="top" nowrap> <em>i</em>          </td>
 
310
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
311
          <td class="md" nowrap></td>
 
312
        </tr>
 
313
 
 
314
      </table>
 
315
    </td>
 
316
  </tr>
 
317
</table>
 
318
<table cellspacing=5 cellpadding=0 border=0>
 
319
  <tr>
 
320
    <td>
 
321
      &nbsp;
 
322
    </td>
 
323
    <td>
 
324
 
 
325
<p>
 
326
Output integer. 
 
327
<p>
 
328
    </td>
 
329
  </tr>
 
330
</table>
 
331
<a class="anchor" name="a9" doxytag="IpeStream::operator<<" ></a><p>
 
332
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
333
  <tr>
 
334
    <td class="mdRow">
 
335
      <table cellpadding="0" cellspacing="0" border="0">
 
336
        <tr>
 
337
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_stream.html">IpeStream</a> &amp; IpeStream::operator&lt;&lt; </td>
 
338
          <td class="md" valign="top">(&nbsp;</td>
 
339
          <td class="md" nowrap valign="top">double&nbsp;</td>
 
340
          <td class="mdname1" valign="top" nowrap> <em>d</em>          </td>
 
341
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
342
          <td class="md" nowrap></td>
 
343
        </tr>
 
344
 
 
345
      </table>
 
346
    </td>
 
347
  </tr>
 
348
</table>
 
349
<table cellspacing=5 cellpadding=0 border=0>
 
350
  <tr>
 
351
    <td>
 
352
      &nbsp;
 
353
    </td>
 
354
    <td>
 
355
 
 
356
<p>
 
357
Output double. 
 
358
<p>
 
359
    </td>
 
360
  </tr>
 
361
</table>
 
362
<a class="anchor" name="a10" doxytag="IpeStream::PutHexByte" ></a><p>
 
363
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
364
  <tr>
 
365
    <td class="mdRow">
 
366
      <table cellpadding="0" cellspacing="0" border="0">
 
367
        <tr>
 
368
          <td class="md" nowrap valign="top"> void IpeStream::PutHexByte </td>
 
369
          <td class="md" valign="top">(&nbsp;</td>
 
370
          <td class="md" nowrap valign="top">char&nbsp;</td>
 
371
          <td class="mdname1" valign="top" nowrap> <em>b</em>          </td>
 
372
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
373
          <td class="md" nowrap></td>
 
374
        </tr>
 
375
 
 
376
      </table>
 
377
    </td>
 
378
  </tr>
 
379
</table>
 
380
<table cellspacing=5 cellpadding=0 border=0>
 
381
  <tr>
 
382
    <td>
 
383
      &nbsp;
 
384
    </td>
 
385
    <td>
 
386
 
 
387
<p>
 
388
Output byte in hexadecimal. 
 
389
<p>
 
390
    </td>
 
391
  </tr>
 
392
</table>
 
393
<a class="anchor" name="a11" doxytag="IpeStream::PutXmlString" ></a><p>
 
394
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
395
  <tr>
 
396
    <td class="mdRow">
 
397
      <table cellpadding="0" cellspacing="0" border="0">
 
398
        <tr>
 
399
          <td class="md" nowrap valign="top"> void IpeStream::PutXmlString </td>
 
400
          <td class="md" valign="top">(&nbsp;</td>
 
401
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
 
402
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
 
403
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
404
          <td class="md" nowrap></td>
 
405
        </tr>
 
406
 
 
407
      </table>
 
408
    </td>
 
409
  </tr>
 
410
</table>
 
411
<table cellspacing=5 cellpadding=0 border=0>
 
412
  <tr>
 
413
    <td>
 
414
      &nbsp;
 
415
    </td>
 
416
    <td>
 
417
 
 
418
<p>
 
419
Save a string with XML escaping of &amp;, &gt;, &lt;. 
 
420
<p>
 
421
    </td>
 
422
  </tr>
 
423
</table>
 
424
<hr>The documentation for this class was generated from the following files:<ul>
 
425
<li>ipebase.h<li>ipebase.cpp</ul>
 
426
<hr>
 
427
</body></html>