Git init
[external/pango1.0.git] / docs / html / pango-Tab-Stops.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Tab Stops</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
7 <link rel="home" href="index.html" title="Pango Reference Manual">
8 <link rel="up" href="pango.html" title="Basic Pango Interfaces">
9 <link rel="prev" href="pango-Text-Attributes.html" title="Text Attributes">
10 <link rel="next" href="PangoMarkupFormat.html" title="Text Attribute Markup">
11 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 <link rel="chapter" href="pango.html" title="Basic Pango Interfaces">
14 <link rel="chapter" href="rendering.html" title="Rendering with Pango">
15 <link rel="chapter" href="lowlevel.html" title="Low Level Functionality">
16 <link rel="chapter" href="tools.html" title="Pango Tools">
17 <link rel="chapter" href="pango-hierarchy.html" title="Object Hierarchy">
18 <link rel="index" href="index-all.html" title="Index">
19 <link rel="index" href="index-deprecated.html" title="Index of deprecated symbols">
20 <link rel="index" href="index-1.2.html" title="Index of new symbols in 1.2">
21 <link rel="index" href="index-1.4.html" title="Index of new symbols in 1.4">
22 <link rel="index" href="index-1.6.html" title="Index of new symbols in 1.6">
23 <link rel="index" href="index-1.8.html" title="Index of new symbols in 1.8">
24 <link rel="index" href="index-1.10.html" title="Index of new symbols in 1.10">
25 <link rel="index" href="index-1.12.html" title="Index of new symbols in 1.12">
26 <link rel="index" href="index-1.14.html" title="Index of new symbols in 1.14">
27 <link rel="index" href="index-1.16.html" title="Index of new symbols in 1.16">
28 <link rel="index" href="index-1.18.html" title="Index of new symbols in 1.18">
29 <link rel="index" href="index-1.20.html" title="Index of new symbols in 1.20">
30 <link rel="index" href="index-1.22.html" title="Index of new symbols in 1.22">
31 <link rel="index" href="index-1.24.html" title="Index of new symbols in 1.24">
32 <link rel="index" href="index-1.26.html" title="Index of new symbols in 1.26">
33 </head>
34 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
35 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
36 <tr valign="middle">
37 <td><a accesskey="p" href="pango-Text-Attributes.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
38 <td><a accesskey="u" href="pango.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
39 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
40 <th width="100%" align="center">Pango Reference Manual</th>
41 <td><a accesskey="n" href="PangoMarkupFormat.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
42 </tr>
43 <tr><td colspan="5" class="shortcuts">
44 <a href="#pango-Tab-Stops.synopsis" class="shortcut">Top</a>
45                  | 
46                 <a href="#pango-Tab-Stops.description" class="shortcut">Description</a>
47 </td></tr>
48 </table>
49 <div class="refentry" lang="en">
50 <a name="pango-Tab-Stops"></a><div class="titlepage"></div>
51 <div class="refnamediv"><table width="100%"><tr>
52 <td valign="top">
53 <h2><span class="refentrytitle"><a name="pango-Tab-Stops.top_of_page"></a>Tab Stops</span></h2>
54 <p>Tab Stops — Structures for storing tab stops</p>
55 </td>
56 <td valign="top" align="right"></td>
57 </tr></table></div>
58 <div class="refsynopsisdiv">
59 <a name="pango-Tab-Stops.synopsis"></a><h2>Synopsis</h2>
60 <pre class="synopsis">
61                     <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a>;
62 #define             <a class="link" href="pango-Tab-Stops.html#PANGO-TYPE-TAB-ARRAY--CAPS" title="PANGO_TYPE_TAB_ARRAY">PANGO_TYPE_TAB_ARRAY</a>
63 enum                <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a>;
64 #define             <a class="link" href="pango-Tab-Stops.html#PANGO-TYPE-TAB-ALIGN--CAPS" title="PANGO_TYPE_TAB_ALIGN">PANGO_TYPE_TAB_ALIGN</a>
65 <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *     <a class="link" href="pango-Tab-Stops.html#pango-tab-array-new" title="pango_tab_array_new ()">pango_tab_array_new</a>                 (<a
66 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
67 >gint</a> initial_size,
68                                                          <a
69 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
70 >gboolean</a> positions_in_pixels);
71 <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *     <a class="link" href="pango-Tab-Stops.html#pango-tab-array-new-with-positions" title="pango_tab_array_new_with_positions ()">pango_tab_array_new_with_positions</a>  (<a
72 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
73 >gint</a> size,
74                                                          <a
75 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
76 >gboolean</a> positions_in_pixels,
77                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> first_alignment,
78                                                          <a
79 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
80 >gint</a> first_position,
81                                                          ...);
82 <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *     <a class="link" href="pango-Tab-Stops.html#pango-tab-array-copy" title="pango_tab_array_copy ()">pango_tab_array_copy</a>                (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *src);
83 void                <a class="link" href="pango-Tab-Stops.html#pango-tab-array-free" title="pango_tab_array_free ()">pango_tab_array_free</a>                (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array);
84 <a
85 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
86 >gint</a>                <a class="link" href="pango-Tab-Stops.html#pango-tab-array-get-size" title="pango_tab_array_get_size ()">pango_tab_array_get_size</a>            (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array);
87 void                <a class="link" href="pango-Tab-Stops.html#pango-tab-array-resize" title="pango_tab_array_resize ()">pango_tab_array_resize</a>              (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
88                                                          <a
89 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
90 >gint</a> new_size);
91 void                <a class="link" href="pango-Tab-Stops.html#pango-tab-array-set-tab" title="pango_tab_array_set_tab ()">pango_tab_array_set_tab</a>             (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
92                                                          <a
93 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
94 >gint</a> tab_index,
95                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> alignment,
96                                                          <a
97 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
98 >gint</a> location);
99 void                <a class="link" href="pango-Tab-Stops.html#pango-tab-array-get-tab" title="pango_tab_array_get_tab ()">pango_tab_array_get_tab</a>             (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
100                                                          <a
101 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
102 >gint</a> tab_index,
103                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> *alignment,
104                                                          <a
105 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
106 >gint</a> *location);
107 void                <a class="link" href="pango-Tab-Stops.html#pango-tab-array-get-tabs" title="pango_tab_array_get_tabs ()">pango_tab_array_get_tabs</a>            (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
108                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> **alignments,
109                                                          <a
110 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
111 >gint</a> **locations);
112 <a
113 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
114 >gboolean</a>            <a class="link" href="pango-Tab-Stops.html#pango-tab-array-get-positions-in-pixels" title="pango_tab_array_get_positions_in_pixels ()">pango_tab_array_get_positions_in_pixels</a>
115                                                         (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array);
116 </pre>
117 </div>
118 <div class="refsect1" lang="en">
119 <a name="pango-Tab-Stops.description"></a><h2>Description</h2>
120 <p>
121 Functions in this section are used to deal with <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a> objects
122 that can be used to set tab stop positions in a <a class="link" href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>.
123 </p>
124 </div>
125 <div class="refsect1" lang="en">
126 <a name="pango-Tab-Stops.details"></a><h2>Details</h2>
127 <div class="refsect2" lang="en">
128 <a name="PangoTabArray"></a><h3>PangoTabArray</h3>
129 <pre class="programlisting">typedef struct _PangoTabArray PangoTabArray;</pre>
130 <p>
131 A <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a> struct contains an array
132 of tab stops. Each tab stop has an alignment and a position.
133 </p>
134 </div>
135 <hr>
136 <div class="refsect2" lang="en">
137 <a name="PANGO-TYPE-TAB-ARRAY--CAPS"></a><h3>PANGO_TYPE_TAB_ARRAY</h3>
138 <pre class="programlisting">#define PANGO_TYPE_TAB_ARRAY (pango_tab_array_get_type ())
139 </pre>
140 <p>
141 The <a
142 href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
143 ><span class="type">GObject</span></a> type for <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>.
144 </p>
145 </div>
146 <hr>
147 <div class="refsect2" lang="en">
148 <a name="PangoTabAlign"></a><h3>enum PangoTabAlign</h3>
149 <pre class="programlisting">typedef enum
150 {
151   PANGO_TAB_LEFT
152
153   /* These are not supported now, but may be in the
154    * future.
155    *
156    *  PANGO_TAB_RIGHT,
157    *  PANGO_TAB_CENTER,
158    *  PANGO_TAB_NUMERIC
159    */
160 } PangoTabAlign;
161 </pre>
162 <p>
163 A <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign"><span class="type">PangoTabAlign</span></a> specifies where a tab stop appears relative to the text.
164 </p>
165 <div class="variablelist"><table border="0">
166 <col align="left" valign="top">
167 <tbody><tr>
168 <td><p><a name="PANGO-TAB-LEFT--CAPS"></a><span class="term"><code class="literal">PANGO_TAB_LEFT</code></span></p></td>
169 <td>the tab stop appears to the left of the text.
170 </td>
171 </tr></tbody>
172 </table></div>
173 </div>
174 <hr>
175 <div class="refsect2" lang="en">
176 <a name="PANGO-TYPE-TAB-ALIGN--CAPS"></a><h3>PANGO_TYPE_TAB_ALIGN</h3>
177 <pre class="programlisting">#define PANGO_TYPE_TAB_ALIGN (pango_tab_align_get_type())
178 </pre>
179 <p>
180 The <a
181 href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
182 ><span class="type">GObject</span></a> type for <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign"><span class="type">PangoTabAlign</span></a>.
183 </p>
184 </div>
185 <hr>
186 <div class="refsect2" lang="en">
187 <a name="pango-tab-array-new"></a><h3>pango_tab_array_new ()</h3>
188 <pre class="programlisting"><a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *     pango_tab_array_new                 (<a
189 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
190 >gint</a> initial_size,
191                                                          <a
192 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
193 >gboolean</a> positions_in_pixels);</pre>
194 <p>
195 Creates an array of <em class="parameter"><code>initial_size</code></em> tab stops. Tab stops are specified in
196 pixel units if <em class="parameter"><code>positions_in_pixels</code></em> is <a
197 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
198 ><code class="literal">TRUE</code></a>, otherwise in Pango
199 units. All stops are initially at position 0.</p>
200 <p>
201 </p>
202 <div class="variablelist"><table border="0">
203 <col align="left" valign="top">
204 <tbody>
205 <tr>
206 <td><p><span class="term"><em class="parameter"><code>initial_size</code></em> :</span></p></td>
207 <td> Initial number of tab stops to allocate, can be 0
208 </td>
209 </tr>
210 <tr>
211 <td><p><span class="term"><em class="parameter"><code>positions_in_pixels</code></em> :</span></p></td>
212 <td> whether positions are in pixel units
213 </td>
214 </tr>
215 <tr>
216 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
217 <td> the newly allocated <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>, which should
218               be freed with <a class="link" href="pango-Tab-Stops.html#pango-tab-array-free" title="pango_tab_array_free ()"><code class="function">pango_tab_array_free()</code></a>.
219 </td>
220 </tr>
221 </tbody>
222 </table></div>
223 </div>
224 <hr>
225 <div class="refsect2" lang="en">
226 <a name="pango-tab-array-new-with-positions"></a><h3>pango_tab_array_new_with_positions ()</h3>
227 <pre class="programlisting"><a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *     pango_tab_array_new_with_positions  (<a
228 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
229 >gint</a> size,
230                                                          <a
231 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
232 >gboolean</a> positions_in_pixels,
233                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> first_alignment,
234                                                          <a
235 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
236 >gint</a> first_position,
237                                                          ...);</pre>
238 <p>
239 This is a convenience function that creates a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
240 and allows you to specify the alignment and position of each
241 tab stop. You <span class="emphasis"><em>must</em></span> provide an alignment
242 and position for <em class="parameter"><code>size</code></em> tab stops.</p>
243 <p>
244 </p>
245 <div class="variablelist"><table border="0">
246 <col align="left" valign="top">
247 <tbody>
248 <tr>
249 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
250 <td> number of tab stops in the array
251 </td>
252 </tr>
253 <tr>
254 <td><p><span class="term"><em class="parameter"><code>positions_in_pixels</code></em> :</span></p></td>
255 <td> whether positions are in pixel units
256 </td>
257 </tr>
258 <tr>
259 <td><p><span class="term"><em class="parameter"><code>first_alignment</code></em> :</span></p></td>
260 <td> alignment of first tab stop
261 </td>
262 </tr>
263 <tr>
264 <td><p><span class="term"><em class="parameter"><code>first_position</code></em> :</span></p></td>
265 <td> position of first tab stop
266 </td>
267 </tr>
268 <tr>
269 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
270 <td> additional alignment/position pairs
271 </td>
272 </tr>
273 <tr>
274 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
275 <td> the newly allocated <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>, which should
276               be freed with <a class="link" href="pango-Tab-Stops.html#pango-tab-array-free" title="pango_tab_array_free ()"><code class="function">pango_tab_array_free()</code></a>.
277 </td>
278 </tr>
279 </tbody>
280 </table></div>
281 </div>
282 <hr>
283 <div class="refsect2" lang="en">
284 <a name="pango-tab-array-copy"></a><h3>pango_tab_array_copy ()</h3>
285 <pre class="programlisting"><a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *     pango_tab_array_copy                (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *src);</pre>
286 <p>
287 Copies a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a></p>
288 <p>
289 </p>
290 <div class="variablelist"><table border="0">
291 <col align="left" valign="top">
292 <tbody>
293 <tr>
294 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
295 <td> <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a> to copy
296 </td>
297 </tr>
298 <tr>
299 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
300 <td> the newly allocated <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>, which should
301               be freed with <a class="link" href="pango-Tab-Stops.html#pango-tab-array-free" title="pango_tab_array_free ()"><code class="function">pango_tab_array_free()</code></a>.
302 </td>
303 </tr>
304 </tbody>
305 </table></div>
306 </div>
307 <hr>
308 <div class="refsect2" lang="en">
309 <a name="pango-tab-array-free"></a><h3>pango_tab_array_free ()</h3>
310 <pre class="programlisting">void                pango_tab_array_free                (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array);</pre>
311 <p>
312 Frees a tab array and associated resources.</p>
313 <p>
314 </p>
315 <div class="variablelist"><table border="0">
316 <col align="left" valign="top">
317 <tbody><tr>
318 <td><p><span class="term"><em class="parameter"><code>tab_array</code></em> :</span></p></td>
319 <td> a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
320 </td>
321 </tr></tbody>
322 </table></div>
323 </div>
324 <hr>
325 <div class="refsect2" lang="en">
326 <a name="pango-tab-array-get-size"></a><h3>pango_tab_array_get_size ()</h3>
327 <pre class="programlisting"><a
328 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
329 >gint</a>                pango_tab_array_get_size            (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array);</pre>
330 <p>
331 Gets the number of tab stops in <em class="parameter"><code>tab_array</code></em>.</p>
332 <p>
333 </p>
334 <div class="variablelist"><table border="0">
335 <col align="left" valign="top">
336 <tbody>
337 <tr>
338 <td><p><span class="term"><em class="parameter"><code>tab_array</code></em> :</span></p></td>
339 <td> a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
340 </td>
341 </tr>
342 <tr>
343 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
344 <td> the number of tab stops in the array.
345 </td>
346 </tr>
347 </tbody>
348 </table></div>
349 </div>
350 <hr>
351 <div class="refsect2" lang="en">
352 <a name="pango-tab-array-resize"></a><h3>pango_tab_array_resize ()</h3>
353 <pre class="programlisting">void                pango_tab_array_resize              (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
354                                                          <a
355 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
356 >gint</a> new_size);</pre>
357 <p>
358 Resizes a tab array. You must subsequently initialize any tabs that
359 were added as a result of growing the array.</p>
360 <p>
361 </p>
362 <div class="variablelist"><table border="0">
363 <col align="left" valign="top">
364 <tbody>
365 <tr>
366 <td><p><span class="term"><em class="parameter"><code>tab_array</code></em> :</span></p></td>
367 <td> a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
368 </td>
369 </tr>
370 <tr>
371 <td><p><span class="term"><em class="parameter"><code>new_size</code></em> :</span></p></td>
372 <td> new size of the array
373 </td>
374 </tr>
375 </tbody>
376 </table></div>
377 </div>
378 <hr>
379 <div class="refsect2" lang="en">
380 <a name="pango-tab-array-set-tab"></a><h3>pango_tab_array_set_tab ()</h3>
381 <pre class="programlisting">void                pango_tab_array_set_tab             (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
382                                                          <a
383 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
384 >gint</a> tab_index,
385                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> alignment,
386                                                          <a
387 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
388 >gint</a> location);</pre>
389 <p>
390 Sets the alignment and location of a tab stop.
391 <em class="parameter"><code>alignment</code></em> must always be <a class="link" href="pango-Tab-Stops.html#PANGO-TAB-LEFT--CAPS"><span class="type">PANGO_TAB_LEFT</span></a> in the current
392 implementation.</p>
393 <p>
394 </p>
395 <div class="variablelist"><table border="0">
396 <col align="left" valign="top">
397 <tbody>
398 <tr>
399 <td><p><span class="term"><em class="parameter"><code>tab_array</code></em> :</span></p></td>
400 <td> a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
401 </td>
402 </tr>
403 <tr>
404 <td><p><span class="term"><em class="parameter"><code>tab_index</code></em> :</span></p></td>
405 <td> the index of a tab stop
406 </td>
407 </tr>
408 <tr>
409 <td><p><span class="term"><em class="parameter"><code>alignment</code></em> :</span></p></td>
410 <td> tab alignment
411 </td>
412 </tr>
413 <tr>
414 <td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
415 <td> tab location in Pango units
416 </td>
417 </tr>
418 </tbody>
419 </table></div>
420 </div>
421 <hr>
422 <div class="refsect2" lang="en">
423 <a name="pango-tab-array-get-tab"></a><h3>pango_tab_array_get_tab ()</h3>
424 <pre class="programlisting">void                pango_tab_array_get_tab             (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
425                                                          <a
426 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
427 >gint</a> tab_index,
428                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> *alignment,
429                                                          <a
430 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
431 >gint</a> *location);</pre>
432 <p>
433 Gets the alignment and position of a tab stop.</p>
434 <p>
435 </p>
436 <div class="variablelist"><table border="0">
437 <col align="left" valign="top">
438 <tbody>
439 <tr>
440 <td><p><span class="term"><em class="parameter"><code>tab_array</code></em> :</span></p></td>
441 <td> a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
442 </td>
443 </tr>
444 <tr>
445 <td><p><span class="term"><em class="parameter"><code>tab_index</code></em> :</span></p></td>
446 <td> tab stop index
447 </td>
448 </tr>
449 <tr>
450 <td><p><span class="term"><em class="parameter"><code>alignment</code></em> :</span></p></td>
451 <td> location to store alignment, or <a
452 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
453 ><code class="literal">NULL</code></a>
454 </td>
455 </tr>
456 <tr>
457 <td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
458 <td> location to store tab position, or <a
459 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
460 ><code class="literal">NULL</code></a>
461 </td>
462 </tr>
463 </tbody>
464 </table></div>
465 </div>
466 <hr>
467 <div class="refsect2" lang="en">
468 <a name="pango-tab-array-get-tabs"></a><h3>pango_tab_array_get_tabs ()</h3>
469 <pre class="programlisting">void                pango_tab_array_get_tabs            (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array,
470                                                          <a class="link" href="pango-Tab-Stops.html#PangoTabAlign" title="enum PangoTabAlign">PangoTabAlign</a> **alignments,
471                                                          <a
472 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
473 >gint</a> **locations);</pre>
474 <p>
475 If non-<a
476 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
477 ><code class="literal">NULL</code></a>, <em class="parameter"><code>alignments</code></em> and <em class="parameter"><code>locations</code></em> are filled with allocated
478 arrays of length <a class="link" href="pango-Tab-Stops.html#pango-tab-array-get-size" title="pango_tab_array_get_size ()"><code class="function">pango_tab_array_get_size()</code></a>. You must free the
479 returned array.</p>
480 <p>
481 </p>
482 <div class="variablelist"><table border="0">
483 <col align="left" valign="top">
484 <tbody>
485 <tr>
486 <td><p><span class="term"><em class="parameter"><code>tab_array</code></em> :</span></p></td>
487 <td> a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
488 </td>
489 </tr>
490 <tr>
491 <td><p><span class="term"><em class="parameter"><code>alignments</code></em> :</span></p></td>
492 <td> location to store an array of tab stop alignments, or <a
493 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
494 ><code class="literal">NULL</code></a>
495 </td>
496 </tr>
497 <tr>
498 <td><p><span class="term"><em class="parameter"><code>locations</code></em> :</span></p></td>
499 <td> location to store an array of tab positions, or <a
500 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
501 ><code class="literal">NULL</code></a>
502 </td>
503 </tr>
504 </tbody>
505 </table></div>
506 </div>
507 <hr>
508 <div class="refsect2" lang="en">
509 <a name="pango-tab-array-get-positions-in-pixels"></a><h3>pango_tab_array_get_positions_in_pixels ()</h3>
510 <pre class="programlisting"><a
511 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
512 >gboolean</a>            pango_tab_array_get_positions_in_pixels
513                                                         (<a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray">PangoTabArray</a> *tab_array);</pre>
514 <p>
515 Returns <a
516 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
517 ><code class="literal">TRUE</code></a> if the tab positions are in pixels, <a
518 href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
519 ><code class="literal">FALSE</code></a> if they are
520 in Pango units.</p>
521 <p>
522 </p>
523 <div class="variablelist"><table border="0">
524 <col align="left" valign="top">
525 <tbody>
526 <tr>
527 <td><p><span class="term"><em class="parameter"><code>tab_array</code></em> :</span></p></td>
528 <td> a <a class="link" href="pango-Tab-Stops.html#PangoTabArray" title="PangoTabArray"><span class="type">PangoTabArray</span></a>
529 </td>
530 </tr>
531 <tr>
532 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
533 <td> whether positions are in pixels.
534 </td>
535 </tr>
536 </tbody>
537 </table></div>
538 </div>
539 </div>
540 </div>
541 <div class="footer">
542 <hr>
543           Generated by GTK-Doc V1.11</div>
544 </body>
545 </html>