← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/pango1.0/oneiric

« back to all changes in this revision

Viewing changes to docs/html/pango-Glyph-Storage.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2011-09-20 12:03:01 UTC
  • mfrom: (1.5.15 upstream)
  • Revision ID: package-import@ubuntu.com-20110920120301-ov37wuadawmy2099
Tags: 1.29.3+git20110916-0ubuntu1
* Update to current git HEAD, as this hasn't been released for quite some
  time, and we require some of the fixes for our PyGI progams:
  - Fix compilation on newer GLib versions
  - Fix double free after calling Pango.Context.get_font_description()
  - Fix missing GI transfer annotation for pango_layout_get_line_readonly()
  - build: Fix srcdir != builddir.
  - Add C include and exported packages information to GIRs
  - Some typo fixes in the docs
  - Win32 build fixes.
* Drop 13_fix_pango_annotation_from_git.patch, upstream now.
* debian/libpango1.0-doc.install.in: Install HTML documentation from source
  tree instead of install tree, as this doesn't work with a separate build
  directory.
* debian/rules: Remove pango/pango-enum-types.*, so that they get rebuilt in
  the separate build tree. Fixes missing enum gtypes in GIR.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/pango-Glyph-Storage.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Glyph Storage</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Pango Reference Manual">
8
8
<link rel="up" href="pango.html" title="Basic Pango Interfaces">
9
9
<link rel="prev" href="pango-Text-Processing.html" title="Rendering">
10
10
<link rel="next" href="pango-Fonts.html" title="Fonts">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
490
490
<tbody>
491
491
<tr>
492
492
<td><p><span class="term"><em class="parameter"><code>inclusive</code></em> :</span></p></td>
493
 
<td>rectangle to round to pixels inclusively, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
493
<td>rectangle to round to pixels inclusively, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
494
494
</td>
495
495
</tr>
496
496
<tr>
497
497
<td><p><span class="term"><em class="parameter"><code>nearest</code></em> :</span></p></td>
498
 
<td>rectangle to round to nearest pixels, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
498
<td>rectangle to round to nearest pixels, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
499
499
</td>
500
500
</tr>
501
501
</tbody>
505
505
<hr>
506
506
<div class="refsect2">
507
507
<a name="PangoMatrix-struct"></a><h3>struct PangoMatrix</h3>
508
 
<pre class="programlisting">struct PangoMatrix;</pre>
 
508
<pre class="programlisting">struct PangoMatrix {
 
509
  double xx;
 
510
  double xy;
 
511
  double yx;
 
512
  double yy;
 
513
  double x0;
 
514
  double y0;
 
515
};
 
516
</pre>
509
517
<p>
510
518
A structure specifying a transformation between user-space
511
519
coordinates and device coordinates. The transformation
521
529
</p>
522
530
<div class="variablelist"><table border="0">
523
531
<col align="left" valign="top">
524
 
<tbody></tbody>
 
532
<tbody>
 
533
<tr>
 
534
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="PangoMatrix-struct.xx"></a>xx</code></em>;</span></p></td>
 
535
<td>1st component of the transformation matrix</td>
 
536
</tr>
 
537
<tr>
 
538
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="PangoMatrix-struct.xy"></a>xy</code></em>;</span></p></td>
 
539
<td>2nd component of the transformation matrix</td>
 
540
</tr>
 
541
<tr>
 
542
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="PangoMatrix-struct.yx"></a>yx</code></em>;</span></p></td>
 
543
<td>3rd component of the transformation matrix</td>
 
544
</tr>
 
545
<tr>
 
546
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="PangoMatrix-struct.yy"></a>yy</code></em>;</span></p></td>
 
547
<td>4th component of the transformation matrix</td>
 
548
</tr>
 
549
<tr>
 
550
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="PangoMatrix-struct.x0"></a>x0</code></em>;</span></p></td>
 
551
<td>x translation</td>
 
552
</tr>
 
553
<tr>
 
554
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="PangoMatrix-struct.y0"></a>y0</code></em>;</span></p></td>
 
555
<td>y translation</td>
 
556
</tr>
 
557
</tbody>
525
558
</table></div>
526
559
<p class="since">Since 1.6</p>
527
560
</div>
545
578
</p>
546
579
<p>
547
580
</p>
548
 
<div class="informalexample">
549
 
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
550
 
    <tbody>
551
 
      <tr>
552
 
        <td class="listing_lines" align="right"><pre>1
553
 
2</pre></td>
554
 
        <td class="listing_code"><pre class="programlisting"><span class="usertype">PangoMatrix</span><span class="normal"> matrix </span><span class="symbol">=</span><span class="normal"> <a href="pango-Glyph-Storage.html#PANGO-MATRIX-INIT:CAPS">PANGO_MATRIX_INIT</a></span><span class="symbol">;</span>
555
 
<span class="function"><a href="pango-Glyph-Storage.html#pango-matrix-rotate">pango_matrix_rotate</a></span><span class="normal"> </span><span class="symbol">(&amp;</span><span class="normal">matrix</span><span class="symbol">,</span><span class="normal"> </span><span class="number">45</span><span class="symbol">.);</span></pre></td>
556
 
      </tr>
557
 
    </tbody>
558
 
  </table>
559
 
</div>
560
 
 
 
581
<div class="informalexample"><pre class="programlisting">
 
582
PangoMatrix matrix = PANGO_MATRIX_INIT;
 
583
pango_matrix_rotate (&amp;matrix, 45.);
 
584
</pre></div>
561
585
<p>
562
586
</p>
563
587
<p class="since">Since 1.6</p>
739
763
</tr>
740
764
<tr>
741
765
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
742
 
<td>in/out X position. <span class="annotation">[<a href="http://foldoc.org/inout"><span class="acronym">inout</span></a>]</span>
 
766
<td>in/out X position. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span>
743
767
</td>
744
768
</tr>
745
769
<tr>
746
770
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
747
 
<td>in/out Y position. <span class="annotation">[<a href="http://foldoc.org/inout"><span class="acronym">inout</span></a>]</span>
 
771
<td>in/out Y position. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span>
748
772
</td>
749
773
</tr>
750
774
</tbody>
787
811
</tr>
788
812
<tr>
789
813
<td><p><span class="term"><em class="parameter"><code>dx</code></em> :</span></p></td>
790
 
<td>in/out X component of a distance vector. <span class="annotation">[<a href="http://foldoc.org/inout"><span class="acronym">inout</span></a>]</span>
 
814
<td>in/out X component of a distance vector. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span>
791
815
</td>
792
816
</tr>
793
817
<tr>
794
818
<td><p><span class="term"><em class="parameter"><code>dy</code></em> :</span></p></td>
795
 
<td>in/out Y component of a distance vector. <span class="annotation">[<a href="http://foldoc.org/inout"><span class="acronym">inout</span></a>]</span>
 
819
<td>in/out Y component of a distance vector. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span>
796
820
</td>
797
821
</tr>
798
822
</tbody>
837
861
</tr>
838
862
<tr>
839
863
<td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
840
 
<td>in/out bounding box in Pango units, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/inout"><span class="acronym">inout</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
864
<td>in/out bounding box in Pango units, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
841
865
</td>
842
866
</tr>
843
867
</tbody>
875
899
</tr>
876
900
<tr>
877
901
<td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
878
 
<td>in/out bounding box in device units, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/inout"><span class="acronym">inout</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
902
<td>in/out bounding box in device units, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
879
903
</td>
880
904
</tr>
881
905
</tbody>
896
920
<tbody>
897
921
<tr>
898
922
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
899
 
<td>a <a class="link" href="pango-Glyph-Storage.html#PangoMatrix"><span class="type">PangoMatrix</span></a>, may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
923
<td>a <a class="link" href="pango-Glyph-Storage.html#PangoMatrix"><span class="type">PangoMatrix</span></a>, may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
900
924
</td>
901
925
</tr>
902
926
<tr>
1079
1103
<hr>
1080
1104
<div class="refsect2">
1081
1105
<a name="PangoGlyphString-struct"></a><h3>struct PangoGlyphString</h3>
1082
 
<pre class="programlisting">struct PangoGlyphString;</pre>
 
1106
<pre class="programlisting">struct PangoGlyphString {
 
1107
  gint num_glyphs;
 
1108
 
 
1109
  PangoGlyphInfo *glyphs;
 
1110
 
 
1111
  /* This is a memory inefficient way of representing the information
 
1112
   * here - each value gives the byte index within the text
 
1113
   * corresponding to the glyph string of the start of the cluster to
 
1114
   * which the glyph belongs.
 
1115
   */
 
1116
  gint *log_clusters;
 
1117
};
 
1118
</pre>
1083
1119
<p>
1084
1120
The <a class="link" href="pango-Glyph-Storage.html#PangoGlyphString"><span class="type">PangoGlyphString</span></a> structure is used to store strings
1085
1121
of glyphs with geometry and visual attribute information.
1090
1126
<hr>
1091
1127
<div class="refsect2">
1092
1128
<a name="PangoGlyphItem-struct"></a><h3>struct PangoGlyphItem</h3>
1093
 
<pre class="programlisting">struct PangoGlyphItem;</pre>
 
1129
<pre class="programlisting">struct PangoGlyphItem {
 
1130
  PangoItem        *item;
 
1131
  PangoGlyphString *glyphs;
 
1132
};
 
1133
</pre>
1094
1134
<p>
1095
1135
A <a class="link" href="pango-Glyph-Storage.html#PangoGlyphItem"><span class="type">PangoGlyphItem</span></a> is a pair of a <a class="link" href="pango-Text-Processing.html#PangoItem"><span class="type">PangoItem</span></a> and the glyphs
1096
1136
resulting from shaping the text corresponding to an item.
1102
1142
<hr>
1103
1143
<div class="refsect2">
1104
1144
<a name="PangoGlyphItemIter-struct"></a><h3>struct PangoGlyphItemIter</h3>
1105
 
<pre class="programlisting">struct PangoGlyphItemIter;</pre>
 
1145
<pre class="programlisting">struct PangoGlyphItemIter {
 
1146
  PangoGlyphItem *glyph_item;
 
1147
  const gchar *text;
 
1148
 
 
1149
  int start_glyph;
 
1150
  int start_index;
 
1151
  int start_char;
 
1152
 
 
1153
  int end_glyph;
 
1154
  int end_index;
 
1155
  int end_char;
 
1156
};
 
1157
</pre>
1106
1158
<p>
1107
1159
A <a class="link" href="pango-Glyph-Storage.html#PangoGlyphItemIter"><span class="type">PangoGlyphItemIter</span></a> is an iterator over the clusters in a
1108
1160
<a class="link" href="pango-Glyph-Storage.html#PangoGlyphItem"><span class="type">PangoGlyphItem</span></a>.  The <em class="firstterm">forward direction</em> of the
1257
1309
<tr>
1258
1310
<td><p><span class="term"><em class="parameter"><code>ink_rect</code></em> :</span></p></td>
1259
1311
<td>rectangle used to store the extents of the glyph string
1260
 
as drawn or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to indicate that the result is not needed. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
1312
as drawn or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to indicate that the result is not needed. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1261
1313
</td>
1262
1314
</tr>
1263
1315
<tr>
1264
1316
<td><p><span class="term"><em class="parameter"><code>logical_rect</code></em> :</span></p></td>
1265
1317
<td>rectangle used to store the logical extents of the
1266
 
glyph string or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to indicate that the result is not needed. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
 
1318
glyph string or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to indicate that the result is not needed. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1267
1319
</td>
1268
1320
</tr>
1269
1321
</tbody>
1646
1698
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1647
1699
<td>a list of glyph items resulting
1648
1700
from splitting <em class="parameter"><code>glyph_item</code></em>. Free the elements using
1649
 
<a class="link" href="pango-Glyph-Storage.html#pango-glyph-item-free" title="pango_glyph_item_free ()"><code class="function">pango_glyph_item_free()</code></a>, the list using <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
1701
<a class="link" href="pango-Glyph-Storage.html#pango-glyph-item-free" title="pango_glyph_item_free ()"><code class="function">pango_glyph_item_free()</code></a>, the list using <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1650
1702
</td>
1651
1703
</tr>
1652
1704
</tbody>
1913
1965
</div>
1914
1966
<div class="footer">
1915
1967
<hr>
1916
 
          Generated by GTK-Doc V1.17</div>
 
1968
          Generated by GTK-Doc V1.18</div>
1917
1969
</body>
1918
1970
</html>
 
 
b'\\ No newline at end of file'