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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.gdk.Atom</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="previous" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="next" href="class-gdkcolor.html" title="gtk.gdk.Color"></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.gdk.Atom</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gdk-class-reference.html">Prev</a></td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gdkcolor.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkatom"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.gdk.Atom</h2><p>gtk.gdk.Atom — an object representing an interned string</p></div><div class="refsect1" lang="en"><a name="id3131974"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Atom</span></span>:
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gdkatom.html#constructor-gdkatom-intern" title="Constructor">gtk.gdk.atom_intern</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>name</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>only_if_exists</tt></b></span><span class="initializer">=FALSE</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3131935"></a><h2>Description</h2><p><a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a> is a
<tt class="literal">PyGTK</tt> class that wraps the <tt class="literal">GTK</tt>+
<span class="type">GdkAtom</span> - an unsigned integer representing an interned
string. An interned string is a string that has an internal
<tt class="literal">GTK</tt>+ mapping between an atom and a string. <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a> has no
methods. A copy of the interned string can be retrieved by using the Python
<tt class="function">str()</tt> function. <a href="class-gdkatom.html#constructor-gdkatom-intern" title="Constructor">gtk.gdk.atom_intern</a>() will
return a <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a>
referencing an existing interned string but will intern a string if it isn't
already interned.</p><p><a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a> objects
are used to provide the targets for <a href="class-gtkselectiondata.html" title="gtk.SelectionData"><tt class="classname">gtk.SelectionData</tt></a>
objects that are used by <a href="class-gtkclipboard.html" title="gtk.Clipboard"><tt class="classname">gtk.Clipboard</tt></a> and
<a href="class-gtktreeview.html" title="gtk.TreeView"><tt class="classname">gtk.TreeView</tt></a>,
objects and for drag and drop (see <a href="class-gdkdragcontext.html" title="gtk.gdk.DragContext"><tt class="classname">gtk.gdk.DragContext</tt></a>,
<a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a>
and <a href="class-gtktreedragsource.html" title="gtk.TreeDragSource"><tt class="classname">gtk.TreeDragSource</tt></a>
and <a href="class-gtkwidget.html" title="gtk.Widget"><tt class="classname">gtk.Widget</tt></a>
for more information). The advantage of the interned string is that it is
easy to pass between processes and even systems since only an integer value
is passed.</p><p><tt class="literal">PyGTK</tt> 2.4 has a number of pre-defined atoms
that map to builtin <tt class="literal">GTK+</tt> interned string atoms. The
interned strings and the <tt class="literal">PyGTK</tt> 2.4 <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a> objects
are:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"PRIMARY"</span></td><td><tt class="literal">gtk.gdk.SELECTION_PRIMARY</tt></td></tr><tr><td><span class="term">"SECONDARY"</span></td><td><tt class="literal">gtk.gdk.SELECTION_SECONDARY</tt></td></tr><tr><td><span class="term">"CLIPBOARD"</span></td><td><tt class="literal">gtk.gdk.SELECTION_CLIPBOARD</tt></td></tr><tr><td><span class="term">"ATOM"</span></td><td><tt class="literal">gtk.gdk.SELECTION_TYPE_ATOM</tt></td></tr><tr><td><span class="term">"BITMAP"</span></td><td><tt class="literal">gtk.gdk.TARGET_BITMAP</tt> or
<tt class="literal">gtk.gdk.SELECTION_TYPE_BITMAP</tt></td></tr><tr><td><span class="term">"COLORMAP"</span></td><td><tt class="literal">gtk.gdk.TARGET_COLORMAP</tt> or
<tt class="literal">gtk.gdk.SELECTION_TYPE_COLORMAP</tt></td></tr><tr><td><span class="term">"DRAWABLE"</span></td><td><tt class="literal">gtk.gdk.TARGET_DRAWABLE</tt> or
<tt class="literal">gtk.gdk.SELECTION_TYPE_DRAWABLE</tt></td></tr><tr><td><span class="term">"PIXMAP"</span></td><td><tt class="literal">gtk.gdk.TARGET_PIXMAP</tt> or
<tt class="literal">gtk.gdk.SELECTION_TYPE_PIXMAP</tt></td></tr><tr><td><span class="term">"STRING"</span></td><td><tt class="literal">gtk.gdk.TARGET_STRING</tt> or
<tt class="literal">gtk.gdk.SELECTION_TYPE_STRING</tt></td></tr><tr><td><span class="term">"WINDOW"</span></td><td><tt class="literal">gtk.gdk.SELECTION_TYPE_WINDOW</tt></td></tr></tbody></table><p>Also in <tt class="literal">PyGTK</tt> 2.4, comparison between a string
and a <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a> is
supported.</p></div><div class="refsect1" lang="en"><a name="constructor-gdkatom-intern"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.atom_intern</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>name</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>only_if_exists</tt></b></span><span class="initializer">=FALSE</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>name</tt></b>:</span></td><td>the string to be interned or
retrieved</td></tr><tr><td><span class="term"><b class="parameter"><tt>only_if_exists</tt></b>:</span></td><td>this value is ignored</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a>
or <tt class="literal">None</tt></td></tr></tbody></table><p>Creates a <a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a>
referencing the interned string specified by <i class="parameter"><tt>name</tt></i>. An
interned string is a string that has a <tt class="literal">GTK</tt>+ mapping to an
unsigned integer value. This constructor will intern the string and create a
<a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a> if
it does not already exist. <i class="parameter"><tt>only_if_exists</tt></i> is
ignored and essentially is always <tt class="literal">FALSE</tt>.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gdk-class-reference.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gdk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gdkcolor.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The gtk.gdk Class Reference</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.gdk.Color</td></tr></table></div></body></html>
|
