/usr/share/gtk-doc/html/pygtk/class-gtkfontselectiondialog.html is in python-gtk2-doc 2.24.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.FontSelectionDialog</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkfontselection.html" title="gtk.FontSelection"><link rel="next" href="class-gtkframe.html" title="gtk.Frame"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.FontSelectionDialog</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkfontselection.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkframe.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.FontSelectionDialog"><a name="class-gtkfontselectiondialog"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.FontSelectionDialog</h2><p>gtk.FontSelectionDialog — a dialog for selecting fonts.</p></div><div class="refsect1" title="Synopsis"><a name="id3720032"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.FontSelectionDialog</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkdialog.html" title="gtk.Dialog">gtk.Dialog</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#constructor-gtkfontselectiondialog" title="Constructor">gtk.FontSelectionDialog</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-font-selection" title="gtk.FontSelectionDialog.get_font_selection">get_font_selection</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-font-name" title="gtk.FontSelectionDialog.get_font_name">get_font_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--set-font-name" title="gtk.FontSelectionDialog.set_font_name">set_font_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fontname</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-preview-text" title="gtk.FontSelectionDialog.get_preview_text">get_preview_text</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--set-preview-text" title="gtk.FontSelectionDialog.set_preview_text">set_preview_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-apply-button" title="gtk.FontSelectionDialog.get_apply_button">get_apply_button</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-cancel-button" title="gtk.FontSelectionDialog.get_cancel_button">get_cancel_button</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-ok-button" title="gtk.FontSelectionDialog.get_ok_button">get_ok_button</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3720269"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a>
+-- <a class="link" href="class-gtkdialog.html" title="gtk.Dialog">gtk.Dialog</a>
+-- <a class="link" href="class-gtkfontselectiondialog.html" title="gtk.FontSelectionDialog">gtk.FontSelectionDialog</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3720333"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkfontselectiondialog.html" title="gtk.FontSelectionDialog"><code class="classname">gtk.FontSelectionDialog</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" title="gtk.FontSelectionDialog Properties"><a name="properties-gtkfontselectiondialog"></a><h2>gtk.FontSelectionDialog Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtkwindow.html#properties-gtkwindow" title="gtk.Window Properties">gtk.Window Properties</a></p><p><a class="link" href="class-gtkdialog.html#properties-gtkdialog" title="gtk.Dialog Properties">gtk.Dialog Properties</a></p></div><div class="refsect1" title="gtk.FontSelectionDialog Style Properties"><a name="style-properties-gtkfontselectiondialog"></a><h2>gtk.FontSelectionDialog Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><p><a class="link" href="class-gtkdialog.html#style-properties-gtkdialog" title="gtk.Dialog Style Properties">gtk.Dialog Style Properties</a></p></div><div class="refsect1" title="Attributes"><a name="id3720437"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"fontsel"</td><td valign="top">Read</td><td valign="top">The <a class="link" href="class-gtkfontselection.html" title="gtk.FontSelection"><code class="classname">gtk.FontSelection</code></a>
widget in the dialog.</td></tr><tr valign="top"><td valign="top">"main_vbox"</td><td valign="top">Read</td><td valign="top">The <a class="link" href="class-gtkvbox.html" title="gtk.VBox"><code class="classname">gtk.VBox</code></a> that contains
all the dialog widgets</td></tr><tr valign="top"><td valign="top">"action_area"</td><td valign="top">Read</td><td valign="top">The <a class="link" href="class-gtkhbox.html" title="gtk.HBox"><code class="classname">gtk.HBox</code></a> containing
the action buttons</td></tr><tr valign="top"><td valign="top">"ok_button"</td><td valign="top">Read</td><td valign="top">The <span class="guibutton">OK</span> button</td></tr><tr valign="top"><td valign="top">"apply_button"</td><td valign="top">Read</td><td valign="top">The <span class="guibutton">Apply</span> button</td></tr><tr valign="top"><td valign="top">"cancel_button"</td><td valign="top">Read</td><td valign="top">The <span class="guibutton">Cancel</span> button</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.FontSelectionDialog Signal Prototypes"><a name="signal-prototypes-gtkfontselectiondialog"></a><h2>gtk.FontSelectionDialog Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><p><a class="link" href="class-gtkwindow.html#signal-prototypes-gtkwindow" title="gtk.Window Signal Prototypes">gtk.Window Signal Prototypes</a></p><p><a class="link" href="class-gtkdialog.html#signal-prototypes-gtkdialog" title="gtk.Dialog Signal Prototypes">gtk.Dialog Signal Prototypes</a></p></div><div class="refsect1" title="Description"><a name="id3720696"></a><h2>Description</h2><p>The <a class="link" href="class-gtkfontselectiondialog.html" title="gtk.FontSelectionDialog"><code class="classname">gtk.FontSelectionDialog</code></a>
is a dialog box containing a <a class="link" href="class-gtkfontselection.html" title="gtk.FontSelection"><code class="classname">gtk.FontSelection</code></a>
widget that the user can use to select a font according to the desired
family, style and size.</p><p>The <a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--set-font-name" title="gtk.FontSelectionDialog.set_font_name"><code class="methodname">set_font_name</code>()</a>
method sets the initial font selection. The current font selection is
retrieved using the <a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-font-name" title="gtk.FontSelectionDialog.get_font_name"><code class="methodname">get_font_name</code>()</a>
method. The font selection dialog has a preview area that contains a <a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a> that
displays text using the currently selected font. The preview text can be
retrieved with the <a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--get-preview-text" title="gtk.FontSelectionDialog.get_preview_text"><code class="methodname">get_preview_text</code>()</a>
method and set with the <a class="link" href="class-gtkfontselectiondialog.html#method-gtkfontselectiondialog--set-preview-text" title="gtk.FontSelectionDialog.set_preview_text"><code class="methodname">set_preview_text</code>()</a>
method.</p><p>Filters can be used to limit the font selections. There are 2
filters in the <a class="link" href="class-gtkfontselectiondialog.html" title="gtk.FontSelectionDialog"><code class="classname">gtk.FontSelectionDialog</code></a>
- 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 <span class="guibutton">Reset Filter</span> button or
changing the options on the <span class="guilabel">Filter</span> page of the
widget.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>In GTK+ 2.2 and above the <a class="link" href="class-gtkfontselectiondialog.html" title="gtk.FontSelectionDialog"><code class="classname">gtk.FontSelectionDialog</code></a>
does not have filters, a <span class="guibutton">Reset Filter</span> button or a
<span class="guilabel">Filter</span> page.</p></div></div><div class="refsect1" title="Constructor"><a name="constructor-gtkfontselectiondialog"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.FontSelectionDialog</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>title</code></strong> :</span></p></td><td>a string to be used as the dialog
title</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new font selection dialog</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkfontselectiondialog.html" title="gtk.FontSelectionDialog"><code class="classname">gtk.FontSelectionDialog</code></a>
with the title specified by <em class="parameter"><code>title</code></em>.</p></div><div class="refsect1" title="Methods"><a name="id3720930"></a><h2>Methods</h2><div class="refsect2" title="gtk.FontSelectionDialog.get_font_selection"><a name="method-gtkfontselectiondialog--get-font-selection"></a><h3>gtk.FontSelectionDialog.get_font_selection</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_font_selection</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the embedded <a class="link" href="class-gtkfontselection.html" title="gtk.FontSelection"><code class="classname">gtk.FontSelection</code></a>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.22 and above.</p></div><p>The <code class="methodname">get_font_selection</code>() method retrieves the
<a class="link" href="class-gtkfontselection.html" title="gtk.FontSelection"><code class="classname">gtk.FontSelection</code></a>
widget embedded in the dialog. </p></div><div class="refsect2" title="gtk.FontSelectionDialog.get_font_name"><a name="method-gtkfontselectiondialog--get-font-name"></a><h3>gtk.FontSelectionDialog.get_font_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_font_name</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the currently selected font name or None if no
font is selected.</td></tr></tbody></table><p>The <code class="methodname">get_font_name</code>() method returns a
string containing the currently selected font name or None if no font name
is selected.</p></div><div class="refsect2" title="gtk.FontSelectionDialog.set_font_name"><a name="method-gtkfontselectiondialog--set-font-name"></a><h3>gtk.FontSelectionDialog.set_font_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_font_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fontname</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fontname</code></strong> :</span></p></td><td>a string containing the font name to be
set</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the font is found
and can be selected</td></tr></tbody></table><p>The <code class="methodname">set_font_name</code>() method sets the
current font using the value of <em class="parameter"><code>fontname</code></em>. The method
returns <code class="literal">True</code> if the font exists and could be
selected.</p></div><div class="refsect2" title="gtk.FontSelectionDialog.get_preview_text"><a name="method-gtkfontselectiondialog--get-preview-text"></a><h3>gtk.FontSelectionDialog.get_preview_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_preview_text</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a string containing the text in the preview
area entry</td></tr></tbody></table><p>The <code class="methodname">get_preview_text</code>() method returns a
string containing the text in the preview area entry.</p></div><div class="refsect2" title="gtk.FontSelectionDialog.set_preview_text"><a name="method-gtkfontselectiondialog--set-preview-text"></a><h3>gtk.FontSelectionDialog.set_preview_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_preview_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>text</code></strong> :</span></p></td><td>a string used to set the text in the preview
area entry</td></tr></tbody></table><p>The <code class="methodname">set_preview_text</code>() method sets the
text in the preview area entry using the string specified by
<em class="parameter"><code>text</code></em>.</p></div><div class="refsect2" title="gtk.FontSelectionDialog.get_apply_button"><a name="method-gtkfontselectiondialog--get-apply-button"></a><h3>gtk.FontSelectionDialog.get_apply_button</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_apply_button</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a>.
</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above but it will be deprecated in 2.16
don't use this method.</p></div><p>
The <code class="methodname">get_apply_button</code>() method obtains a button.
The button doesn't have any function.
</p></div><div class="refsect2" title="gtk.FontSelectionDialog.get_cancel_button"><a name="method-gtkfontselectiondialog--get-cancel-button"></a><h3>gtk.FontSelectionDialog.get_cancel_button</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_cancel_button</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a>.
used in the dialog for the 'Cancel' button.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">get_cancel_button</code>() method gets the 'Cancel' button.
</p></div><div class="refsect2" title="gtk.FontSelectionDialog.get_ok_button"><a name="method-gtkfontselectiondialog--get-ok-button"></a><h3>gtk.FontSelectionDialog.get_ok_button</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_ok_button</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a>.
used in the dialog for the 'OK' button.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">get_ok_button</code>() method gets the 'OK' button.
</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkfontselection.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkframe.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.FontSelection </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Frame</td></tr></table></div></body></html>
|