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
|
<!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::Item Class Reference</h1>A PangoItem C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="pango_2item_8hh-source.html">gfc/pango/item.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Pango::Item:
<p><center><img src="classGFC_1_1Pango_1_1Item.png" usemap="#GFC::Pango::Item_map" border="0" alt=""></center>
<map name="GFC::Pango::Item_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,108,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,108,24">
</map>
<a href="classGFC_1_1Pango_1_1Item-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="anchor" name="z1184_0" doxytag="GFC::Pango::Item::Item" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Item.html#z1184_0">Item</a> ()
<dl class="el"><dd class="mdescRight">Construct a new item initialized to default values. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1Item.html#z1184_1">Item</a> (PangoItem *item, bool copy)
<dl class="el"><dd class="mdescRight">Construct a new item from an existing PangoItem. <a href="#z1184_1"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1Item.html#z1184_2">Item</a> (const <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> &src)
<dl class="el"><dd class="mdescRight">Copy constructor. <a href="#z1184_2"></a><br></dl><li><a class="anchor" name="z1184_3" doxytag="GFC::Pango::Item::~Item" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Item.html#z1184_3">~Item</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> & <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1184_4">operator=</a> (const <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> &src)
<dl class="el"><dd class="mdescRight">Assignment operator. <a href="#z1184_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1185_0" doxytag="GFC::Pango::Item::pango_item" ></a>
PangoItem * <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1185_0">pango_item</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoItem structure. <br></dl><li><a class="anchor" name="z1185_1" doxytag="GFC::Pango::Item::operator PangoItem *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Item.html#z1185_1">operator PangoItem *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> to a PangoItem pointer. <br></dl><li><a class="anchor" name="z1185_2" doxytag="GFC::Pango::Item::offset" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1185_2">offset</a> () const
<dl class="el"><dd class="mdescRight">Returns the offset of the segment from the beginning of the string in bytes. <br></dl><li><a class="anchor" name="z1185_3" doxytag="GFC::Pango::Item::length" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1185_3">length</a> () const
<dl class="el"><dd class="mdescRight">Returns the length of the segment in bytes. <br></dl><li><a class="anchor" name="z1185_4" doxytag="GFC::Pango::Item::num_chars" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1185_4">num_chars</a> () const
<dl class="el"><dd class="mdescRight">Returns the length of the segment in characters. <br></dl><li><a class="anchor" name="z1185_5" doxytag="GFC::Pango::Item::analysis" ></a>
const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> & <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1185_5">analysis</a> () const
<dl class="el"><dd class="mdescRight">Returns a reference to the analysis object that stores the properties of the segment. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> > <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1186_0">split</a> (int split_index, int split_offset)
<dl class="el"><dd class="mdescRight">Modifies the item to cover only the text after <em>split_index</em>, and returns a new item that covers the text before <em>split_index</em> that used to be in the item. <a href="#z1186_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoItem C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> is an object that stores information about a segment of text. You can obtain an <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> by calling <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a> which returns a vector of Pointer<Item>.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1184_1" doxytag="GFC::Pango::Item::Item" ></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::Item::Item </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoItem * </td>
<td class="mdname" nowrap> <em>item</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>copy</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new item from an existing PangoItem.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>item</em> </td><td>A pointer to a PangoItem. </td></tr>
<tr><td></td><td valign=top><em>copy</em> </td><td>Whether the <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> object should make a copy of PangoItem or not.</td></tr>
</table>
</dl>
<br>
The <em>item</em> can be a newly created PangoItem or an existing PangoItem. If <em>copy</em> is true <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> will make a copy of PangoItem. If <em>copy</em> is false <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> wont make a copy but instead takes over the ownership of PangoItem. Either way, the destructor will free the PangoItem when the <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a> object is destroyed. </td>
</tr>
</table>
<a class="anchor" name="z1184_2" doxytag="GFC::Pango::Item::Item" ></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::Item::Item </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</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 <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1184_4" doxytag="GFC::Pango::Item::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_1Item.html">Item</a>& GFC::Pango::Item::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</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 <a class="el" href="classGFC_1_1Pango_1_1Item.html">Item</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1186_0" doxytag="GFC::Pango::Item::split" ></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_1Item.html">Item</a>> GFC::Pango::Item::split </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>split_index</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>split_offset</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Modifies the item to cover only the text after <em>split_index</em>, and returns a new item that covers the text before <em>split_index</em> that used to be in the item.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>split_index</em> </td><td>The byte index at the position to split the item, relative to the start of the item. </td></tr>
<tr><td></td><td valign=top><em>split_offset</em> </td><td>The number of characters between the start of the item and <em>split_index</em>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to a new item representing the text before <em>split_index</em>.</dd></dl>
<br>
You can think of <em>split_index</em> as the length of the returned item. <em>split_index</em> may not be 0, and it may not be greater than or equal to the length this item before the split (that is, there must be at least one byte assigned to each item, you can't create a zero-length item). <em>split_offset</em> is the length chars of the first (returned) item, and must be provided because the text used to generate the item isn't available, so <a class="el" href="classGFC_1_1Pango_1_1Item.html#z1186_0">split()</a> can't count the character length of the split items itself. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pango_2item_8hh-source.html">pango/item.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:46 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>
|
