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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Pango::AttrIterator Class Reference</h1>A PangoAttrIterator C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="attributes_8hh-source.html">gfc/pango/attributes.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Pango::AttrIterator:
<p><center><img src="classGFC_1_1Pango_1_1AttrIterator.png" usemap="#GFC::Pango::AttrIterator_map" border="0" alt=""></center>
<map name="GFC::Pango::AttrIterator_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,146,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,146,24">
</map>
<a href="classGFC_1_1Pango_1_1AttrIterator-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1136_0">AttrIterator</a> (PangoAttrIterator *iterator)
<dl class="el"><dd class="mdescRight">Constructs a new attribute iterator from an existing PangoAttrIterator. <a href="#z1136_0"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1136_1">AttrIterator</a> (const <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> &src)
<dl class="el"><dd class="mdescRight">Copy constructor. <a href="#z1136_1"></a><br></dl><li><a class="anchor" name="z1136_2" doxytag="GFC::Pango::AttrIterator::~AttrIterator" ></a>
<a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1136_2">~AttrIterator</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> & <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1136_3">operator=</a> (const <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> &src)
<dl class="el"><dd class="mdescRight">Assignment operator. <a href="#z1136_3"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1137_0" doxytag="GFC::Pango::AttrIterator::pango_attr_iterator" ></a>
PangoAttrIterator * <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_0">pango_attr_iterator</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoAttrIterator structure. <br></dl><li><a class="anchor" name="z1137_1" doxytag="GFC::Pango::AttrIterator::operator PangoAttrIterator *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_1">operator PangoAttrIterator *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> to a PangoAttrIterator pointer. <br></dl><li><a class="anchor" name="z1137_2" doxytag="GFC::Pango::AttrIterator::start_index" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_2">start_index</a> () const
<dl class="el"><dd class="mdescRight">Returns the start index of the current range. <br></dl><li><a class="anchor" name="z1137_3" doxytag="GFC::Pango::AttrIterator::end_index" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_3">end_index</a> () const
<dl class="el"><dd class="mdescRight">Returns the end index of the current range. <br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_4">range</a> (int *start, int *end) const
<dl class="el"><dd class="mdescRight">Get the range of the current segment. <a href="#z1137_4"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1Attribute.html">Attribute</a> > <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_5">get</a> (<a class="el" href="namespaceGFC_1_1Pango.html#a134">AttrType</a> type)
<dl class="el"><dd class="mdescRight">Find the current attribute of a particular type at the iterator location. <a href="#z1137_5"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_6">get_font</a> (<a class="el" href="classGFC_1_1Pango_1_1FontDescription.html">FontDescription</a> &desc, PangoLanguage **language, std::vector< <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1Attribute.html">Attribute</a> > > *extra_attrs) const
<dl class="el"><dd class="mdescRight">Get the font and other attributes at the current iterator position. <a href="#z1137_6"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1137_7">get_attrs</a> (std::vector< <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1Attribute.html">Attribute</a> > > &attrs) const
<dl class="el"><dd class="mdescRight">Gets a list all attributes at the current position of the iterator. <a href="#z1137_7"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>bool <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1138_0">next</a> ()
<dl class="el"><dd class="mdescRight">Advance the iterator until the next change of style. <a href="#z1138_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoAttrIterator C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> is used to represent an iterator through an <a class="el" href="classGFC_1_1Pango_1_1AttrList.html">AttrList</a>. A new iterator is created with <a class="el" href="classGFC_1_1Pango_1_1AttrList.html#z1140_2">Pango::AttrList::get_iterator()</a>. Once the iterator is created, it can be advanced through the style changes in the text using <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html#z1138_0">next()</a>. At each style change, the range of the current style segment and the attributes currently in effect can be queried.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1136_0" doxytag="GFC::Pango::AttrIterator::AttrIterator" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Pango::AttrIterator::AttrIterator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoAttrIterator * </td>
<td class="mdname1" valign="top" nowrap> <em>iterator</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new attribute iterator from an existing PangoAttrIterator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>iterator</em> </td><td>A PangoAttrIterator.</td></tr>
</table>
</dl>
<br>
<a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> takes over the ownership of the PangoAttrIterator and calls pango_attr_iterator_destroy() when it's no longer required. </td>
</tr>
</table>
<a class="anchor" name="z1136_1" doxytag="GFC::Pango::AttrIterator::AttrIterator" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Pango::AttrIterator::AttrIterator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>src</em> </td><td>The source iterator. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1137_5" doxytag="GFC::Pango::AttrIterator::get" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Pango_1_1Attribute.html">Attribute</a>> GFC::Pango::AttrIterator::get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Pango.html#a134">AttrType</a> </td>
<td class="mdname1" valign="top" nowrap> <em>type</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Find the current attribute of a particular type at the iterator location.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>type</em> </td><td>The type of attribute to find. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The current attribute of the given type, or null if no attribute of that type applies to the current location.</dd></dl>
<br>
When multiple attributes of the same type overlap, the attribute whose range starts closest to the current location is used. </td>
</tr>
</table>
<a class="anchor" name="z1137_7" doxytag="GFC::Pango::AttrIterator::get_attrs" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Pango::AttrIterator::get_attrs </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::vector< <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1Attribute.html">Attribute</a> > > & </td>
<td class="mdname1" valign="top" nowrap> <em>attrs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets a list all attributes at the current position of the iterator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>attrs</em> </td><td>A reference to a vector of Pointer<Attribute> to hold the list of attributes. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the vector is not empty. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1137_6" doxytag="GFC::Pango::AttrIterator::get_font" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::AttrIterator::get_font </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1FontDescription.html">FontDescription</a> & </td>
<td class="mdname" nowrap> <em>desc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>PangoLanguage ** </td>
<td class="mdname" nowrap> <em>language</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>std::vector< <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1Attribute.html">Attribute</a> > > * </td>
<td class="mdname" nowrap> <em>extra_attrs</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the font and other attributes at the current iterator position.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>desc</em> </td><td>A <a class="el" href="classGFC_1_1Pango_1_1FontDescription.html">FontDescription</a> to fill in with the current values. </td></tr>
<tr><td></td><td valign=top><em>language</em> </td><td>If non-null, location to store the language tag for item, or null if none is found. </td></tr>
<tr><td></td><td valign=top><em>extra_attrs</em> </td><td>If non-null, a vector in which to store a list of non-font attributes at the current position; only the highest priority value of each attribute will be added to this list.</td></tr>
</table>
</dl>
<br>
The family name in <em>desc</em> will be set by <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> using pango_font_description_set_family_static() using values from an attribute in the <a class="el" href="classGFC_1_1Pango_1_1AttrList.html">AttrList</a> associated with the iterator, so if you plan to keep it around, you must call: desc.set_family(desc.get_family()). </td>
</tr>
</table>
<a class="anchor" name="z1138_0" doxytag="GFC::Pango::AttrIterator::next" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Pango::AttrIterator::next </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Advance the iterator until the next change of style.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>false</em> if the iterator is at the end of the list, otherwise <em>true</em>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1136_3" doxytag="GFC::Pango::AttrIterator::operator=" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a>& GFC::Pango::AttrIterator::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1AttrIterator.html">AttrIterator</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Assignment operator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>src</em> </td><td>The source iterator. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1137_4" doxytag="GFC::Pango::AttrIterator::range" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::AttrIterator::range </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>end</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the range of the current segment.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>start</em> </td><td>The location to store the start of the range. </td></tr>
<tr><td></td><td valign=top><em>end</em> </td><td>The location to store the end of the range. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="attributes_8hh-source.html">attributes.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:45 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
