1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.RcStyle</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" 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-gtkrange.html" title="gtk.Range"><link rel="next" href="class-gtkrecentaction.html" title="gtk.RecentAction"></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.RcStyle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkrange.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkrecentaction.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkrcstyle"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.RcStyle</h2><p>gtk.RcStyle — an object holding resource styles</p></div><div class="refsect1" lang="en"><a name="id3645615"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.RcStyle</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.RcStyle</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><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-gtkrange.html" title="gtk.Range"><link rel="next" href="class-gtkrecentaction.html" title="gtk.RecentAction"></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.RcStyle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkrange.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkrecentaction.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.RcStyle"><a name="class-gtkrcstyle"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.RcStyle</h2><p>gtk.RcStyle — an object holding resource styles</p></div><div class="refsect1" title="Synopsis"><a name="id3955556"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.RcStyle</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
2
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#method-gtkrcstyle--copy" title="gtk.RcStyle.copy">copy</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
3
3
<span class="bold"><strong>Functions</strong></span>
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-add-default-file" title="gtk.rc_add_default_file">gtk.rc_add_default_file</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-set-default-files" title="gtk.rc_set_default_files">gtk.rc_set_default_files</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filenames</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-default-files" title="gtk.rc_get_default_files">gtk.rc_get_default_files</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-style-by-paths" title="gtk.rc_get_style_by_paths">gtk.rc_get_style_by_paths</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>class_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-reparse-all-for-settings" title="gtk.rc_reparse_all_for_settings">gtk.rc_reparse_all_for_settings</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>force_load</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-reset-styles" title="gtk.rc_reset_styles">gtk.rc_reset_styles</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-parse" title="gtk.rc_parse">gtk.rc_parse</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-parse-string" title="gtk.rc_parse_string">gtk.rc_parse_string</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>rc_string</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-reparse-all" title="gtk.rc_reparse_all">gtk.rc_reparse_all</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-find-module-in-path" title="gtk.rc_find_module_in_path">gtk.rc_find_module_in_path</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>module_file</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-theme-dir" title="gtk.rc_get_theme_dir">gtk.rc_get_theme_dir</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-module-dir" title="gtk.rc_get_module_dir">gtk.rc_get_module_dir</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-im-module-path" title="gtk.rc_get_im_module_path">gtk.rc_get_im_module_path</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-im-module-file" title="gtk.rc_get_im_module_file">gtk.rc_get_im_module_file</a></span>(<span class="methodparam"></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3646057"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-add-default-file" title="gtk.rc_add_default_file">gtk.rc_add_default_file</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-set-default-files" title="gtk.rc_set_default_files">gtk.rc_set_default_files</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filenames</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-default-files" title="gtk.rc_get_default_files">gtk.rc_get_default_files</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-style-by-paths" title="gtk.rc_get_style_by_paths">gtk.rc_get_style_by_paths</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>class_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-reparse-all-for-settings" title="gtk.rc_reparse_all_for_settings">gtk.rc_reparse_all_for_settings</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>force_load</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-reset-styles" title="gtk.rc_reset_styles">gtk.rc_reset_styles</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-parse" title="gtk.rc_parse">gtk.rc_parse</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-parse-string" title="gtk.rc_parse_string">gtk.rc_parse_string</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>rc_string</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-reparse-all" title="gtk.rc_reparse_all">gtk.rc_reparse_all</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-find-module-in-path" title="gtk.rc_find_module_in_path">gtk.rc_find_module_in_path</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>module_file</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-theme-dir" title="gtk.rc_get_theme_dir">gtk.rc_get_theme_dir</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-module-dir" title="gtk.rc_get_module_dir">gtk.rc_get_module_dir</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-im-module-path" title="gtk.rc_get_im_module_path">gtk.rc_get_im_module_path</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrcstyle.html#function-gtk--rc-get-im-module-file" title="gtk.rc_get_im_module_file">gtk.rc_get_im_module_file</a></span>(<span class="methodparam"></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3955998"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
6
+-- <a class="link" href="class-gtkrcstyle.html" title="gtk.RcStyle">gtk.RcStyle</a>
7
</pre></div><div class="refsect1" lang="en"><a name="attributes-gtkrcstyle"></a><h2>Attributes</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Available in PyGTK 2.16 and above.</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some of the following attributes are arrays
7
</pre></div><div class="refsect1" title="Attributes"><a name="attributes-gtkrcstyle"></a><h2>Attributes</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Available in PyGTK 2.16 and above.</p></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some of the following attributes are arrays
8
8
of <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a> or
9
9
strings. Array objects themselves are read-only but individual elements are
10
read-write.</p></div><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><col><col></colgroup><tbody><tr valign="top"><td valign="top">"name"</td><td valign="top">Read-Write</td><td valign="top">Name of the style.</td></tr><tr valign="top"><td valign="top">"bg_pixmap_name"</td><td valign="top">Read</td><td valign="top">An array of names of pixmap files to be used as the background in
10
read-write.</p></div><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">"name"</td><td valign="top">Read-Write</td><td valign="top">Name of the style.</td></tr><tr valign="top"><td valign="top">"bg_pixmap_name"</td><td valign="top">Read</td><td valign="top">An array of names of pixmap files to be used as the background in
11
11
each widget state.</td></tr><tr valign="top"><td valign="top">"font_desc"</td><td valign="top">Read-Write</td><td valign="top">A <code class="classname">pango.FontDescription</code> used as the default
12
12
text font.</td></tr><tr valign="top"><td valign="top">"fg"</td><td valign="top">Read</td><td valign="top">An array
13
13
of <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>s
17
17
of <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>s
18
18
to be used for the text colors in each widget state.</td></tr><tr valign="top"><td valign="top">"base"</td><td valign="top">Read</td><td valign="top">An array
19
19
of <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>s
20
to be used for the base colors in each widget state.</td></tr><tr valign="top"><td valign="top">"xthickness"</td><td valign="top">Read-Write</td><td valign="top">The thickness of lines drawn vertically.</td></tr><tr valign="top"><td valign="top">"ythickness"</td><td valign="top">Read-Write</td><td valign="top">The thickness of lines drawn horizontally.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkrcstyle"></a><h2>gtk.RcStyle Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p></div><div class="refsect1" lang="en"><a name="id3646385"></a><h2>Description</h2><p><code class="literal">PyGTK</code> via <code class="literal">GTK+</code> provides
20
to be used for the base colors in each widget state.</td></tr><tr valign="top"><td valign="top">"xthickness"</td><td valign="top">Read-Write</td><td valign="top">The thickness of lines drawn vertically.</td></tr><tr valign="top"><td valign="top">"ythickness"</td><td valign="top">Read-Write</td><td valign="top">The thickness of lines drawn horizontally.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.RcStyle Signal Prototypes"><a name="signal-prototypes-gtkrcstyle"></a><h2>gtk.RcStyle Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p></div><div class="refsect1" title="Description"><a name="id3956326"></a><h2>Description</h2><p><code class="literal">PyGTK</code> via <code class="literal">GTK+</code> provides
21
21
resource file mechanism for configuring various aspects of the operation of
22
22
a program at runtime.</p><p>An application can cause <code class="literal">GTK+</code> to parse a
23
23
specific RC file by calling the <a class="link" href="class-gtkrcstyle.html#function-gtk--rc-parse" title="gtk.rc_parse"><code class="function">gtk.rc_parse</code>()</a>
179
179
</pre><p><em class="parameter"><code>key</code></em> is a string consisting of a series of
180
modifiers followed by the name of a key. The modifiers can be:</p><div class="itemizedlist"><ul type="disc"><li><alt></li><li><control></li><li><mod1></li><li><mod2></li><li><mod3></li><li><mod4></li><li><mod5></li><li><release></li><li><shft></li><li><shift></li></ul></div><p><shft> is an alias for <shift> and <alt> is an
180
modifiers followed by the name of a key. The modifiers can be:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><alt></li><li class="listitem"><control></li><li class="listitem"><mod1></li><li class="listitem"><mod2></li><li class="listitem"><mod3></li><li class="listitem"><mod4></li><li class="listitem"><mod5></li><li class="listitem"><release></li><li class="listitem"><shft></li><li class="listitem"><shift></li></ul></div><p><shft> is an alias for <shift> and <alt> is an
181
181
alias for <mod1>.</p><p>The action that is bound to the key is a sequence of signal names
182
182
(strings) followed by parameters for each signal. The signals must be action
183
183
signals. Each parameter can be a float, integer, string, or unquoted string
187
187
priority can be specified for each pattern, and within each type of pattern,
188
188
binding sets override other binding sets first by priority, and only then by
189
189
order of specification. (Later overrides earlier). The priorities that can
190
be specified are (highest to lowest):</p><div class="itemizedlist"><ul type="disc"><li>highest</li><li>rc</li><li>theme</li><li>application</li><li>gtk</li><li>lowest</li></ul></div><p><code class="literal">rc</code> is the default for bindings read from an RC
190
be specified are (highest to lowest):</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">highest</li><li class="listitem">rc</li><li class="listitem">theme</li><li class="listitem">application</li><li class="listitem">gtk</li><li class="listitem">lowest</li></ul></div><p><code class="literal">rc</code> is the default for bindings read from an RC
191
191
file, <code class="literal">theme</code> is the default for bindings read from theme
192
192
RC files, <code class="literal">application</code> should be used for bindings an
193
193
application sets up, and <code class="literal">gtk</code> is used for bindings that
194
<code class="literal">GTK+</code> creates internally.</p></div><div class="refsect1" lang="en"><a name="id3647834"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkrcstyle--copy"></a><h3>gtk.RcStyle.copy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</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 new <a class="link" href="class-gtkrcstyle.html" title="gtk.RcStyle"><code class="classname">gtk.RcStyle</code></a> that is
194
<code class="literal">GTK+</code> creates internally.</p></div><div class="refsect1" title="Methods"><a name="id3957775"></a><h2>Methods</h2><div class="refsect2" title="gtk.RcStyle.copy"><a name="method-gtkrcstyle--copy"></a><h3>gtk.RcStyle.copy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</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 new <a class="link" href="class-gtkrcstyle.html" title="gtk.RcStyle"><code class="classname">gtk.RcStyle</code></a> that is
195
195
a copy of the rcstyle</td></tr></tbody></table><p>The copy() method returns a new <a class="link" href="class-gtkrcstyle.html" title="gtk.RcStyle"><code class="classname">gtk.RcStyle</code></a> that is
196
196
a copy of the RC style. This method will correctly copy an RC style that is
197
a member of a class derived from <a class="link" href="class-gtkrcstyle.html" title="gtk.RcStyle"><code class="classname">gtk.RcStyle</code></a>.</p></div></div><div class="refsect1" lang="en"><a name="id3647920"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--rc-add-default-file"></a><h3>gtk.rc_add_default_file</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_add_default_file</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</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>filename</code></strong> :</span></p></td><td>the name of a file containing resource
197
a member of a class derived from <a class="link" href="class-gtkrcstyle.html" title="gtk.RcStyle"><code class="classname">gtk.RcStyle</code></a>.</p></div></div><div class="refsect1" title="Functions"><a name="id3957861"></a><h2>Functions</h2><div class="refsect2" title="gtk.rc_add_default_file"><a name="function-gtk--rc-add-default-file"></a><h3>gtk.rc_add_default_file</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_add_default_file</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</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>filename</code></strong> :</span></p></td><td>the name of a file containing resource
198
198
data</td></tr></tbody></table><p>The <code class="function">gtk.rc_add_default_file</code>() function adds
199
199
the file specified by <em class="parameter"><code>filename</code></em> to the list of files
200
to be parsed for resource data.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-set-default-files"></a><h3>gtk.rc_set_default_files</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_set_default_files</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filenames</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>filenames</code></strong> :</span></p></td><td>a list of filenames</td></tr></tbody></table><p>The <code class="function">gtk.rc_set_default_files</code>() function
200
to be parsed for resource data.</p></div><div class="refsect2" title="gtk.rc_set_default_files"><a name="function-gtk--rc-set-default-files"></a><h3>gtk.rc_set_default_files</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_set_default_files</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filenames</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>filenames</code></strong> :</span></p></td><td>a list of filenames</td></tr></tbody></table><p>The <code class="function">gtk.rc_set_default_files</code>() function
201
201
sets the list of files (specified by <em class="parameter"><code>filenames</code></em>) that
202
will be parsed for resource information.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-get-default-files"></a><h3>gtk.rc_get_default_files</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_default_files</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 current list of resource
202
will be parsed for resource information.</p></div><div class="refsect2" title="gtk.rc_get_default_files"><a name="function-gtk--rc-get-default-files"></a><h3>gtk.rc_get_default_files</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_default_files</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 current list of resource
203
203
files</td></tr></tbody></table><p>The <code class="function">gtk.rc_get_default_files</code>() function
204
204
returns a list of filenames (as set by the <a class="link" href="class-gtkrcstyle.html#function-gtk--rc-set-default-files" title="gtk.rc_set_default_files"><code class="function">gtk.rc_set_default_files</code>()</a>
205
function) that will be parsed for resource data.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-get-style-by-paths"></a><h3>gtk.rc_get_style_by_paths</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_style_by_paths</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>class_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
205
function) that will be parsed for resource data.</p></div><div class="refsect2" title="gtk.rc_get_style_by_paths"><a name="function-gtk--rc-get-style-by-paths"></a><h3>gtk.rc_get_style_by_paths</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_style_by_paths</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>widget_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>class_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
206
206
object</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>widget_path</code></strong> :</span></p></td><td>the widget path to use when looking up the
207
207
style</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>class_path</code></strong> :</span></p></td><td>the class path to use when looking up the
208
208
style</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>a type that will be used along with parent
216
216
matching. This function may be useful when creating pseudo-widgets that
217
217
should be themed like widgets but don't actually have corresponding
218
218
<code class="literal">PyGTK</code> widgets. An example of this would be items inside a
219
<code class="literal">GNOME</code> canvas widget.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-reparse-all-for-settings"></a><h3>gtk.rc_reparse_all_for_settings</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_reparse_all_for_settings</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>force_load</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
219
<code class="literal">GNOME</code> canvas widget.</p></div><div class="refsect2" title="gtk.rc_reparse_all_for_settings"><a name="function-gtk--rc-reparse-all-for-settings"></a><h3>gtk.rc_reparse_all_for_settings</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_reparse_all_for_settings</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>force_load</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
220
220
object</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>force_load</code></strong> :</span></p></td><td>if <code class="literal">True</code> reparse the RC files
221
221
even if they haven't changed</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 files were
222
222
reparsed</td></tr></tbody></table><p>The <code class="function">gtk.rc_reparse_all_for_settings</code>()
224
224
object specified by <em class="parameter"><code>settings</code></em> if any of the files have
225
225
changed and <em class="parameter"><code>force_load</code></em> is <code class="literal">False</code>
226
226
and . If <em class="parameter"><code>force_load</code></em> is <code class="literal">True</code> the
227
files are always reparsed.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-reset-styles"></a><h3>gtk.rc_reset_styles</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_reset_styles</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
228
object</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkstyle.html" title="gtk.Style"><code class="classname">gtk.Style</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.rc_reset_styles</code>() function returns
227
files are always reparsed.</p></div><div class="refsect2" title="gtk.rc_reset_styles"><a name="function-gtk--rc-reset-styles"></a><h3>gtk.rc_reset_styles</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_reset_styles</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
228
object</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkstyle.html" title="gtk.Style"><code class="classname">gtk.Style</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 function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.rc_reset_styles</code>() function returns
229
229
a <a class="link" href="class-gtkstyle.html" title="gtk.Style"><code class="classname">gtk.Style</code></a>. This
230
230
function computes the styles for all widgets that use the <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
231
231
object specified by <em class="parameter"><code>settings</code></em>. (There is one <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
237
237
appearance. As an example, it is used when the default font size set by the
238
238
operating system changes. Note that this function doesn't affect widgets
239
239
that have a style set explicitly on them with the <a class="link" href="class-gtkwidget.html#method-gtkwidget--set-style" title="gtk.Widget.set_style"><code class="methodname">gtk.Widget.set_style</code>()</a>
240
method.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-parse"></a><h3>gtk.rc_parse</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_parse</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</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>filename</code></strong> :</span></p></td><td>the name of a file to parse for resource
240
method.</p></div><div class="refsect2" title="gtk.rc_parse"><a name="function-gtk--rc-parse"></a><h3>gtk.rc_parse</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_parse</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</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>filename</code></strong> :</span></p></td><td>the name of a file to parse for resource
241
241
data</td></tr></tbody></table><p>The <code class="function">gtk.rc_parse</code>() function parses the file
242
specified by <em class="parameter"><code>filename</code></em> for resource data.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-parse-string"></a><h3>gtk.rc_parse_string</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_parse_string</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>rc_string</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>rc_string</code></strong> :</span></p></td><td>a string to parse for resource
242
specified by <em class="parameter"><code>filename</code></em> for resource data.</p></div><div class="refsect2" title="gtk.rc_parse_string"><a name="function-gtk--rc-parse-string"></a><h3>gtk.rc_parse_string</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_parse_string</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>rc_string</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>rc_string</code></strong> :</span></p></td><td>a string to parse for resource
243
243
data</td></tr></tbody></table><p>The <code class="function">gtk.rc_parse_string</code>() function parses
244
244
the string specified by <em class="parameter"><code>rc_string</code></em> for resource
245
data.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-reparse-all"></a><h3>gtk.rc_reparse_all</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_reparse_all</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><code class="literal">True</code> if the files were
245
data.</p></div><div class="refsect2" title="gtk.rc_reparse_all"><a name="function-gtk--rc-reparse-all"></a><h3>gtk.rc_reparse_all</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_reparse_all</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><code class="literal">True</code> if the files were
246
246
reparsed.</td></tr></tbody></table><p>The <code class="function">gtk.rc_reparse_all</code>() function discards
247
247
all style data and reparses all the RC files for resource data if any of
248
them have changed.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-find-module-in-path"></a><h3>gtk.rc_find_module_in_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_find_module_in_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>module_file</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>module_file</code></strong> :</span></p></td><td>the name of a theme engine</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the filename of the theme engine or
248
them have changed.</p></div><div class="refsect2" title="gtk.rc_find_module_in_path"><a name="function-gtk--rc-find-module-in-path"></a><h3>gtk.rc_find_module_in_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_find_module_in_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>module_file</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>module_file</code></strong> :</span></p></td><td>the name of a theme engine</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the filename of the theme engine or
249
249
<code class="literal">None</code></td></tr></tbody></table><p>The <code class="function">gtk.rc_find_module_in_path</code>() function
250
250
searches for a theme engine named by <em class="parameter"><code>module_file</code></em>.
251
This function is not useful for applications and should not be used.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-get-theme-dir"></a><h3>gtk.rc_get_theme_dir</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_theme_dir</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 name of the themes
251
This function is not useful for applications and should not be used.</p></div><div class="refsect2" title="gtk.rc_get_theme_dir"><a name="function-gtk--rc-get-theme-dir"></a><h3>gtk.rc_get_theme_dir</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_theme_dir</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 name of the themes
252
252
directory</td></tr></tbody></table><p>The <code class="function">gtk.rc_get_theme_dir</code>() function returns
253
the name of the directory where themes should be installed.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-get-module-dir"></a><h3>gtk.rc_get_module_dir</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_module_dir</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 theme engines directory
253
the name of the directory where themes should be installed.</p></div><div class="refsect2" title="gtk.rc_get_module_dir"><a name="function-gtk--rc-get-module-dir"></a><h3>gtk.rc_get_module_dir</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_module_dir</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 theme engines directory
254
254
name</td></tr></tbody></table><p>The <code class="function">gtk.rc_get_module_dir</code>() function
255
255
returns the name of the directory where <code class="literal">PyGTK</code> searches
256
for theme engines.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-get-im-module-path"></a><h3>gtk.rc_get_im_module_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_im_module_path</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 IM modules path</td></tr></tbody></table><p>The <code class="function">gtk.rc_get_im_module_path</code>() function
256
for theme engines.</p></div><div class="refsect2" title="gtk.rc_get_im_module_path"><a name="function-gtk--rc-get-im-module-path"></a><h3>gtk.rc_get_im_module_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_im_module_path</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 IM modules path</td></tr></tbody></table><p>The <code class="function">gtk.rc_get_im_module_path</code>() function
257
257
returns the path where <code class="literal">PyGTK</code> searches for IM
258
modules.</p></div><div class="refsect2" lang="en"><a name="function-gtk--rc-get-im-module-file"></a><h3>gtk.rc_get_im_module_file</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_im_module_file</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 name of the IM modules
258
modules.</p></div><div class="refsect2" title="gtk.rc_get_im_module_file"><a name="function-gtk--rc-get-im-module-file"></a><h3>gtk.rc_get_im_module_file</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.rc_get_im_module_file</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 name of the IM modules
259
259
file</td></tr></tbody></table><p>The <code class="function">gtk.rc_get_im_module_file</code>() function
260
260
returns the name of the <code class="literal">PyGTK</code> IM modules file.</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-gtkrange.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-gtkrecentaction.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Range </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.RecentAction</td></tr></table></div></body></html>
added
removed
docs/html/class-gtkrcstyle.html
