~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed : contents of docs/html/class-gdkcursor.html at revision 60

~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed : (revision 60)
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Cursor</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="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkcolormap.html" title="gtk.gdk.Colormap"><link rel="next" href="class-gdkdevice.html" title="gtk.gdk.Device"></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.Cursor</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkcolormap.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-gdkdevice.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.gdk.Cursor"><a name="class-gdkcursor"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Cursor</h2><p>gtk.gdk.Cursor — standard and pixmap cursors</p></div><div class="refsect1" title="Synopsis"><a name="id3065918"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Cursor</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gdkcursor.html#constructor-gdkcursor1">gtk.gdk.Cursor</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>cursor_type</code></strong></span></span>)</code><br><code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gdkcursor.html#constructor-gdkcursor2">gtk.gdk.Cursor</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>cursor_type</code></strong></span></span>)</code><br><code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gdkcursor.html#constructor-gdkcursor3">gtk.gdk.Cursor</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>)</code><br><code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gdkcursor.html#constructor-gdkcursor4">gtk.gdk.Cursor</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>source</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mask</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>fg</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>bg</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkcursor.html#method-gdkcursor--get-display" title="gtk.gdk.Cursor.get_display">get_display</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id3055404"></a><h2>Description</h2><p>A <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</code></a>
represents a bitmap image used for the mouse pointer. Each <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a> can
have its own cursor. By default a <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a> uses
its parent's cursor. A standard set of cursors is provided in
<code class="literal">PyGTK</code>:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><code class="literal">gtk.gdk.X_CURSOR</code></span></p></td><td><img src="cursors/X_cursor.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.ARROW</code></span></p></td><td><img src="cursors/arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BASED_ARROW_DOWN</code></span></p></td><td><img src="cursors/based_arrow_down.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BASED_ARROW_UP</code></span></p></td><td><img src="cursors/based_arrow_up.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BOAT</code></span></p></td><td><img src="cursors/boat.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BOGOSITY</code></span></p></td><td><img src="cursors/bogosity.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BOTTOM_LEFT_CORNER</code></span></p></td><td><img src="cursors/bottom_left_corner.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BOTTOM_RIGHT_CORNER</code></span></p></td><td><img src="cursors/bottom_right_corner.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BOTTOM_SIDE</code></span></p></td><td><img src="cursors/bottom_side.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BOTTOM_TEE</code></span></p></td><td><img src="cursors/bottom_tee.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BOX_SPIRAL</code></span></p></td><td><img src="cursors/box_spiral.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CENTER_PTR</code></span></p></td><td><img src="cursors/center_ptr.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CIRCLE</code></span></p></td><td><img src="cursors/circle.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CLOCK</code></span></p></td><td><img src="cursors/clock.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.COFFEE_MUG</code></span></p></td><td><img src="cursors/coffee_mug.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CROSS</code></span></p></td><td><img src="cursors/cross.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CROSS_REVERSE</code></span></p></td><td><img src="cursors/cross_reverse.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CROSSHAIR</code></span></p></td><td><img src="cursors/crosshair.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DIAMOND_CROSS</code></span></p></td><td><img src="cursors/diamond_cross.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DOT</code></span></p></td><td><img src="cursors/dot.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DOTBOX</code></span></p></td><td><img src="cursors/dotbox.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DOUBLE_ARROW</code></span></p></td><td><img src="cursors/double_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DRAFT_LARGE</code></span></p></td><td><img src="cursors/draft_large.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DRAFT_SMALL</code></span></p></td><td><img src="cursors/draft_small.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DRAPED_BOX</code></span></p></td><td><img src="cursors/draped_box.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.EXCHANGE</code></span></p></td><td><img src="cursors/exchange.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.FLEUR</code></span></p></td><td><img src="cursors/fleur.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.GOBBLER</code></span></p></td><td><img src="cursors/gobbler.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.GUMBY</code></span></p></td><td><img src="cursors/gumby.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.HAND1</code></span></p></td><td><img src="cursors/hand1.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.HAND2</code></span></p></td><td><img src="cursors/hand2.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.HEART</code></span></p></td><td><img src="cursors/heart.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.ICON</code></span></p></td><td><img src="cursors/icon.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.IRON_CROSS</code></span></p></td><td><img src="cursors/iron_cross.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.LEFT_PTR</code></span></p></td><td><img src="cursors/left_ptr.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.LEFT_SIDE</code></span></p></td><td><img src="cursors/left_side.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.LEFT_TEE</code></span></p></td><td><img src="cursors/left_tee.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.LEFTBUTTON</code></span></p></td><td><img src="cursors/leftbutton.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.LL_ANGLE</code></span></p></td><td><img src="cursors/ll_angle.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.LR_ANGLE</code></span></p></td><td><img src="cursors/lr_angle.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.MAN</code></span></p></td><td><img src="cursors/man.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.MIDDLEBUTTON</code></span></p></td><td><img src="cursors/middlebutton.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.MOUSE</code></span></p></td><td><img src="cursors/mouse.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.PENCIL</code></span></p></td><td><img src="cursors/pencil.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.PIRATE</code></span></p></td><td><img src="cursors/pirate.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.PLUS</code></span></p></td><td><img src="cursors/plus.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.QUESTION_ARROW</code></span></p></td><td><img src="cursors/question_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.RIGHT_PTR</code></span></p></td><td><img src="cursors/right_ptr.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.RIGHT_SIDE</code></span></p></td><td><img src="cursors/right_side.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.RIGHT_TEE</code></span></p></td><td><img src="cursors/right_tee.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.RIGHTBUTTON</code></span></p></td><td><img src="cursors/rightbutton.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.RTL_LOGO</code></span></p></td><td><img src="cursors/rtl_logo.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SAILBOAT</code></span></p></td><td><img src="cursors/sailboat.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SB_DOWN_ARROW</code></span></p></td><td><img src="cursors/sb_down_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SB_H_DOUBLE_ARROW</code></span></p></td><td><img src="cursors/sb_h_double_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SB_LEFT_ARROW</code></span></p></td><td><img src="cursors/sb_left_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SB_RIGHT_ARROW</code></span></p></td><td><img src="cursors/sb_right_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SB_UP_ARROW</code></span></p></td><td><img src="cursors/sb_up_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SB_V_DOUBLE_ARROW</code></span></p></td><td><img src="cursors/sb_v_double_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SHUTTLE</code></span></p></td><td><img src="cursors/shuttle.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SIZING</code></span></p></td><td><img src="cursors/sizing.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SPIDER</code></span></p></td><td><img src="cursors/spider.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SPRAYCAN</code></span></p></td><td><img src="cursors/spraycan.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.STAR</code></span></p></td><td><img src="cursors/star.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TARGET</code></span></p></td><td><img src="cursors/target.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TCROSS</code></span></p></td><td><img src="cursors/tcross.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TOP_LEFT_ARROW</code></span></p></td><td><img src="cursors/top_left_arrow.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TOP_LEFT_CORNER</code></span></p></td><td><img src="cursors/top_left_corner.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TOP_RIGHT_CORNER</code></span></p></td><td><img src="cursors/top_right_corner.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TOP_SIDE</code></span></p></td><td><img src="cursors/top_side.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TOP_TEE</code></span></p></td><td><img src="cursors/top_tee.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.TREK</code></span></p></td><td><img src="cursors/trek.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.UL_ANGLE</code></span></p></td><td><img src="cursors/ul_angle.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.UMBRELLA</code></span></p></td><td><img src="cursors/umbrella.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.UR_ANGLE</code></span></p></td><td><img src="cursors/ur_angle.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.WATCH</code></span></p></td><td><img src="cursors/watch.png"></td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.XTERM</code></span></p></td><td><img src="cursors/xterm.png"></td></tr></tbody></table><p></p></div><div class="refsect1" title="Constructor"><a name="id3142009"></a><h2>Constructor</h2><div class="refsect2"><a name="constructor-gdkcursor1"></a><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.gdk.Cursor</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>cursor_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>cursor_type</code></strong> :</span></p></td><td>the standard cursor to
create</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</code></a></td></tr></tbody></table><p>Creates the new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</code></a> from
a builtin cursor specified by <em class="parameter"><code>cursor_type</code></em>. To make
the cursor invisible, see the description of the <a class="link" href="class-gdkcursor.html#constructor-gdkcursor4">gtk.gdk.Cursor</a>() constructor that
creates a cursor from a pixmap below.</p></div><div class="refsect2"><a name="constructor-gdkcursor2"></a><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.gdk.Cursor</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>cursor_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>display</code></strong> :</span></p></td><td>the <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
	  to create the cursor for</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>cursor_type</code></strong> :</span></p></td><td>the standard cursor to
create</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</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 constructor is available in PyGTK 2.4 and above.</p></div><p>Creates the new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</code></a> for
the <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
specified by <em class="parameter"><code>display</code></em> from a builtin cursor specified
by <em class="parameter"><code>cursor_type</code></em>. To make the cursor invisible, see the
description of the <a class="link" href="class-gdkcursor.html#constructor-gdkcursor4">gtk.gdk.Cursor</a>() constructor that
creates a cursor from a pixmap below.</p></div><div class="refsect2"><a name="constructor-gdkcursor3"></a><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.gdk.Cursor</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</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>display</code></strong> :</span></p></td><td>the <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
	  to create the cursor for</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>pixbuf</code></strong> :</span></p></td><td>the <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
holding the cursor image</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>the "hot spot" x offset</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>the "hot spot" y offset</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</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 constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</code></a> for
the <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
specified by display using the <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
specified by <em class="parameter"><code>source</code></em> as the icon image. The "hotspot"
of the cursor will be located as the position specified by
<em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>. To make the cursor
invisible, see the description of the <a class="link" href="class-gdkcursor.html#constructor-gdkcursor4">gtk.gdk.Cursor</a>() constructor that
creates a cursor from a pixmap below</p></div><div class="refsect2"><a name="constructor-gdkcursor4"></a><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.gdk.Cursor</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>source</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mask</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>fg</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>bg</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</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>source</code></strong> :</span></p></td><td>the <a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a>
holding the cursor image</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>mask</code></strong> :</span></p></td><td>the <a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a> to
use as a mask</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>fg</code></strong> :</span></p></td><td>the unallocated foreground <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>bg</code></strong> :</span></p></td><td>the unallocated background <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>the "hot spot" x offset</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>the "hot spot" y offset</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</code></a></td></tr></tbody></table><p>Creates a new <a class="link" href="class-gdkcursor.html" title="gtk.gdk.Cursor"><code class="classname">gtk.gdk.Cursor</code></a>
using:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">the <a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a>
specified by <em class="parameter"><code>source</code></em> as the icon image</li><li class="listitem">the <a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a>
specified by <em class="parameter"><code>mask</code></em> to mask
<em class="parameter"><code>source</code></em> (must be the same size as source)</li><li class="listitem">the <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>
specified by <em class="parameter"><code>fg</code></em> as the foreground color of the
cursor</li><li class="listitem">the <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>
specified by <em class="parameter"><code>bg</code></em> as the background color of the
cursor</li><li class="listitem">the horizontal offset of the cursor "hot spot" specified
by <em class="parameter"><code>x</code></em></li><li class="listitem">the vertical offset of the cursor "hot spot" specified
by <em class="parameter"><code>y</code></em></li></ul></div><p>To make the cursor invisible, create a cursor from an empty
<a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a>
as follows:</p><pre class="programlisting">
  pixmap = gtk.gdk.Pixmap(None, 1, 1, 1)
  color = gtk.gdk.Color()
  cursor = gtk.gdk.Cursor(pixmap, pixmap, color, color, 0, 0)
</pre></div></div><div class="refsect1" title="Methods"><a name="id3245514"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.Cursor.get_display"><a name="method-gdkcursor--get-display"></a><h3>gtk.gdk.Cursor.get_display</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_display</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 associated <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</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.2 and above.</p></div><p>The <code class="methodname">get_display</code>() method returns the
<a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a> on
which the cursor is defined.</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-gdkcolormap.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-gdkdevice.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.gdk.Colormap </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.gdk.Device</td></tr></table></div></body></html>