~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gtksettings.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-01-07 11:08:47 UTC
  • mfrom: (1.2.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Settings</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-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><link rel="next" href="class-gtksizegroup.html" title="gtk.SizeGroup"></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.Settings</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkseparatortoolitem.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtksizegroup.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtksettings"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Settings</h2><p>gtk.Settings — an object that contains the global settings for the
2
 
widgets on a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></p></div><div class="refsect1" lang="en"><a name="id3680027"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Settings</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.Settings</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-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><link rel="next" href="class-gtksizegroup.html" title="gtk.SizeGroup"></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.Settings</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkseparatortoolitem.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtksizegroup.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Settings"><a name="class-gtksettings"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Settings</h2><p>gtk.Settings — an object that contains the global settings for the
 
2
widgets on a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></p></div><div class="refsect1" title="Synopsis"><a name="id3990017"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Settings</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
3
3
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtksettings.html#method-gtksettings--set-string-property" title="gtk.Settings.set_string_property">set_string_property</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_string</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtksettings.html#method-gtksettings--set-long-property" title="gtk.Settings.set_long_property">set_long_property</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_long</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtksettings.html#method-gtksettings--set-double-property" title="gtk.Settings.set_double_property">set_double_property</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_double</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
5
5
 
6
6
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtksettings.html#function-gtk--settings-get-default" title="gtk.settings_get_default">gtk.settings_get_default</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtksettings.html#function-gtk--settings-get-for-screen" title="gtk.settings_get_for_screen">gtk.settings_get_for_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code>
7
 
</pre></div><div class="refsect1" lang="en"><a name="id3680298"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
7
</pre></div><div class="refsect1" title="Ancestry"><a name="id3990288"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
8
8
  +-- <a class="link" href="class-gtksettings.html" title="gtk.Settings">gtk.Settings</a>
9
 
</pre></div><div class="refsect1" lang="en"><a name="properties-gtksettings"></a><h2>gtk.Settings Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"gtk-alternative-sort-arrows"</td><td valign="top">Read-Write</td><td valign="top">Controls the direction of the sort indicators in sorted list
 
9
</pre></div><div class="refsect1" title="gtk.Settings Properties"><a name="properties-gtksettings"></a><h2>gtk.Settings Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"gtk-alternative-sort-arrows"</td><td valign="top">Read-Write</td><td valign="top">Controls the direction of the sort indicators in sorted list
10
10
              and tree views. By default an arrow pointing down means the column
11
11
              is sorted in ascending order. When set to TRUE, this order will be inverted.
12
12
              Default value: <code class="literal">FALSE</code>
171
171
              full. Default value: <code class="literal">None</code>. Available in
172
172
              GTK+ 2.4 and above.</td></tr><tr valign="top"><td valign="top">"gtk-xft-rgba"</td><td valign="top">Read-Write</td><td valign="top">Type of subpixel antialiasing; none, rgb, bgr, vrgb,
173
173
              vbgr.  Default value: <code class="literal">None</code>. Available in
174
 
              GTK+ 2.4 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3681986"></a><h2>Description</h2><p>The <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
 
174
              GTK+ 2.4 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Description"><a name="id3991976"></a><h2>Description</h2><p>The <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
175
175
object stores the values of the global settings associated with a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>. The
176
176
<a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
177
177
object for the default <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a> can
179
179
function. The <a class="link" href="class-gtkwidget.html#method-gtkwidget--get-settings" title="gtk.Widget.get_settings"><code class="methodname">gtk.Widget.get_settings</code>()</a>
180
180
method returns the <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
181
181
object of the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a> that
182
 
the widget is displayed on.</p></div><div class="refsect1" lang="en"><a name="id3682064"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtksettings--set-string-property"></a><h3>gtk.Settings.set_string_property</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_string_property</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_string</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</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>name</code></strong> :</span></p></td><td>the name of the property to
 
182
the widget is displayed on.</p></div><div class="refsect1" title="Methods"><a name="id3992054"></a><h2>Methods</h2><div class="refsect2" title="gtk.Settings.set_string_property"><a name="method-gtksettings--set-string-property"></a><h3>gtk.Settings.set_string_property</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_string_property</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_string</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</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>name</code></strong> :</span></p></td><td>the name of the property to
183
183
set</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>v_string</code></strong> :</span></p></td><td>the string value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>origin</code></strong> :</span></p></td><td>the string value of the
184
184
origin</td></tr></tbody></table><p>The <code class="methodname">set_string_property</code>() method sets
185
185
the property named <em class="parameter"><code>name</code></em> to the string value specified
186
186
by <em class="parameter"><code>v_string</code></em> at the string origin specified by
187
187
<em class="parameter"><code>origin</code></em>. <em class="parameter"><code>origin</code></em> is an
188
188
application specified string like "filename:linenumber" or
189
 
"myapp:widgetname".</p></div><div class="refsect2" lang="en"><a name="method-gtksettings--set-long-property"></a><h3>gtk.Settings.set_long_property</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_long_property</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_long</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</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>name</code></strong> :</span></p></td><td>the name of the property to
 
189
"myapp:widgetname".</p></div><div class="refsect2" title="gtk.Settings.set_long_property"><a name="method-gtksettings--set-long-property"></a><h3>gtk.Settings.set_long_property</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_long_property</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_long</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</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>name</code></strong> :</span></p></td><td>the name of the property to
190
190
set</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>v_long</code></strong> :</span></p></td><td>the long value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>origin</code></strong> :</span></p></td><td>the string value of the
191
191
origin</td></tr></tbody></table><p>The <code class="methodname">set_long_property</code>() method sets the
192
192
property named <em class="parameter"><code>name</code></em> to the long value specified by
193
193
<em class="parameter"><code>v_long</code></em> at the string origin specified by
194
194
<em class="parameter"><code>origin</code></em>. <em class="parameter"><code>origin</code></em> is an
195
195
application specified string like "filename:linenumber" or
196
 
"myapp:widgetname".</p></div><div class="refsect2" lang="en"><a name="method-gtksettings--set-double-property"></a><h3>gtk.Settings.set_double_property</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_double_property</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_double</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</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>name</code></strong> :</span></p></td><td>the name of the property to
 
196
"myapp:widgetname".</p></div><div class="refsect2" title="gtk.Settings.set_double_property"><a name="method-gtksettings--set-double-property"></a><h3>gtk.Settings.set_double_property</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_double_property</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>v_double</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>origin</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>name</code></strong> :</span></p></td><td>the name of the property to
197
197
set</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>v_double</code></strong> :</span></p></td><td>the double value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>origin</code></strong> :</span></p></td><td>the string value of the
198
198
origin</td></tr></tbody></table><p>The <code class="methodname">set_double_property</code>() method sets
199
199
the property named <em class="parameter"><code>name</code></em> to the double value specified
200
200
by <em class="parameter"><code>v_long</code></em> at the string origin specified by
201
201
<em class="parameter"><code>origin</code></em>. <em class="parameter"><code>origin</code></em> is an
202
202
application specified string like "filename:linenumber" or
203
 
"myapp:widgetname".</p></div></div><div class="refsect1" lang="en"><a name="id3682602"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--settings-get-default"></a><h3>gtk.settings_get_default</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.settings_get_default</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 singleton <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
 
203
"myapp:widgetname".</p></div></div><div class="refsect1" title="Functions"><a name="id3992592"></a><h2>Functions</h2><div class="refsect2" title="gtk.settings_get_default"><a name="function-gtk--settings-get-default"></a><h3>gtk.settings_get_default</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.settings_get_default</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 singleton <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
204
204
object</td></tr></tbody></table><p>The <code class="function">gtk.settings_get_default</code> function
205
205
returns the singleton <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
206
 
object.</p></div><div class="refsect2" lang="en"><a name="function-gtk--settings-get-for-screen"></a><h3>gtk.settings_get_for_screen</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.settings_get_for_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</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>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
 
206
object.</p></div><div class="refsect2" title="gtk.settings_get_for_screen"><a name="function-gtk--settings-get-for-screen"></a><h3>gtk.settings_get_for_screen</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.settings_get_for_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</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>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
207
207
          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-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
208
 
          object</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.2 and above.</p></div><p>The <code class="function">gtk.settings_get_for_screen</code>() function
 
208
          object</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.2 and above.</p></div><p>The <code class="function">gtk.settings_get_for_screen</code>() function
209
209
returns the singleton <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
210
210
object for the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
211
211
specified by <em class="parameter"><code>screen</code></em>.</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-gtkseparatortoolitem.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-gtksizegroup.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.SeparatorToolItem </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.SizeGroup</td></tr></table></div></body></html>