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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
|
<?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-gtkfontselection">
<refnamediv>
<refname>gtk.FontSelection</refname>
<refpurpose>a widget for selecting fonts.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.FontSelection</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gtkfontselection">gtk.FontSelection</link></methodname>
<methodparam></methodparam> </constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkfontselection--get-font-name">get_font_name</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkfontselection--set-font-name">set_font_name</link></methodname>
<methodparam><parameter
role="keyword">fontname</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkfontselection--get-preview-text">get_preview_text</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkfontselection--set-preview-text">set_preview_text</link></methodname>
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-face">get_face</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-face-list">get_face_list</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-family">get_family</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-family-list">get_family_list</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-preview-entry">get_preview_entry</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-size">get_size</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-size-entry">get_size_entry</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkfontselection--get-size-list">get_size_list</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbox">gtk.Box</link>
+-- <link linkend="class-gtkvbox">gtk.VBox</link>
+-- <link linkend="class-gtkfontselection">gtk.FontSelection</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkfontselection">
<title>gtk.FontSelection Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"font"</entry>
<entry>Read</entry>
<entry>The gtk.gdk.Font that is
currently selected. This property is deprecated.</entry>
</row>
<row valign="top">
<entry>"font-name"</entry>
<entry>Read/Write</entry>
<entry>The string that names the font</entry>
</row>
<row valign="top">
<entry>"preview-text"</entry>
<entry>Read/Write</entry>
<entry>The text to display in order to demonstrate the selected
font.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkfontselection">
<title>gtk.FontSelection Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
</refsect1>
<refsect1 id="child-properties-gtkfontselection">
<title>gtk.FontSelection Child Properties</title>
<para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkfontselection">
<title>gtk.FontSelection Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
widget lists the available fonts, styles and sizes, allowing the user to
select a font. It is used in the <link
linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
widget to provide a dialog box for selecting fonts. The <link
linkend="method-gtkfontselection--set-font-name"><methodname>set_font_name</methodname>()</link>
method sets the initial font selection. The current font selection is
retrieved using the <link
linkend="method-gtkfontselection--get-font-name"><methodname>get_font_name</methodname>()</link>
method.</para>
<para>The fontselection has a preview area that contains a <link
linkend="class-gtkentry"><classname>gtk.Entry</classname></link> that
displays text using the currently selected font. The preview text can be
retrieved with the <link
linkend="method-gtkfontselection--get-preview-text"><methodname>get_preview_text</methodname>()</link>
method and set with the <link
linkend="method-gtkfontselection--set-preview-text"><methodname>set_preview_text</methodname>()</link>
method.</para>
<para>Filters can be used to limit the font selections. There are 2
filters in the <link
linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
- a base filter and a user filter. The base filter cannot be changed by the
user, so this can be used when the user must choose from the restricted set
of fonts (e.g. for a terminal-type application you may want to force the
user to select a fixed-width font). The user filter can be changed or reset
by the user, by using the <guibutton>Reset Filter</guibutton> button or
changing the options on the <guilabel>Filter</guilabel> page of the
widget.</para>
</refsect1>
<refsect1 id="constructor-gtkfontselection">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.FontSelection</methodname>
<methodparam></methodparam> </constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new fontselection widget</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
widget.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkfontselection--get-font-name">
<title>gtk.FontSelection.get_font_name</title>
<programlisting><methodsynopsis language="python">
<methodname>get_font_name</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a string containing the selected font
name</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_font_name</methodname>() method returns the
name of the currently selected font.</para>
</refsect2>
<refsect2 id="method-gtkfontselection--set-font-name">
<title>gtk.FontSelection.set_font_name</title>
<programlisting><methodsynopsis language="python">
<methodname>set_font_name</methodname>
<methodparam><parameter
role="keyword">fontname</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">fontname</parameter> :</term>
<listitem><simpara>a string containing the name of a
font</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the font could be
set</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_font_name</methodname>() method sets the
currently selected font in the fontselection using the value of
<parameter>fontname</parameter>. The method returns <literal>True</literal>
if the font is found and can be selected in the fontselection.</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-preview-text">
<title>gtk.FontSelection.get_preview_text</title>
<programlisting><methodsynopsis language="python">
<methodname>get_preview_text</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a string containing the preview
text</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_preview_text</methodname>() method returns a
string that contains the text displayed in the preview area entry.</para>
</refsect2>
<refsect2 id="method-gtkfontselection--set-preview-text">
<title>gtk.FontSelection.set_preview_text</title>
<programlisting><methodsynopsis language="python">
<methodname>set_preview_text</methodname>
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>the new preview text
string</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_preview_text</methodname>() method sets the
text to be displayed in the preview area entry using the string in
<parameter>text</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-face">
<title>gtk.FontSelection.get_face</title>
<programlisting><methodsynopsis language="python">
<methodname>get_face</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A <link linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
representing the selected font group details.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_face</methodname>() method gets the
<link linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
representing the selected font group details (i.e. family, slant, weight, width, etc).
</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-face-list">
<title>gtk.FontSelection.get_face_list</title>
<programlisting><methodsynopsis language="python">
<methodname>get_face_list</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A
<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
that is part of fontsel.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_face_list</methodname>() method returns the
<link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
which lists all styles available for the selected font. For example, 'Regular', 'Bold', etc.
</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-family">
<title>gtk.FontSelection.get_family</title>
<programlisting><methodsynopsis language="python">
<methodname>get_family</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A <link linkend="class-pangofontselection"><classname>pango.FontSelection</classname></link>
representing the selected font family. Font families are a collection of font faces.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_family</methodname>() method gets the
<link linkend="class-pangofontselection"><classname>pango.FontSelection</classname></link>
representing the selected font family.
</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-family-list">
<title>gtk.FontSelection.get_family_list</title>
<programlisting><methodsynopsis language="python">
<methodname>get_family_list</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A
<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
that is part of fontsel.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_family_list</methodname>() method returns the
<link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
that lists font families, for example, 'Sans', 'Serif', etc.
</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-preview-entry">
<title>gtk.FontSelection.get_preview_entry</title>
<programlisting><methodsynopsis language="python">
<methodname>get_preview_entry</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A
<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
that is part of fontsel.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_preview_entry</methodname>() method returns the
<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
used to display the font as a preview.
</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-size">
<title>gtk.FontSelection.get_size</title>
<programlisting><methodsynopsis language="python">
<methodname>get_size</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A n integer representing the selected font size,
or -1 if no font size is selected. </simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_size</methodname>() method returns the selected font size.
</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-size-entry">
<title>gtk.FontSelection.get_size_entry</title>
<programlisting><methodsynopsis language="python">
<methodname>get_size_entry</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A
<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
that is part of fontsel.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_preview_entry</methodname>() method returns the
<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
used to allow the user to edit the font number manually instead of
selecting it from the list of font sizes.
</para>
</refsect2>
<refsect2 id="method-gtkfontselection--get-size-list">
<title>gtk.FontSelection.get_size_list</title>
<programlisting><methodsynopsis language="python">
<methodname>get_size_list</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A
<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
that is part of fontsel.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_size_list</methodname>() method returns the
<link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
used to list font sizes.
</para>
</refsect2>
</refsect1>
</refentry>
|
