File: class_ipe_pdf_dict.html

package info (click to toggle)
ipe 6.0pre30-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 5,100 kB
  • ctags: 5,419
  • sloc: cpp: 30,430; ansic: 1,045; xml: 845; makefile: 78; sh: 5
file content (181 lines) | stat: -rw-r--r-- 8,064 bytes parent folder | download
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
<!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>Ipelib: IpePdfDict Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<h1>IpePdfDict Class Reference<br>
<small>
[<a class="el" href="group__base.html">Ipe Base</a>]</small>
</h1><!-- doxytag: class="IpePdfDict" --><!-- doxytag: inherits="IpePdfObj" -->The PDF dictionary and stream objects.  
<a href="#_details">More...</a>
<p>
Inherits <a class="el" href="class_ipe_pdf_obj.html">IpePdfObj</a>.
<p>
<a href="class_ipe_pdf_dict-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li>virtual const <a class="el" href="class_ipe_pdf_dict.html">IpePdfDict</a> * <a class="el" href="class_ipe_pdf_dict.html#de105013572cb6b37a4b859a40ac8567">Dict</a> () const
<li><a class="anchor" name="3632076ea0241cd5961c18f38035616b"></a><!-- doxytag: member="IpePdfDict::Write" ref="3632076ea0241cd5961c18f38035616b" args="(IpeStream &amp;stream) const" -->
virtual void <b>Write</b> (<a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;stream) const
<li>void <a class="el" href="class_ipe_pdf_dict.html#0a0659e59b378a506aca31fe786d6679">SetStream</a> (const <a class="el" href="class_ipe_buffer.html">IpeBuffer</a> &amp;stream)
<li>void <a class="el" href="class_ipe_pdf_dict.html#154ecab45d611fbd88a783623f0a7175">Add</a> (<a class="el" href="class_ipe_string.html">IpeString</a> key, const <a class="el" href="class_ipe_pdf_obj.html">IpePdfObj</a> *obj)
<li>const <a class="el" href="class_ipe_pdf_obj.html">IpePdfObj</a> * <a class="el" href="class_ipe_pdf_dict.html#b240dc26f5d0b444dfc33deab7075183">Get</a> (<a class="el" href="class_ipe_string.html">IpeString</a> key, const <a class="el" href="class_ipe_pdf_file.html">IpePdfFile</a> *file) const
<li><a class="anchor" name="d0e6e6b23fe999b3ecd07533381c0b3e"></a><!-- doxytag: member="IpePdfDict::Count" ref="d0e6e6b23fe999b3ecd07533381c0b3e" args="() const" -->
int <b>Count</b> () const
<li><a class="anchor" name="a1436da2e7f53c67e903c699507366ff"></a><!-- doxytag: member="IpePdfDict::Key" ref="a1436da2e7f53c67e903c699507366ff" args="(int index) const" -->
<a class="el" href="class_ipe_string.html">IpeString</a> <b>Key</b> (int index) const
<li><a class="anchor" name="f22233bdb61bec48b6d3b51c9dd90b99"></a><!-- doxytag: member="IpePdfDict::Stream" ref="f22233bdb61bec48b6d3b51c9dd90b99" args="() const" -->
<a class="el" href="class_ipe_buffer.html">IpeBuffer</a> <b>Stream</b> () const
<li>bool <a class="el" href="class_ipe_pdf_dict.html#d4fc8d1226269ecdb588753420050bc8">Deflated</a> () const
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The PDF dictionary and stream objects. 
<p>
A dictionary may or may not have attached stream data. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="de105013572cb6b37a4b859a40ac8567"></a><!-- doxytag: member="IpePdfDict::Dict" ref="de105013572cb6b37a4b859a40ac8567" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="class_ipe_pdf_dict.html">IpePdfDict</a> * IpePdfDict::Dict           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return this object as PDF dictionary object. 
<p>

<p>
Reimplemented from <a class="el" href="class_ipe_pdf_obj.html#7d9435aa988b187f1f0bb78816ee8b81">IpePdfObj</a>.
</div>
</div><p>
<a class="anchor" name="0a0659e59b378a506aca31fe786d6679"></a><!-- doxytag: member="IpePdfDict::SetStream" ref="0a0659e59b378a506aca31fe786d6679" args="(const IpeBuffer &amp;stream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void IpePdfDict::SetStream           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_ipe_buffer.html">IpeBuffer</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add stream data to this dictionary. 
<p>

</div>
</div><p>
<a class="anchor" name="154ecab45d611fbd88a783623f0a7175"></a><!-- doxytag: member="IpePdfDict::Add" ref="154ecab45d611fbd88a783623f0a7175" args="(IpeString key, const IpePdfObj *obj)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void IpePdfDict::Add           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
          <td class="paramname"> <em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_ipe_pdf_obj.html">IpePdfObj</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a (key, value) pair to the dictionary. 
<p>
Dictionary takes ownership of <em>obj</em>. 
</div>
</div><p>
<a class="anchor" name="b240dc26f5d0b444dfc33deab7075183"></a><!-- doxytag: member="IpePdfDict::Get" ref="b240dc26f5d0b444dfc33deab7075183" args="(IpeString key, const IpePdfFile *file) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="class_ipe_pdf_obj.html">IpePdfObj</a> * IpePdfDict::Get           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
          <td class="paramname"> <em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_ipe_pdf_file.html">IpePdfFile</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Look up key in dictionary. 
<p>
Indirect objects (references) are looked up if <em>file</em> is not zero, and the object referred to is returned. Returns 0 if key is not in dictionary. 
</div>
</div><p>
<a class="anchor" name="d4fc8d1226269ecdb588753420050bc8"></a><!-- doxytag: member="IpePdfDict::Deflated" ref="d4fc8d1226269ecdb588753420050bc8" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool IpePdfDict::Deflated           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Is this stream compressed with flate compression? 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipepdfparser.h<li>ipepdfparser.cpp</ul>
<hr>
</body></html>