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
|
<!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::ScriptIter Class Reference</h1>A PangoScriptIter C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="script_8hh-source.html">gfc/pango/script.hh</a>></code>
<p>
<a href="classGFC_1_1Pango_1_1ScriptIter-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_1ScriptIter.html#z1199_0">ScriptIter</a> (const char *text, int length=-1)
<dl class="el"><dd class="mdescRight">Construct a new script iterator, used to break a string of Unicode into runs by text. <a href="#z1199_0"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html#z1199_1">ScriptIter</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &text)
<dl class="el"><dd class="mdescRight">Construct a new script iterator, used to break a string of Unicode into runs by text. <a href="#z1199_1"></a><br></dl><li><a class="anchor" name="z1199_2" doxytag="GFC::Pango::ScriptIter::~ScriptIter" ></a>
<a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html#z1199_2">~ScriptIter</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1200_0" doxytag="GFC::Pango::ScriptIter::pango_script_iter" ></a>
PangoScriptIter * <a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html#z1200_0">pango_script_iter</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoScriptIter structure. <br></dl><li><a class="anchor" name="z1200_1" doxytag="GFC::Pango::ScriptIter::operator PangoScriptIter *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html#z1200_1">operator PangoScriptIter *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html">ScriptIter</a> to a PangoScriptIter pointer. <br></dl><li><a class="el" href="namespaceGFC_1_1Pango.html#a143">Script</a> <a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html#z1200_2">get_range</a> (const char **start, const char **end)
<dl class="el"><dd class="mdescRight">Gets information about the range to which the iterator currently points. <a href="#z1200_2"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Pango.html#a143">Script</a> <a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html#z1200_3">get_range</a> (<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> *range=0)
<dl class="el"><dd class="mdescRight">Gets information about the range to which the iterator currently points. <a href="#z1200_3"></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_1ScriptIter.html#z1201_0">next</a> ()
<dl class="el"><dd class="mdescRight">Advances a script iterator to the next range. <a href="#z1201_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoScriptIter C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Pango_1_1ScriptIter.html">ScriptIter</a> is used to iterate through a string and identify ranges in different scripts.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1199_0" doxytag="GFC::Pango::ScriptIter::ScriptIter" ></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::ScriptIter::ScriptIter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>length</em> = <code>-1</code></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 script iterator, used to break a string of Unicode into runs by text.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>A UTF-8 string. </td></tr>
<tr><td></td><td valign=top><em>length</em> </td><td>The length of text, or -1 if text is null-terminated.</td></tr>
</table>
</dl>
<br>
No copy is made of text, so the caller needs to make sure it remains valid until the iterator is destroyed. The newly created script iterator, initialized to point at the first range in the text. If the string is empty, it will point at an empty range. </td>
</tr>
</table>
<a class="anchor" name="z1199_1" doxytag="GFC::Pango::ScriptIter::ScriptIter" ></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::ScriptIter::ScriptIter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>text</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>
Construct a new script iterator, used to break a string of Unicode into runs by text.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a>.</td></tr>
</table>
</dl>
<br>
No copy is made of text, so the caller needs to make sure it remains valid until the iterator is destroyed. The newly created script iterator, initialized to point at the first range in the text. If the string is empty, it will point at an empty range. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1200_3" doxytag="GFC::Pango::ScriptIter::get_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"> <a class="el" href="namespaceGFC_1_1Pango.html#a143">Script</a> GFC::Pango::ScriptIter::get_range </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>range</em> = <code>0</code> </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>
Gets information about the range to which the iterator currently points.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>range</em> </td><td>The location to store the characters of the range, or null. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The script for range. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1200_2" doxytag="GFC::Pango::ScriptIter::get_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"> <a class="el" href="namespaceGFC_1_1Pango.html#a143">Script</a> GFC::Pango::ScriptIter::get_range </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char ** </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const char ** </td>
<td class="mdname" nowrap> <em>end</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>
Gets information about the range to which the iterator currently points.
<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 position of the range, or null. </td></tr>
<tr><td></td><td valign=top><em>end</em> </td><td>The location to store end position of the range, or null. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The script for range.</dd></dl>
<br>
The range is the set of locations p where *start <= p < *end. (That is, it doesn't include the character stored at *end). </td>
</tr>
</table>
<a class="anchor" name="z1201_0" doxytag="GFC::Pango::ScriptIter::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::ScriptIter::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>
Advances a script iterator to the next range.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the iter was succesfully advanced.</dd></dl>
<br>
If the iter is already at the end, it is left unchanged and false is returned. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="script_8hh-source.html">script.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>
|