Cursors
<!-- ##### SECTION Short_Description ##### -->
-
+Standard and pixmap cursors
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+These functions are used to create and destroy cursors.
+There is a number of standard cursors, but it is also
+possible to construct new cursors from pixmaps and
+pixbufs. There may be limitations as to what kinds of
+cursors can be constructed on a given display, see
+gdk_display_supports_cursor_alpha(),
+gdk_display_supports_cursor_color(),
+gdk_display_get_default_cursor_size() and
+gdk_display_get_maximal_cursor_size().
+</para>
+<para>
+Cursors by themselves are not very interesting, they must be be
+bound to a window for users to see them. This is done with
+gdk_window_set_cursor() or by setting the cursor member of the
+#GdkWindowAttr struct passed to gdk_window_new().
</para>
<!-- ##### SECTION See_Also ##### -->
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
<!-- ##### STRUCT GdkCursor ##### -->
<para>
-
+A <type>GdkCursor</type> structure represents a cursor.
</para>
-@type:
+@type: the #GdkCursorType of the cursor
<!-- ##### ENUM GdkCursorType ##### -->
<para>
The standard cursors available.
</para>
+@GDK_X_CURSOR: <inlinegraphic format="PNG" fileref="X_cursor.png"></inlinegraphic>
+@GDK_ARROW: <inlinegraphic format="PNG" fileref="arrow.png"></inlinegraphic>
+@GDK_BASED_ARROW_DOWN: <inlinegraphic format="PNG" fileref="based_arrow_down.png"></inlinegraphic>
+@GDK_BASED_ARROW_UP: <inlinegraphic format="PNG" fileref="based_arrow_up.png"></inlinegraphic>
+@GDK_BOAT: <inlinegraphic format="PNG" fileref="boat.png"></inlinegraphic>
+@GDK_BOGOSITY: <inlinegraphic format="PNG" fileref="bogosity.png"></inlinegraphic>
+@GDK_BOTTOM_LEFT_CORNER: <inlinegraphic format="PNG" fileref="bottom_left_corner.png"></inlinegraphic>
+@GDK_BOTTOM_RIGHT_CORNER: <inlinegraphic format="PNG" fileref="bottom_right_corner.png"></inlinegraphic>
+@GDK_BOTTOM_SIDE: <inlinegraphic format="PNG" fileref="bottom_side.png"></inlinegraphic>
+@GDK_BOTTOM_TEE: <inlinegraphic format="PNG" fileref="bottom_tee.png"></inlinegraphic>
+@GDK_BOX_SPIRAL: <inlinegraphic format="PNG" fileref="box_spiral.png"></inlinegraphic>
+@GDK_CENTER_PTR: <inlinegraphic format="PNG" fileref="center_ptr.png"></inlinegraphic>
+@GDK_CIRCLE: <inlinegraphic format="PNG" fileref="circle.png"></inlinegraphic>
+@GDK_CLOCK: <inlinegraphic format="PNG" fileref="clock.png"></inlinegraphic>
+@GDK_COFFEE_MUG: <inlinegraphic format="PNG" fileref="coffee_mug.png"></inlinegraphic>
+@GDK_CROSS: <inlinegraphic format="PNG" fileref="cross.png"></inlinegraphic>
+@GDK_CROSS_REVERSE: <inlinegraphic format="PNG" fileref="cross_reverse.png"></inlinegraphic>
+@GDK_CROSSHAIR: <inlinegraphic format="PNG" fileref="crosshair.png"></inlinegraphic>
+@GDK_DIAMOND_CROSS: <inlinegraphic format="PNG" fileref="diamond_cross.png"></inlinegraphic>
+@GDK_DOT: <inlinegraphic format="PNG" fileref="dot.png"></inlinegraphic>
+@GDK_DOTBOX: <inlinegraphic format="PNG" fileref="dotbox.png"></inlinegraphic>
+@GDK_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="double_arrow.png"></inlinegraphic>
+@GDK_DRAFT_LARGE: <inlinegraphic format="PNG" fileref="draft_large.png"></inlinegraphic>
+@GDK_DRAFT_SMALL: <inlinegraphic format="PNG" fileref="draft_small.png"></inlinegraphic>
+@GDK_DRAPED_BOX: <inlinegraphic format="PNG" fileref="draped_box.png"></inlinegraphic>
+@GDK_EXCHANGE: <inlinegraphic format="PNG" fileref="exchange.png"></inlinegraphic>
+@GDK_FLEUR: <inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic>
+@GDK_GOBBLER: <inlinegraphic format="PNG" fileref="gobbler.png"></inlinegraphic>
+@GDK_GUMBY: <inlinegraphic format="PNG" fileref="gumby.png"></inlinegraphic>
+@GDK_HAND1: <inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic>
+@GDK_HAND2: <inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic>
+@GDK_HEART: <inlinegraphic format="PNG" fileref="heart.png"></inlinegraphic>
+@GDK_ICON: <inlinegraphic format="PNG" fileref="icon.png"></inlinegraphic>
+@GDK_IRON_CROSS: <inlinegraphic format="PNG" fileref="iron_cross.png"></inlinegraphic>
+@GDK_LEFT_PTR: <inlinegraphic format="PNG" fileref="left_ptr.png"></inlinegraphic>
+@GDK_LEFT_SIDE: <inlinegraphic format="PNG" fileref="left_side.png"></inlinegraphic>
+@GDK_LEFT_TEE: <inlinegraphic format="PNG" fileref="left_tee.png"></inlinegraphic>
+@GDK_LEFTBUTTON: <inlinegraphic format="PNG" fileref="leftbutton.png"></inlinegraphic>
+@GDK_LL_ANGLE: <inlinegraphic format="PNG" fileref="ll_angle.png"></inlinegraphic>
+@GDK_LR_ANGLE: <inlinegraphic format="PNG" fileref="lr_angle.png"></inlinegraphic>
+@GDK_MAN: <inlinegraphic format="PNG" fileref="man.png"></inlinegraphic>
+@GDK_MIDDLEBUTTON: <inlinegraphic format="PNG" fileref="middlebutton.png"></inlinegraphic>
+@GDK_MOUSE: <inlinegraphic format="PNG" fileref="mouse.png"></inlinegraphic>
+@GDK_PENCIL: <inlinegraphic format="PNG" fileref="pencil.png"></inlinegraphic>
+@GDK_PIRATE: <inlinegraphic format="PNG" fileref="pirate.png"></inlinegraphic>
+@GDK_PLUS: <inlinegraphic format="PNG" fileref="plus.png"></inlinegraphic>
+@GDK_QUESTION_ARROW: <inlinegraphic format="PNG" fileref="question_arrow.png"></inlinegraphic>
+@GDK_RIGHT_PTR: <inlinegraphic format="PNG" fileref="right_ptr.png"></inlinegraphic>
+@GDK_RIGHT_SIDE: <inlinegraphic format="PNG" fileref="right_side.png"></inlinegraphic>
+@GDK_RIGHT_TEE: <inlinegraphic format="PNG" fileref="right_tee.png"></inlinegraphic>
+@GDK_RIGHTBUTTON: <inlinegraphic format="PNG" fileref="rightbutton.png"></inlinegraphic>
+@GDK_RTL_LOGO: <inlinegraphic format="PNG" fileref="rtl_logo.png"></inlinegraphic>
+@GDK_SAILBOAT: <inlinegraphic format="PNG" fileref="sailboat.png"></inlinegraphic>
+@GDK_SB_DOWN_ARROW: <inlinegraphic format="PNG" fileref="sb_down_arrow.png"></inlinegraphic>
+@GDK_SB_H_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="sb_h_double_arrow.png"></inlinegraphic>
+@GDK_SB_LEFT_ARROW: <inlinegraphic format="PNG" fileref="sb_left_arrow.png"></inlinegraphic>
+@GDK_SB_RIGHT_ARROW: <inlinegraphic format="PNG" fileref="sb_right_arrow.png"></inlinegraphic>
+@GDK_SB_UP_ARROW: <inlinegraphic format="PNG" fileref="sb_up_arrow.png"></inlinegraphic>
+@GDK_SB_V_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="sb_v_double_arrow.png"></inlinegraphic>
+@GDK_SHUTTLE: <inlinegraphic format="PNG" fileref="shuttle.png"></inlinegraphic>
+@GDK_SIZING: <inlinegraphic format="PNG" fileref="sizing.png"></inlinegraphic>
+@GDK_SPIDER: <inlinegraphic format="PNG" fileref="spider.png"></inlinegraphic>
+@GDK_SPRAYCAN: <inlinegraphic format="PNG" fileref="spraycan.png"></inlinegraphic>
+@GDK_STAR: <inlinegraphic format="PNG" fileref="star.png"></inlinegraphic>
+@GDK_TARGET: <inlinegraphic format="PNG" fileref="target.png"></inlinegraphic>
+@GDK_TCROSS: <inlinegraphic format="PNG" fileref="tcross.png"></inlinegraphic>
+@GDK_TOP_LEFT_ARROW: <inlinegraphic format="PNG" fileref="top_left_arrow.png"></inlinegraphic>
+@GDK_TOP_LEFT_CORNER: <inlinegraphic format="PNG" fileref="top_left_corner.png"></inlinegraphic>
+@GDK_TOP_RIGHT_CORNER: <inlinegraphic format="PNG" fileref="top_right_corner.png"></inlinegraphic>
+@GDK_TOP_SIDE: <inlinegraphic format="PNG" fileref="top_side.png"></inlinegraphic>
+@GDK_TOP_TEE: <inlinegraphic format="PNG" fileref="top_tee.png"></inlinegraphic>
+@GDK_TREK: <inlinegraphic format="PNG" fileref="trek.png"></inlinegraphic>
+@GDK_UL_ANGLE: <inlinegraphic format="PNG" fileref="ul_angle.png"></inlinegraphic>
+@GDK_UMBRELLA: <inlinegraphic format="PNG" fileref="umbrella.png"></inlinegraphic>
+@GDK_UR_ANGLE: <inlinegraphic format="PNG" fileref="ur_angle.png"></inlinegraphic>
+@GDK_WATCH: <inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic>
+@GDK_XTERM: <inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic>
+@GDK_LAST_CURSOR: last cursor type
+@GDK_BLANK_CURSOR: Blank cursor. Since 2.16
+@GDK_CURSOR_IS_PIXMAP: type of cursors constructed with
+ gdk_cursor_new_from_pixmap() or gdk_cursor_new_from_pixbuf()
<!-- ##### FUNCTION gdk_cursor_new ##### -->
<para>
-Creates a new standard cursor.
+
</para>
-@cursor_type: the type of the cursor.
-@Returns: a new #GdkCursor.
+@cursor_type:
+@Returns:
<!-- ##### FUNCTION gdk_cursor_new_from_pixmap ##### -->
<para>
-Creates a new cursor from a given pixmap and mask. Both the pixmap and mask
-must have a depth of 1 (i.e. each pixel has only 2 values - on or off).
</para>
-<example><title>Creating a custom cursor.</title>
-<programlisting>
-/* This data is in X bitmap format, and can be created with the 'bitmap'
- utility. */
-#define cursor1_width 16
-#define cursor1_height 16
-static unsigned char cursor1_bits[] = {
- 0x80, 0x01, 0x40, 0x02, 0x20, 0x04, 0x10, 0x08, 0x08, 0x10, 0x04, 0x20,
- 0x82, 0x41, 0x41, 0x82, 0x41, 0x82, 0x82, 0x41, 0x04, 0x20, 0x08, 0x10,
- 0x10, 0x08, 0x20, 0x04, 0x40, 0x02, 0x80, 0x01};
-
-static unsigned char cursor1mask_bits[] = {
- 0x80, 0x01, 0xc0, 0x03, 0x60, 0x06, 0x30, 0x0c, 0x18, 0x18, 0x8c, 0x31,
- 0xc6, 0x63, 0x63, 0xc6, 0x63, 0xc6, 0xc6, 0x63, 0x8c, 0x31, 0x18, 0x18,
- 0x30, 0x0c, 0x60, 0x06, 0xc0, 0x03, 0x80, 0x01};
-
-
- GdkCursor *cursor;
- GdkPixmap *source, *mask;
- GdkColor fg = { 0, 65535, 0, 0 }; /* Red. */
- GdkColor bg = { 0, 0, 0, 65535 }; /* Blue. */
-
-
- source = gdk_bitmap_create_from_data (NULL, cursor1_bits,
- cursor1_width, cursor1_height);
- mask = gdk_bitmap_create_from_data (NULL, cursor1mask_bits,
- cursor1_width, cursor1_height);
- cursor = gdk_cursor_new_from_pixmap (source, mask, &fg, &bg, 8, 8);
- gdk_pixmap_unref (source);
- gdk_pixmap_unref (mask);
-
-
- gdk_window_set_cursor (widget->window, cursor);
-</programlisting>
-</example>
-
-@source: the pixmap specifying the cursor.
-@mask: the pixmap specifying the mask, which must be the same size as @source.
-@fg: the foreground color, used for the bits in the source which are 1.
-The color does not have to be allocated first.
-@bg: the background color, used for the bits in the source which are 0.
-The color does not have to be allocated first.
-@x: the horizontal offset of the 'hotspot' of the cursor.
-@y: the vertical offset of the 'hotspot' of the cursor.
-@Returns: a new #GdkCursor.
-
-
-<!-- ##### FUNCTION gdk_cursor_destroy ##### -->
+
+@source:
+@mask:
+@fg:
+@bg:
+@x:
+@y:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_cursor_new_from_pixbuf ##### -->
+<para>
+
+</para>
+
+@display:
+@pixbuf:
+@x:
+@y:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_cursor_new_from_name ##### -->
+<para>
+
+</para>
+
+@display:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_cursor_new_for_display ##### -->
+<para>
+
+</para>
+
+@display:
+@cursor_type:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_cursor_get_display ##### -->
<para>
-Destroys a cursor, freeing any resources allocated for it.
+
+</para>
+
+@cursor:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_cursor_get_image ##### -->
+<para>
+
+</para>
+
+@cursor:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_cursor_ref ##### -->
+<para>
+
+</para>
+
+@cursor:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_cursor_unref ##### -->
+<para>
+
</para>
-@cursor: a #GdkCursor.
+@cursor:
projects / ~andy / gtk / blobdiff