diff options
Diffstat (limited to 'docs/reference/pygtk-gdkcursor.xml')
| -rw-r--r-- | docs/reference/pygtk-gdkcursor.xml | 795 |
1 files changed, 0 insertions, 795 deletions
diff --git a/docs/reference/pygtk-gdkcursor.xml b/docs/reference/pygtk-gdkcursor.xml deleted file mode 100644 index 89186b43..00000000 --- a/docs/reference/pygtk-gdkcursor.xml +++ /dev/null @@ -1,795 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="class-gdkcursor"> - <refnamediv> - <refname>gtk.gdk.Cursor</refname> - <refpurpose>standard and pixmap cursors</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <classsynopsis language="python"> - <ooclass><classname>gtk.gdk.Cursor</classname></ooclass> - <ooclass><classname>gobject.GBoxed</classname></ooclass> - <constructorsynopsis language="python"> - <methodname><link -linkend="constructor-gdkcursor1">gtk.gdk.Cursor</link></methodname> - <methodparam><parameter role="keyword">cursor_type</parameter></methodparam> - </constructorsynopsis> - <constructorsynopsis language="python"> - <methodname><link -linkend="constructor-gdkcursor2">gtk.gdk.Cursor</link></methodname> - <methodparam><parameter role="keyword">display</parameter></methodparam> - <methodparam><parameter role="keyword">cursor_type</parameter></methodparam> - </constructorsynopsis> - <constructorsynopsis language="python"> - <methodname><link -linkend="constructor-gdkcursor3">gtk.gdk.Cursor</link></methodname> - <methodparam><parameter role="keyword">display</parameter></methodparam> - <methodparam><parameter role="keyword">pixbuf</parameter></methodparam> - <methodparam><parameter role="keyword">x</parameter></methodparam> - <methodparam><parameter role="keyword">y</parameter></methodparam> - </constructorsynopsis> - <constructorsynopsis language="python"> - <methodname><link -linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link></methodname> - <methodparam><parameter role="keyword">source</parameter></methodparam> - <methodparam><parameter role="keyword">mask</parameter></methodparam> - <methodparam><parameter role="keyword">fg</parameter></methodparam> - <methodparam><parameter role="keyword">bg</parameter></methodparam> - <methodparam><parameter role="keyword">x</parameter></methodparam> - <methodparam><parameter role="keyword">y</parameter></methodparam> - </constructorsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-gdkcursor--get-display">get_display</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - </classsynopsis> - - </refsect1> - - <refsect1> - <title>Description</title> - - <para>A <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> -represents a bitmap image used for the mouse pointer. Each <link -linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> can -have its own cursor. By default a <link -linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> uses -its parent's cursor. A standard set of cursors is provided in -<literal>PyGTK</literal>:</para> - - <variablelist> - <varlistentry> - <term><literal>gtk.gdk.X_CURSOR</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/X_cursor.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BASED_ARROW_DOWN</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/based_arrow_down.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BASED_ARROW_UP</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/based_arrow_up.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BOAT</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/boat.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BOGOSITY</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/bogosity.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BOTTOM_LEFT_CORNER</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/bottom_left_corner.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BOTTOM_RIGHT_CORNER</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/bottom_right_corner.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BOTTOM_SIDE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/bottom_side.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BOTTOM_TEE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/bottom_tee.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.BOX_SPIRAL</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/box_spiral.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CENTER_PTR</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/center_ptr.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CIRCLE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/circle.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CLOCK</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/clock.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.COFFEE_MUG</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/coffee_mug.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CROSS</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/cross.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CROSS_REVERSE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/cross_reverse.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.CROSSHAIR</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/crosshair.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.DIAMOND_CROSS</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/diamond_cross.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.DOT</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/dot.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.DOTBOX</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/dotbox.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.DOUBLE_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/double_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.DRAFT_LARGE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/draft_large.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.DRAFT_SMALL</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/draft_small.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.DRAPED_BOX</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/draped_box.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.EXCHANGE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/exchange.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.FLEUR</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/fleur.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.GOBBLER</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/gobbler.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.GUMBY</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/gumby.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.HAND1</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/hand1.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.HAND2</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/hand2.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.HEART</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/heart.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.ICON</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/icon.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.IRON_CROSS</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/iron_cross.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LEFT_PTR</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/left_ptr.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LEFT_SIDE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/left_side.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LEFT_TEE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/left_tee.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LEFTBUTTON</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/leftbutton.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LL_ANGLE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/ll_angle.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.LR_ANGLE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/lr_angle.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MAN</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/man.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MIDDLEBUTTON</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/middlebutton.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.MOUSE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/mouse.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.PENCIL</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/pencil.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.PIRATE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/pirate.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.PLUS</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/plus.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.QUESTION_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/question_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RIGHT_PTR</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/right_ptr.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RIGHT_SIDE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/right_side.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RIGHT_TEE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/right_tee.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RIGHTBUTTON</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/rightbutton.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.RTL_LOGO</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/rtl_logo.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SAILBOAT</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sailboat.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SB_DOWN_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sb_down_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SB_H_DOUBLE_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sb_h_double_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SB_LEFT_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sb_left_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SB_RIGHT_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sb_right_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SB_UP_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sb_up_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SB_V_DOUBLE_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sb_v_double_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SHUTTLE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/shuttle.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SIZING</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/sizing.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SPIDER</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/spider.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.SPRAYCAN</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/spraycan.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.STAR</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/star.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TARGET</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/target.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TCROSS</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/tcross.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TOP_LEFT_ARROW</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/top_left_arrow.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TOP_LEFT_CORNER</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/top_left_corner.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TOP_RIGHT_CORNER</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/top_right_corner.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TOP_SIDE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/top_side.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TOP_TEE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/top_tee.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.TREK</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/trek.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.UL_ANGLE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/ul_angle.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.UMBRELLA</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/umbrella.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.UR_ANGLE</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/ur_angle.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.WATCH</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/watch.png" format="png"/></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.gdk.XTERM</literal></term> - <listitem> - <simpara><imagedata fileref="cursors/xterm.png" format="png"/></simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect1> - - <refsect1> - <title>Constructor</title> - - <refsect2 id="constructor-gdkcursor1"> - - <programlisting><constructorsynopsis language="python"> - <methodname>gtk.gdk.Cursor</methodname> - <methodparam><parameter role="keyword">cursor_type</parameter></methodparam> - </constructorsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">cursor_type</parameter> :</term> - <listitem><simpara>the standard cursor to -create</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem> - </varlistentry> - </variablelist> - - <para>Creates the new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> from -a builtin cursor specified by <parameter>cursor_type</parameter>. To make -the cursor invisible, see the description of the <link -linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link>() constructor that -creates a cursor from a pixmap below.</para> - - </refsect2> - - <refsect2 id="constructor-gdkcursor2"> - - <programlisting><constructorsynopsis language="python"> - <methodname>gtk.gdk.Cursor</methodname> - <methodparam><parameter role="keyword">display</parameter></methodparam> - <methodparam><parameter role="keyword">cursor_type</parameter></methodparam> - </constructorsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">display</parameter> :</term> - <listitem><simpara>the <link - linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> - to create the cursor for</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">cursor_type</parameter> :</term> - <listitem><simpara>the standard cursor to -create</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This constructor is available in PyGTK 2.4 and above.</para> - </note> - - <para>Creates the new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> for -the <link -linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> -specified by <parameter>display</parameter> from a builtin cursor specified -by <parameter>cursor_type</parameter>. To make the cursor invisible, see the -description of the <link -linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link>() constructor that -creates a cursor from a pixmap below.</para> - - </refsect2> - - <refsect2 id="constructor-gdkcursor3"> - - <programlisting><constructorsynopsis language="python"> - <methodname>gtk.gdk.Cursor</methodname> - <methodparam><parameter role="keyword">display</parameter></methodparam> - <methodparam><parameter role="keyword">pixbuf</parameter></methodparam> - <methodparam><parameter role="keyword">x</parameter></methodparam> - <methodparam><parameter role="keyword">y</parameter></methodparam> - </constructorsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">display</parameter> :</term> - <listitem><simpara>the <link - linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> - to create the cursor for</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">pixbuf</parameter> :</term> - <listitem><simpara>the <link -linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> -holding the cursor image</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">x</parameter> :</term> - <listitem><simpara>the "hot spot" x offset</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">y</parameter> :</term> - <listitem><simpara>the "hot spot" y offset</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This constructor is available in PyGTK 2.4 and above.</para> - </note> - - <para>Creates a new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> for -the <link -linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> -specified by display using the <link -linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> -specified by <parameter>source</parameter> as the icon image. The "hotspot" -of the cursor will be located as the position specified by -<parameter>x</parameter> and <parameter>y</parameter>. To make the cursor -invisible, see the description of the <link -linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link>() constructor that -creates a cursor from a pixmap below</para> - - </refsect2> - - <refsect2 id="constructor-gdkcursor4"> - - <programlisting><constructorsynopsis language="python"> - <methodname>gtk.gdk.Cursor</methodname> - <methodparam><parameter role="keyword">source</parameter></methodparam> - <methodparam><parameter role="keyword">mask</parameter></methodparam> - <methodparam><parameter role="keyword">fg</parameter></methodparam> - <methodparam><parameter role="keyword">bg</parameter></methodparam> - <methodparam><parameter role="keyword">x</parameter></methodparam> - <methodparam><parameter role="keyword">y</parameter></methodparam> - </constructorsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">source</parameter> :</term> - <listitem><simpara>the <link -linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> -holding the cursor image</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">mask</parameter> :</term> - <listitem><simpara>the <link -linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> to -use as a mask</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">fg</parameter> :</term> - <listitem><simpara>the unallocated foreground <link -linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">bg</parameter> :</term> - <listitem><simpara>the unallocated background <link -linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">x</parameter> :</term> - <listitem><simpara>the "hot spot" x offset</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">y</parameter> :</term> - <listitem><simpara>the "hot spot" y offset</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem> - </varlistentry> - </variablelist> - - <para>Creates a new <link -linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> -using:</para> - - <itemizedlist> - <listitem> - <simpara>the <link -linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> -specified by <parameter>source</parameter> as the icon image</simpara> - </listitem> - <listitem> - <simpara>the <link -linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> -specified by <parameter>mask</parameter> to mask -<parameter>source</parameter> (must be the same size as source)</simpara> - </listitem> - <listitem> - <simpara>the <link -linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> -specified by <parameter>fg</parameter> as the foreground color of the -cursor</simpara> - </listitem> - <listitem> - <simpara>the <link -linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> -specified by <parameter>bg</parameter> as the background color of the -cursor</simpara> - </listitem> - <listitem> - <simpara>the horizontal offset of the cursor "hot spot" specified -by <parameter>x</parameter></simpara> - </listitem> - <listitem> - <simpara>the vertical offset of the cursor "hot spot" specified -by <parameter>y</parameter></simpara> - </listitem> - </itemizedlist> - - <para>To make the cursor invisible, create a cursor from an empty -<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> -as follows:</para> - - <programlisting> - pixmap = gtk.gdk.Pixmap(None, 1, 1, 1) - color = gtk.gdk.Color() - cursor = gtk.gdk.Cursor(pixmap, pixmap, color, color, 0, 0) -</programlisting> - - </refsect2> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-gdkcursor--get-display"> - <title>gtk.gdk.Cursor.get_display</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_display</methodname> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the associated <link -linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This method is available in PyGTK 2.2 and above.</para> - </note> - - <para>The <methodname>get_display</methodname>() method returns the -<link -linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> on -which the cursor is defined.</para> - - </refsect2> - - </refsect1> - -</refentry> |