1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3
5
<title>Ipelib: Ipe Base</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
7
<!-- Generated by Doxygen 1.5.8 -->
8
<div class="navigation" id="top">
11
<li><a href="index.html"><span>Main Page</span></a></li>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">Ipelib</div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
12
26
<li><a href="modules.html"><span>Modules</span></a></li>
13
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
14
27
<li><a href="annotated.html"><span>Classes</span></a></li>
33
<a href="#nested-classes">Classes</a> |
34
<a href="#var-members">Variables</a> </div>
35
<div class="headertitle">
36
<h1>Ipe Base</h1> </div>
18
38
<div class="contents">
19
<h1>Ipe Base</h1>Basic classes for Ipe.
20
<a href="#_details">More...</a>
40
<p>Basic classes for Ipe.
41
<a href="#_details">More...</a></p>
42
<h2><a name="nested-classes"></a>
24
45
<li>class <a class="el" href="classipe_1_1_string.html">ipe::String</a>
25
<dl class="el"><dd class="mdescRight">Strings and buffers. <a href="classipe_1_1_string.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_fixed.html">ipe::Fixed</a>
26
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_fixed.html" title="Fixed point number with three (decimal) fractional digits.">Fixed</a> point number with three (decimal) fractional digits. <a href="classipe_1_1_fixed.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_lex.html">ipe::Lex</a>
27
<dl class="el"><dd class="mdescRight">Lexical analyser. Seeded with a string. <a href="classipe_1_1_lex.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_buffer.html">ipe::Buffer</a>
28
<dl class="el"><dd class="mdescRight">A memory buffer. <a href="classipe_1_1_buffer.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_stream.html">ipe::Stream</a>
29
<dl class="el"><dd class="mdescRight">Abstract base class for output streams. <a href="classipe_1_1_stream.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_string_stream.html">ipe::StringStream</a>
30
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_stream.html" title="Abstract base class for output streams.">Stream</a> writing into an <a class="el" href="classipe_1_1_string.html" title="Strings and buffers.">String</a>. <a href="classipe_1_1_string_stream.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_file_stream.html">ipe::FileStream</a>
31
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_stream.html" title="Abstract base class for output streams.">Stream</a> writing into an open file. <a href="classipe_1_1_file_stream.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_data_source.html">ipe::DataSource</a>
32
<dl class="el"><dd class="mdescRight">Interface for getting data for parsing. <a href="classipe_1_1_data_source.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_file_source.html">ipe::FileSource</a>
33
<dl class="el"><dd class="mdescRight">Data source for parsing from a file. <a href="classipe_1_1_file_source.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_buffer_source.html">ipe::BufferSource</a>
34
<dl class="el"><dd class="mdescRight">Data source for parsing from a buffer. <a href="classipe_1_1_buffer_source.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_bitmap_1_1_m_render_data.html">ipe::Bitmap::Bitmap::MRenderData</a>
35
<dl class="el"><dd class="mdescRight">Abstract base class for pixmap data stored by a client. <a href="classipe_1_1_bitmap_1_1_m_render_data.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_bitmap.html">ipe::Bitmap</a>
36
<dl class="el"><dd class="mdescRight">A bitmap. <a href="classipe_1_1_bitmap.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_painter.html">ipe::Painter</a>
37
<dl class="el"><dd class="mdescRight">Interface for drawing. <a href="classipe_1_1_painter.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_obj.html">ipe::PdfObj</a>
38
<dl class="el"><dd class="mdescRight">Abstract base class for PDF objects. <a href="classipe_1_1_pdf_obj.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_null.html">ipe::PdfNull</a>
39
<dl class="el"><dd class="mdescRight">The PDF null object. <a href="classipe_1_1_pdf_null.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_bool.html">ipe::PdfBool</a>
40
<dl class="el"><dd class="mdescRight">The PDF bool object. <a href="classipe_1_1_pdf_bool.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_number.html">ipe::PdfNumber</a>
41
<dl class="el"><dd class="mdescRight">The PDF number object. <a href="classipe_1_1_pdf_number.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_string.html">ipe::PdfString</a>
42
<dl class="el"><dd class="mdescRight">The PDF string object. <a href="classipe_1_1_pdf_string.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_name.html">ipe::PdfName</a>
43
<dl class="el"><dd class="mdescRight">The PDF name object. <a href="classipe_1_1_pdf_name.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_ref.html">ipe::PdfRef</a>
44
<dl class="el"><dd class="mdescRight">The PDF reference object (indirect object). <a href="classipe_1_1_pdf_ref.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_array.html">ipe::PdfArray</a>
45
<dl class="el"><dd class="mdescRight">The PDF array object. <a href="classipe_1_1_pdf_array.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_dict.html">ipe::PdfDict</a>
46
<dl class="el"><dd class="mdescRight">The PDF dictionary and stream objects. <a href="classipe_1_1_pdf_dict.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_parser.html">ipe::PdfParser</a>
47
<dl class="el"><dd class="mdescRight">PDF parser. <a href="classipe_1_1_pdf_parser.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_pdf_file.html">ipe::PdfFile</a>
48
<dl class="el"><dd class="mdescRight">All information obtained by parsing a PDF file. <a href="classipe_1_1_pdf_file.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_platform.html">ipe::Platform</a>
49
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_platform.html" title="Platform dependent methods.">Platform</a> dependent methods. <a href="classipe_1_1_platform.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_xml_attributes.html">ipe::XmlAttributes</a>
50
<dl class="el"><dd class="mdescRight">Stores attributes of an XML tag. <a href="classipe_1_1_xml_attributes.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_xml_parser.html">ipe::XmlParser</a>
51
<dl class="el"><dd class="mdescRight">Base class for XML stream parsing. <a href="classipe_1_1_xml_parser.html#_details">More...</a><br></dl><li>class <a class="el" href="classipe_1_1_tell_stream.html">ipe::TellStream</a>
52
<dl class="el"><dd class="mdescRight">Adds position feedback to IpeStream. <a href="classipe_1_1_tell_stream.html#_details">More...</a><br></dl></ul>
46
<dl class="el"><dd class="mdescRight">Strings and buffers. <a href="classipe_1_1_string.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_fixed.html">ipe::Fixed</a>
47
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_fixed.html" title="Fixed point number with three (decimal) fractional digits.">Fixed</a> point number with three (decimal) fractional digits. <a href="classipe_1_1_fixed.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_lex.html">ipe::Lex</a>
48
<dl class="el"><dd class="mdescRight">Lexical analyser. Seeded with a string. <a href="classipe_1_1_lex.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_buffer.html">ipe::Buffer</a>
49
<dl class="el"><dd class="mdescRight">A memory buffer. <a href="classipe_1_1_buffer.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_stream.html">ipe::Stream</a>
50
<dl class="el"><dd class="mdescRight">Abstract base class for output streams. <a href="classipe_1_1_stream.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_string_stream.html">ipe::StringStream</a>
51
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_stream.html" title="Abstract base class for output streams.">Stream</a> writing into an <a class="el" href="classipe_1_1_string.html" title="Strings and buffers.">String</a>. <a href="classipe_1_1_string_stream.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_file_stream.html">ipe::FileStream</a>
52
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_stream.html" title="Abstract base class for output streams.">Stream</a> writing into an open file. <a href="classipe_1_1_file_stream.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_data_source.html">ipe::DataSource</a>
53
<dl class="el"><dd class="mdescRight">Interface for getting data for parsing. <a href="classipe_1_1_data_source.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_file_source.html">ipe::FileSource</a>
54
<dl class="el"><dd class="mdescRight">Data source for parsing from a file. <a href="classipe_1_1_file_source.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_buffer_source.html">ipe::BufferSource</a>
55
<dl class="el"><dd class="mdescRight">Data source for parsing from a buffer. <a href="classipe_1_1_buffer_source.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_bitmap_1_1_m_render_data.html">ipe::Bitmap::MRenderData</a>
56
<dl class="el"><dd class="mdescRight">Abstract base class for pixmap data stored by a client. <a href="classipe_1_1_bitmap_1_1_m_render_data.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_bitmap.html">ipe::Bitmap</a>
57
<dl class="el"><dd class="mdescRight">A bitmap. <a href="classipe_1_1_bitmap.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_painter.html">ipe::Painter</a>
58
<dl class="el"><dd class="mdescRight">Interface for drawing. <a href="classipe_1_1_painter.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_obj.html">ipe::PdfObj</a>
59
<dl class="el"><dd class="mdescRight">Abstract base class for PDF objects. <a href="classipe_1_1_pdf_obj.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_null.html">ipe::PdfNull</a>
60
<dl class="el"><dd class="mdescRight">The PDF null object. <a href="classipe_1_1_pdf_null.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_bool.html">ipe::PdfBool</a>
61
<dl class="el"><dd class="mdescRight">The PDF bool object. <a href="classipe_1_1_pdf_bool.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_number.html">ipe::PdfNumber</a>
62
<dl class="el"><dd class="mdescRight">The PDF number object. <a href="classipe_1_1_pdf_number.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_string.html">ipe::PdfString</a>
63
<dl class="el"><dd class="mdescRight">The PDF string object. <a href="classipe_1_1_pdf_string.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_name.html">ipe::PdfName</a>
64
<dl class="el"><dd class="mdescRight">The PDF name object. <a href="classipe_1_1_pdf_name.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_ref.html">ipe::PdfRef</a>
65
<dl class="el"><dd class="mdescRight">The PDF reference object (indirect object). <a href="classipe_1_1_pdf_ref.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_array.html">ipe::PdfArray</a>
66
<dl class="el"><dd class="mdescRight">The PDF array object. <a href="classipe_1_1_pdf_array.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_dict.html">ipe::PdfDict</a>
67
<dl class="el"><dd class="mdescRight">The PDF dictionary and stream objects. <a href="classipe_1_1_pdf_dict.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_parser.html">ipe::PdfParser</a>
68
<dl class="el"><dd class="mdescRight">PDF parser. <a href="classipe_1_1_pdf_parser.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_pdf_file.html">ipe::PdfFile</a>
69
<dl class="el"><dd class="mdescRight">All information obtained by parsing a PDF file. <a href="classipe_1_1_pdf_file.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_platform.html">ipe::Platform</a>
70
<dl class="el"><dd class="mdescRight"><a class="el" href="classipe_1_1_platform.html" title="Platform dependent methods.">Platform</a> dependent methods. <a href="classipe_1_1_platform.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_xml_attributes.html">ipe::XmlAttributes</a>
71
<dl class="el"><dd class="mdescRight">Stores attributes of an XML tag. <a href="classipe_1_1_xml_attributes.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_xml_parser.html">ipe::XmlParser</a>
72
<dl class="el"><dd class="mdescRight">Base class for XML stream parsing. <a href="classipe_1_1_xml_parser.html#_details">More...</a><br/></dl><li>class <a class="el" href="classipe_1_1_tell_stream.html">ipe::TellStream</a>
73
<dl class="el"><dd class="mdescRight">Adds position feedback to IpeStream. <a href="classipe_1_1_tell_stream.html#_details">More...</a><br/></dl></ul>
74
<h2><a name="var-members"></a>
55
<li>const int <a class="el" href="group__base.html#g63fb9a4c5352670e3c1fa6ae2df310b6">ipe::IPELIB_VERSION</a> = 70101
56
<li>const int <a class="el" href="group__base.html#g1382a12138719bc823934b30ea6fcb24">ipe::OLDEST_FILE_FORMAT</a> = 70000
57
<li>const int <a class="el" href="group__base.html#gf2a53f87a989967e182121b628174bc1">ipe::FILE_FORMAT</a> = 70005
77
<li>const int <a class="el" href="group__base.html#ga63fb9a4c5352670e3c1fa6ae2df310b6">ipe::IPELIB_VERSION</a> = 70102
78
<li>const int <a class="el" href="group__base.html#ga1382a12138719bc823934b30ea6fcb24">ipe::OLDEST_FILE_FORMAT</a> = 70000
79
<li>const int <a class="el" href="group__base.html#gaf2a53f87a989967e182121b628174bc1">ipe::FILE_FORMAT</a> = 70005
59
<hr><a name="_details"></a><h2>Detailed Description</h2>
60
Basic classes for Ipe.
62
Some very basic type definitions, streams, lexical analysis, and XML parsing.<p>
63
All parts of Ipe make use of the STL. The C++ I/O streams library is not used, as Ipelib doesn't do much I/O. Ipe objects support internalization and externalization through an abstract interface based on <a class="el" href="classipe_1_1_stream.html" title="Abstract base class for output streams.">ipe::Stream</a>'s.<p>
64
Clients of Ipelib can use any I/O library that implements this interface. Ipe simply uses <code>cstdio</code>. <hr><h2>Variable Documentation</h2>
65
<a class="anchor" name="g63fb9a4c5352670e3c1fa6ae2df310b6"></a><!-- doxytag: member="ipe::IPELIB_VERSION" ref="g63fb9a4c5352670e3c1fa6ae2df310b6" args="" -->
67
<div class="memproto">
68
<table class="memname">
70
<td class="memname">const int <a class="el" href="group__base.html#g63fb9a4c5352670e3c1fa6ae2df310b6">ipe::IPELIB_VERSION</a> = 70101 </td>
82
<a class="anchor" name="g1382a12138719bc823934b30ea6fcb24"></a><!-- doxytag: member="ipe::OLDEST_FILE_FORMAT" ref="g1382a12138719bc823934b30ea6fcb24" args="" -->
84
<div class="memproto">
85
<table class="memname">
87
<td class="memname">const int <a class="el" href="group__base.html#g1382a12138719bc823934b30ea6fcb24">ipe::OLDEST_FILE_FORMAT</a> = 70000 </td>
94
Oldest readable file format version.
99
<a class="anchor" name="gf2a53f87a989967e182121b628174bc1"></a><!-- doxytag: member="ipe::FILE_FORMAT" ref="gf2a53f87a989967e182121b628174bc1" args="" -->
100
<div class="memitem">
101
<div class="memproto">
102
<table class="memname">
104
<td class="memname">const int <a class="el" href="group__base.html#gf2a53f87a989967e182121b628174bc1">ipe::FILE_FORMAT</a> = 70005 </td>
111
Current file format version.
81
<hr/><a name="_details"></a><h2>Detailed Description</h2>
82
<p>Basic classes for Ipe. </p>
83
<p>Some very basic type definitions, streams, lexical analysis, and XML parsing.</p>
84
<p>All parts of Ipe make use of the STL. The C++ I/O streams library is not used, as Ipelib doesn't do much I/O. Ipe objects support internalization and externalization through an abstract interface based on <a class="el" href="classipe_1_1_stream.html" title="Abstract base class for output streams.">ipe::Stream</a>'s.</p>
85
<p>Clients of Ipelib can use any I/O library that implements this interface. Ipe simply uses <code>cstdio</code>. </p>
86
<hr/><h2>Variable Documentation</h2>
87
<a class="anchor" id="ga63fb9a4c5352670e3c1fa6ae2df310b6"></a><!-- doxytag: member="ipe::IPELIB_VERSION" ref="ga63fb9a4c5352670e3c1fa6ae2df310b6" args="" -->
89
<div class="memproto">
90
<table class="memname">
92
<td class="memname">const int ipe::IPELIB_VERSION = 70102</td>
98
<p>Ipelib version. </p>
102
<a class="anchor" id="ga1382a12138719bc823934b30ea6fcb24"></a><!-- doxytag: member="ipe::OLDEST_FILE_FORMAT" ref="ga1382a12138719bc823934b30ea6fcb24" args="" -->
103
<div class="memitem">
104
<div class="memproto">
105
<table class="memname">
107
<td class="memname">const int ipe::OLDEST_FILE_FORMAT = 70000</td>
113
<p>Oldest readable file format version. </p>
117
<a class="anchor" id="gaf2a53f87a989967e182121b628174bc1"></a><!-- doxytag: member="ipe::FILE_FORMAT" ref="gaf2a53f87a989967e182121b628174bc1" args="" -->
118
<div class="memitem">
119
<div class="memproto">
120
<table class="memname">
122
<td class="memname">const int ipe::FILE_FORMAT = 70005</td>
128
<p>Current file format version. </p>