blob: b4f4ee72db0507a969661c57ec27ebec055e09ce (
plain)
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
284
285
286
287
288
289
290
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-pangotabarray">
<refnamediv>
<refname>pango.TabArray</refname>
<refpurpose>an object containing an array of tab stops.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>pango.TabArray</classname></ooclass>
<ooclass><classname>gobject.GBoxed</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-pangotabarray">pango.TabArray</link></methodname>
<methodparam><parameter
role="keyword">initial_size</parameter></methodparam>
<methodparam><parameter
role="keyword">positions_in_pixels</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-pangotabarray--copy">copy</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-pangotabarray--get-size">get_size</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-pangotabarray--resize">resize</link></methodname>
<methodparam><parameter
role="keyword">new_size</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-pangotabarray--set-tab">set_tab</link></methodname>
<methodparam><parameter
role="keyword">tab_index</parameter></methodparam>
<methodparam><parameter
role="keyword">alignment</parameter></methodparam>
<methodparam><parameter
role="keyword">location</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-pangotabarray--get-tab">get_tab</link></methodname>
<methodparam><parameter
role="keyword">tab_index</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-pangotabarray--get-tabs">get_tabs</link></methodname>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-pangotabarray--get-positions-in-pixels">get_positions_in_pixels</link></methodname>
<methodparam></methodparam> </methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
object contains an array of tab stops. Each tab stop has an alignment and a
position.</para>
</refsect1>
<refsect1 id="constructor-pangotabarray">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>pango.TabArray</methodname>
<methodparam><parameter
role="keyword">initial_size</parameter></methodparam>
<methodparam><parameter
role="keyword">positions_in_pixels</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">initial_size</parameter> :</term>
<listitem><simpara>Initial number of tab stops to allocate, can be
0</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">positions_in_pixels</parameter> :</term>
<listitem><simpara>if <literal>True</literal> the tab positions are
in pixel units</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-pangotabarray"><classname>pango.TabArray</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
object with the number of tab stops specified by
<parameter>initial_size</parameter>. If
<parameter>positions_in_pixels</parameter> is <literal>True</literal>, the
tab stop positions are specified in pixel units otherwise in pango units
(one pixel = <literal>pango.SCALE</literal> pango units). All tab stops are
initially at position 0.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-pangotabarray--copy">
<title>pango.TabArray.copy</title>
<programlisting><methodsynopsis language="python">
<methodname>copy</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>copy</methodname>() method returns a new <link
linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
that is copy of this <link
linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>.</para>
</refsect2>
<refsect2 id="method-pangotabarray--get-size">
<title>pango.TabArray.get_size</title>
<programlisting><methodsynopsis language="python">
<methodname>get_size</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the number of tab stops in the
array.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_size</methodname>() method returns the
number of tab stops in the tab array.</para>
</refsect2>
<refsect2 id="method-pangotabarray--resize">
<title>pango.TabArray.resize</title>
<programlisting><methodsynopsis language="python">
<methodname>resize</methodname>
<methodparam><parameter
role="keyword">new_size</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">new_size</parameter> :</term>
<listitem><simpara>the new size of the array</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>resize</methodname>() method sets the size of
the tab array to the value specified by <parameter>new_size</parameter>. You
must subsequently initialize any tabs that were added to the array.</para>
</refsect2>
<refsect2 id="method-pangotabarray--set-tab">
<title>pango.TabArray.set_tab</title>
<programlisting><methodsynopsis language="python">
<methodname>set_tab</methodname>
<methodparam><parameter
role="keyword">tab_index</parameter></methodparam>
<methodparam><parameter
role="keyword">alignment</parameter></methodparam>
<methodparam><parameter
role="keyword">location</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">tab_index</parameter> :</term>
<listitem><simpara>the index of a tab stop</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">alignment</parameter> :</term>
<listitem><simpara>the tab alignment</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">location</parameter> :</term>
<listitem><simpara>the tab location in pango
units</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_tab</methodname>() method sets the specified
<parameter>alignment</parameter> and <parameter>location</parameter> of the
tab stop specified by <parameter>tab_index</parameter>. The value of
<parameter>alignment</parameter> must always be
<literal>pango.TAB_LEFT</literal> in the current implementation.</para>
</refsect2>
<refsect2 id="method-pangotabarray--get-tab">
<title>pango.TabArray.get_tab</title>
<programlisting><methodsynopsis language="python">
<methodname>get_tab</methodname>
<methodparam><parameter
role="keyword">tab_index</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">tab_index</parameter> :</term>
<listitem><simpara>the tab stop index</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a 2-tuple containing the tab alignment and
position</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_tab</methodname>() method returns a 2-tuple
containing the alignment and position of the tab stop specified by
<parameter>tab_index</parameter>.</para>
</refsect2>
<refsect2 id="method-pangotabarray--get-tabs">
<title>pango.TabArray.get_tabs</title>
<programlisting><methodsynopsis language="python">
<methodname>get_tabs</methodname>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a tuple containing a list of 2-tuples (each
holding the alignment and position of a tab stop).</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_tabs</methodname>() method returns a tuple
containing a list of 2-tuples (each holding the alignment and position of a
tab stop)</para>
</refsect2>
<refsect2 id="method-pangotabarray--get-positions-in-pixels">
<title>pango.TabArray.get_positions_in_pixels</title>
<programlisting><methodsynopsis language="python">
<methodname>get_positions_in_pixels</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if tab stop positions
are specified in pixels</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_positions_in_pixels</methodname>() method
returns <parameter>True</parameter> if the tab positions are specified in
pixels and <literal>False</literal> if they are in pango units.</para>
</refsect2>
</refsect1>
</refentry>
|
