~ubuntu-branches/ubuntu/trusty/pango1.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/xml/glyphs.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-09-09 07:49:30 UTC
  • mfrom: (1.6.1 upstream) (63.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090909074930-zlgadwz6svi311vh
Tags: 1.25.6-1
New upstream development release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
117
117
                                                         const <link linkend="char">char</link> *text,
118
118
                                                         <link linkend="PangoLogAttr">PangoLogAttr</link> *log_attrs,
119
119
                                                         <link linkend="int">int</link> letter_spacing);
 
120
<link linkend="void">void</link>                <link linkend="pango-glyph-item-get-logical-widths">pango_glyph_item_get_logical_widths</link> (<link linkend="PangoGlyphItem">PangoGlyphItem</link> *glyph_item,
 
121
                                                         const <link linkend="char">char</link> *text,
 
122
                                                         <link linkend="int">int</link> *logical_widths);
120
123
#define             <link linkend="PANGO-TYPE-GLYPH-ITEM-ITER--CAPS">PANGO_TYPE_GLYPH_ITEM_ITER</link>
121
124
<link linkend="PangoGlyphItemIter">PangoGlyphItemIter</link> * <link linkend="pango-glyph-item-iter-copy">pango_glyph_item_iter_copy</link>         (<link linkend="PangoGlyphItemIter">PangoGlyphItemIter</link> *orig);
122
125
<link linkend="void">void</link>                <link linkend="pango-glyph-item-iter-free">pango_glyph_item_iter_free</link>          (<link linkend="PangoGlyphItemIter">PangoGlyphItemIter</link> *iter);
1219
1222
Given a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link> resulting from <link linkend="pango-shape"><function>pango_shape()</function></link> and the corresponding
1220
1223
text, determine the screen width corresponding to each character. When
1221
1224
multiple characters compose a single cluster, the width of the entire
1222
 
cluster is divided equally among the characters.</para>
 
1225
cluster is divided equally among the characters.
 
1226
</para>
 
1227
<para>
 
1228
See also <link linkend="pango-glyph-item-get-logical-widths"><function>pango_glyph_item_get_logical_widths()</function></link>.</para>
1223
1229
<para>
1224
1230
</para><variablelist role="params">
1225
1231
<varlistentry><term><parameter>glyphs</parameter>&#160;:</term>
1235
1241
<listitem><simpara> the embedding level of the string
1236
1242
</simpara></listitem></varlistentry>
1237
1243
<varlistentry><term><parameter>logical_widths</parameter>&#160;:</term>
1238
 
<listitem><simpara> an array whose length is g_utf8_strlen (text, length)
 
1244
<listitem><simpara> an array whose length is the number of characters in
 
1245
                 text (equal to g_utf8_strlen (text, length) unless
 
1246
                 text has NUL bytes)
1239
1247
                 to be filled in with the resulting character widths.
1240
1248
</simpara></listitem></varlistentry>
1241
1249
</variablelist></refsect2>
1378
1386
  negative values will give ugly results.
1379
1387
</simpara></listitem></varlistentry>
1380
1388
</variablelist><para role="since">Since 1.6</para></refsect2>
 
1389
<refsect2 id="pango-glyph-item-get-logical-widths" role="function" condition="since:1.26">
 
1390
<title>pango_glyph_item_get_logical_widths ()</title>
 
1391
<indexterm zone="pango-glyph-item-get-logical-widths" role="1.26"><primary sortas="pango_glyph_item_get_logical_widths">pango_glyph_item_get_logical_widths</primary></indexterm><programlisting><link linkend="void">void</link>                pango_glyph_item_get_logical_widths (<link linkend="PangoGlyphItem">PangoGlyphItem</link> *glyph_item,
 
1392
                                                         const <link linkend="char">char</link> *text,
 
1393
                                                         <link linkend="int">int</link> *logical_widths);</programlisting>
 
1394
<para>
 
1395
Given a <link linkend="PangoGlyphItem"><type>PangoGlyphItem</type></link> and the corresponding
 
1396
text, determine the screen width corresponding to each character. When
 
1397
multiple characters compose a single cluster, the width of the entire
 
1398
cluster is divided equally among the characters.
 
1399
</para>
 
1400
<para>
 
1401
See also <link linkend="pango-glyph-string-get-logical-widths"><function>pango_glyph_string_get_logical_widths()</function></link>.</para>
 
1402
<para>
 
1403
</para><variablelist role="params">
 
1404
<varlistentry><term><parameter>glyph_item</parameter>&#160;:</term>
 
1405
<listitem><simpara> a <link linkend="PangoGlyphItem"><type>PangoGlyphItem</type></link>
 
1406
</simpara></listitem></varlistentry>
 
1407
<varlistentry><term><parameter>text</parameter>&#160;:</term>
 
1408
<listitem><simpara> text that <parameter>glyph_item</parameter> corresponds to
 
1409
  (glyph_item->item->offset is an offset from the
 
1410
   start of <parameter>text</parameter>)
 
1411
</simpara></listitem></varlistentry>
 
1412
<varlistentry><term><parameter>logical_widths</parameter>&#160;:</term>
 
1413
<listitem><simpara> an array whose length is the number of characters in
 
1414
                 glyph_item (equal to glyph_item->item->num_chars)
 
1415
                 to be filled in with the resulting character widths.
 
1416
</simpara></listitem></varlistentry>
 
1417
</variablelist><para role="since">Since 1.26</para></refsect2>
1381
1418
<refsect2 id="PANGO-TYPE-GLYPH-ITEM-ITER--CAPS" role="macro" condition="since:1.22">
1382
1419
<title>PANGO_TYPE_GLYPH_ITEM_ITER</title>
1383
1420
<indexterm zone="PANGO-TYPE-GLYPH-ITEM-ITER--CAPS" role="1.22"><primary sortas="PANGO_TYPE_GLYPH_ITEM_ITER">PANGO_TYPE_GLYPH_ITEM_ITER</primary></indexterm><programlisting>#define PANGO_TYPE_GLYPH_ITEM_ITER (pango_glyph_item_iter_get_type ())