AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-11-08 01:30:10 +00:00
Code Issues Projects Releases Wiki Activity
621fb7466a
gtk/docs/reference/gdk/tmpl/cursors.sgml

219 lines
9.6 KiB
Plaintext
Raw Normal View History

Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
Cursors
<!-- ##### SECTION Short_Description ##### -->
new section from Lee Mallabone. 1999-08-28 Damon Chaplin <damon@karuna.freeserve.co.uk> * gtk/tmpl/gtkbbox.sgml: new section from Lee Mallabone. * gdk/gdk-sections.txt: rearranged rgb, regions, and drawing sections. * gdk/tmpl/rgb.sgml: new section from Raph Levien, with a few changes by me, including a little example app. * gdk/tmpl/regions.sgml: * gdk/tmpl/event_structs.sgml: * gdk/tmpl/drawing.sgml: my first attempt. * gdk/tmpl/cursors.sgml: tiny changes.
1999-08-28 20:47:33 +00:00
standard and pixmap cursors.
Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkCursor ##### -->
<para>
Directly include the contents of gdkcursors.h in the GdkCursorType enum. * gdk/gdkcursor.h: Directly include the contents of gdkcursors.h in the GdkCursorType enum. * gdk/gdkcursors.h: Deleted. * gdk/gdkkeysyms.h: Remove XFree86-specific keysyms, add header boilerplate. * gdk/Makefile.am: Remove the X-derived-headers rule. * gdk/tmpl/cursors.sgml: Document GdkCursor and standard cursors.
2001-11-28 18:38:43 +00:00
A <type>GdkCursor</type> structure represents a cursor.
Initial revision
1999-08-16 18:51:52 +00:00
</para>
@type:
Move gtk-reference files into GTK+ tree proper. Thu Sep 7 14:15:03 2000 Owen Taylor <otaylor@redhat.com> * gdk/* gtk/*: Move gtk-reference files into GTK+ tree proper. * Update sections.txt files to correspond to current code, tweak .sgml files and Makefiles to correspond. * gtk/tmpl/gtkradiomenuitem.sgml (this): Remove extra <para>
2000-09-07 18:17:06 +00:00
@ref_count:
Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GdkCursorType ##### -->
<para>
The standard cursors available.
</para>
Markup fixes * gtk/gtkwindow.c (gtk_window_move): Markup fixes * gtk/gtkrc.c (gtk_rc_get_module_dir): Markup fixes. * gdk/x11/gdkcursor-x11.c (gdk_cursor_new_for_screen): Update docs for Docbook XML. * gtk/*, gdk/*, gdk-pixbuf/*: Create XML, not SGML. * gtk/tmpl/*: Remove property documentation which comes from the source now. * gtk/building.sgml: Remove traces of gxi.
2002-05-28 22:23:55 +00:00
@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>
fix up my list of "cursors that are actually useful" in gdk_cursor_new() 2001-12-07 Havoc Pennington <hp@pobox.com> * gdk/x11/gdkcursor-x11.c (gdk_cursor_new): fix up my list of "cursors that are actually useful" in gdk_cursor_new() docs
2001-12-07 05:27:17 +00:00
@GDK_LAST_CURSOR:
Directly include the contents of gdkcursors.h in the GdkCursorType enum. * gdk/gdkcursor.h: Directly include the contents of gdkcursors.h in the GdkCursorType enum. * gdk/gdkcursors.h: Deleted. * gdk/gdkkeysyms.h: Remove XFree86-specific keysyms, add header boilerplate. * gdk/Makefile.am: Remove the X-derived-headers rule. * gdk/tmpl/cursors.sgml: Document GdkCursor and standard cursors.
2001-11-28 18:38:43 +00:00
@GDK_CURSOR_IS_PIXMAP: type of cursors constructed with
gdk_cursor_new_from_pixmap().
Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_cursor_new ##### -->
<para>
Throughout: assorted docs 2001-10-02 Havoc Pennington <hp@redhat.com> Throughout: assorted docs * gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken, gdk_window_set_geometry_hints() should be used instead. * gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and document them * gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't seem to exist in any .c files * gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs, g_return_if_fail (pixel < colormap->size).
2001-10-03 18:19:48 +00:00
Initial revision
1999-08-16 18:51:52 +00:00
</para>
Throughout: assorted docs 2001-10-02 Havoc Pennington <hp@redhat.com> Throughout: assorted docs * gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken, gdk_window_set_geometry_hints() should be used instead. * gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and document them * gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't seem to exist in any .c files * gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs, g_return_if_fail (pixel < colormap->size).
2001-10-03 18:19:48 +00:00
@cursor_type:
@Returns:
Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### 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).
fix up my list of "cursors that are actually useful" in gdk_cursor_new() 2001-12-07 Havoc Pennington <hp@pobox.com> * gdk/x11/gdkcursor-x11.c (gdk_cursor_new): fix up my list of "cursors that are actually useful" in gdk_cursor_new() docs
2001-12-07 05:27:17 +00:00
The standard cursor size is 16 by 16 pixels. You can create a bitmap
from inline data as in the below example.
Initial revision
1999-08-16 18:51:52 +00:00
</para>
<example><title>Creating a custom cursor.</title>
<programlisting>
/* This data is in X bitmap format, and can be created with the 'bitmap'
utility. */
Replace homegrown "nbsp", "hash" and "percent" entities by standard ISO * gtk/tmpl/gtkprogress.sgml: * gtk/tmpl/gtkscale.sgml: * gtk/tmpl/gtktreemodel.sgml: * gtk/tmpl/gtkimage.sgml: * gtk/tmpl/gtksignal.sgml: * gtk/tmpl/gtkrc.sgml: * gtk/gtk-docs.sgml: * gdk/gdk-docs.sgml: * gdk/tmpl/threads.sgml: * gdk/tmpl/cursors.sgml: * gdk/tmpl/rgb.sgml: Replace homegrown "nbsp", "hash" and "percent" entities by standard ISO entities "nbsp", "num" and "percnt". * gtk/text_widget.sgml: Fix a link.
2002-06-03 17:47:31 +00:00
&num;define cursor1_width 16
&num;define cursor1_height 16
Initial revision
1999-08-16 18:51:52 +00:00
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, &amp;fg, &amp;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.
Update for multihead. Tue Apr 30 12:26:31 2002 Owen Taylor <otaylor@redhat.com> * gdk-sections.txt: Update for multihead. * multihead.sgml gtk-docs.sgml: Add overview of multihead from multihead branch. * tmpl/gdkdisplay.sgml tmpl/gdkscreen.sgml: New sections from multihead branch.
2002-04-30 18:07:51 +00:00
<!-- ##### FUNCTION gdk_cursor_new_for_screen ##### -->
<para>
</para>
@screen:
@cursor_type:
@Returns:
<!-- ##### FUNCTION gdk_cursor_get_screen ##### -->
<para>
</para>
@cursor:
@Returns:
Move gtk-reference files into GTK+ tree proper. Thu Sep 7 14:15:03 2000 Owen Taylor <otaylor@redhat.com> * gdk/* gtk/*: Move gtk-reference files into GTK+ tree proper. * Update sections.txt files to correspond to current code, tweak .sgml files and Makefiles to correspond. * gtk/tmpl/gtkradiomenuitem.sgml (this): Remove extra <para>
2000-09-07 18:17:06 +00:00
<!-- ##### FUNCTION gdk_cursor_ref ##### -->
<para>
</para>
@cursor:
@Returns:
<!-- ##### FUNCTION gdk_cursor_unref ##### -->
<para>
</para>
@cursor:
<!-- ##### MACRO gdk_cursor_destroy ##### -->
Initial revision
1999-08-16 18:51:52 +00:00
<para>
Destroys a cursor, freeing any resources allocated for it.
</para>
Move gtk-reference files into GTK+ tree proper. Thu Sep 7 14:15:03 2000 Owen Taylor <otaylor@redhat.com> * gdk/* gtk/*: Move gtk-reference files into GTK+ tree proper. * Update sections.txt files to correspond to current code, tweak .sgml files and Makefiles to correspond. * gtk/tmpl/gtkradiomenuitem.sgml (this): Remove extra <para>
2000-09-07 18:17:06 +00:00
<!-- # Unused Parameters # -->
Initial revision
1999-08-16 18:51:52 +00:00
@cursor: a #GdkCursor.
Reference in New Issue Copy Permalink