AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
89d28eb09d
gtk2/docs/reference/gdk/tmpl/cursors.sgml

228 lines
8.7 KiB
Plaintext
Raw Normal View History

Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
Cursors
<!-- ##### SECTION Short_Description ##### -->
Remove period from title of example in docs. * gdk/x11/gdkcursor-x11.c (gdk_cursor_new_from_pixmap): Remove period from title of example in docs. * gdk/tmpl/x_interaction.sgml: * gdk/tmpl/pango_interaction.sgml: * gdk/tmpl/input_devices.sgml: * gdk/tmpl/input.sgml: * gdk/tmpl/threads.sgml: * gdk/tmpl/properties.sgml: * gdk/tmpl/dnd.sgml: * gdk/tmpl/selections.sgml: * gdk/tmpl/keys.sgml: * gdk/tmpl/event_structs.sgml: * gdk/tmpl/events.sgml: * gdk/tmpl/windows.sgml: * gdk/tmpl/cursors.sgml: * gdk/tmpl/fonts.sgml: * gdk/tmpl/colors.sgml: * gdk/tmpl/pixbufs.sgml: * gdk/tmpl/images.sgml: * gdk/tmpl/pixmaps.sgml: * gdk/tmpl/drawing.sgml: * gdk/tmpl/regions.sgml: * gdk/tmpl/gdkdisplaymanager.sgml: * gdk/tmpl/gdkscreen.sgml: * gdk/tmpl/gdkdisplay.sgml: * gdk/tmpl/general.sgml: Add missing short descriptions, standardize them to start with a capital and end without a period. Also remove periods from titles of examples.
2002-11-23 23:02:10 +00:00
Standard and pixmap cursors
Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
Add keyname-table.h 2005-05-08 Matthias Clasen <mclasen@redhat.com> * gdk/Makefile.am (IGNORE_HFILES): Add keyname-table.h * gdk/gdk-sections.txt: Add gdk_cairo_set_source_color, gdk_drawable_create_cairo_context and gdk_pixbuf_set_as_cairo_source, remove gdk_draw_rectangle_alpha_libgtk_only * gdk/tmpl/pixbufs.sgml: * gdk/tmpl/cursors.sgml: Add long descriptions. * gdk/tmpl/events.sgml: * gdk/tmpl/dnd.sgml: * gdk/tmpl/windows.sgml: * gdk/tmpl/pixmaps.sgml: * gdk/tmpl/x_interaction.sgml: Small additions.
2005-05-08 05:48:45 +00:00
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().
Initial revision
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
Add keyname-table.h 2005-05-08 Matthias Clasen <mclasen@redhat.com> * gdk/Makefile.am (IGNORE_HFILES): Add keyname-table.h * gdk/gdk-sections.txt: Add gdk_cairo_set_source_color, gdk_drawable_create_cairo_context and gdk_pixbuf_set_as_cairo_source, remove gdk_draw_rectangle_alpha_libgtk_only * gdk/tmpl/pixbufs.sgml: * gdk/tmpl/cursors.sgml: Add long descriptions. * gdk/tmpl/events.sgml: * gdk/tmpl/dnd.sgml: * gdk/tmpl/windows.sgml: * gdk/tmpl/pixmaps.sgml: * gdk/tmpl/x_interaction.sgml: Small additions.
2005-05-08 05:48:45 +00:00
<!-- ##### SECTION Stability_Level ##### -->
Make 3.0 parallel-installable to 2.x In particular, rename - libraries to lib*-3.0.so - pc files to *-3.0.pc - include paths to /usr/include/gtk-3.0/* - module paths to /usr/lib/gtk-3.0/* - rc files names to gtk-3.0/gtkrc - commandline utilities to *-3.0 - adjust documentation Also change the install location for unix-print headers to /usr/include/gtk-3.0/unix-print/gtk.
2010-05-08 05:18:53 +00:00
<!-- ##### SECTION Image ##### -->
Initial revision
1999-08-16 18:51:52 +00:00
<!-- ##### 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>
<!-- ##### 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>
Add keyname-table.h 2005-05-08 Matthias Clasen <mclasen@redhat.com> * gdk/Makefile.am (IGNORE_HFILES): Add keyname-table.h * gdk/gdk-sections.txt: Add gdk_cairo_set_source_color, gdk_drawable_create_cairo_context and gdk_pixbuf_set_as_cairo_source, remove gdk_draw_rectangle_alpha_libgtk_only * gdk/tmpl/pixbufs.sgml: * gdk/tmpl/cursors.sgml: Add long descriptions. * gdk/tmpl/events.sgml: * gdk/tmpl/dnd.sgml: * gdk/tmpl/windows.sgml: * gdk/tmpl/pixmaps.sgml: * gdk/tmpl/x_interaction.sgml: Small additions.
2005-05-08 05:48:45 +00:00
@GDK_LAST_CURSOR: last cursor type
2.15.1 svn path=/trunk/; revision=22202
2009-01-23 23:03:59 +00:00
@GDK_BLANK_CURSOR: Blank cursor. Since 2.16
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
Document GDK_BLANK_CURSOR svn path=/trunk/; revision=22146
2009-01-20 02:18:33 +00:00
gdk_cursor_new_from_pixmap() or gdk_cursor_new_from_pixbuf()
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>
</para>
More API docs moved inline.
2002-10-24 21:24:20 +00:00
@source:
@mask:
@fg:
@bg:
@x:
@y:
Remove rules for generation of version.xml, which was causing make to Sat Nov 2 12:46:16 2002 Owen Taylor <otaylor@redhat.com> * gdk-pixbuf/Makefile.am: Remove rules for generation of version.xml, which was causing make to always rebuild the HTML file, and didn't seem to be used. * gtk/tmpl/gtkliststore.sgml: SGML fixes.
2002-11-02 18:18:50 +00:00
@Returns:
Initial revision
1999-08-16 18:51:52 +00:00
Commit autogenerated changes, so patches will make sense. Mon Jul 28 18:21:34 2003 Soeren Sandmann <sandmann@daimi.au.dk> * gtk+/docs/: Commit autogenerated changes, so patches will make sense.
2003-07-28 16:08:20 +00:00
<!-- ##### FUNCTION gdk_cursor_new_from_pixbuf ##### -->
<para>
</para>
@display:
@pixbuf:
@x:
@y:
@Returns:
2.7.0
2005-06-20 22:06:27 +00:00
<!-- ##### FUNCTION gdk_cursor_new_from_name ##### -->
<para>
</para>
@display:
@name:
@Returns:
Fix for cursor screen => display change. Tue Jun 18 17:02:48 2002 Owen Taylor <otaylor@redhat.com> * gdk/gdk-sections.txt: Fix for cursor screen => display change.
2002-06-18 21:02:11 +00:00
<!-- ##### FUNCTION gdk_cursor_new_for_display ##### -->
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
<para>
</para>
Fix for cursor screen => display change. Tue Jun 18 17:02:48 2002 Owen Taylor <otaylor@redhat.com> * gdk/gdk-sections.txt: Fix for cursor screen => display change.
2002-06-18 21:02:11 +00:00
@display:
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
@cursor_type:
@Returns:
Fix for cursor screen => display change. Tue Jun 18 17:02:48 2002 Owen Taylor <otaylor@redhat.com> * gdk/gdk-sections.txt: Fix for cursor screen => display change.
2002-06-18 21:02:11 +00:00
<!-- ##### FUNCTION gdk_cursor_get_display ##### -->
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
<para>
</para>
@cursor:
@Returns:
2.7.0
2005-06-20 22:06:27 +00:00
<!-- ##### FUNCTION gdk_cursor_get_image ##### -->
<para>
</para>
@cursor:
@Returns:
docs: Add gdk_cursor_get_cursor_type() template
2010-07-31 12:59:16 +00:00
<!-- ##### FUNCTION gdk_cursor_get_cursor_type ##### -->
<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:
Make 3.0 parallel-installable to 2.x In particular, rename - libraries to lib*-3.0.so - pc files to *-3.0.pc - include paths to /usr/include/gtk-3.0/* - module paths to /usr/lib/gtk-3.0/* - rc files names to gtk-3.0/gtkrc - commandline utilities to *-3.0 - adjust documentation Also change the install location for unix-print headers to /usr/include/gtk-3.0/unix-print/gtk.
2010-05-08 05:18:53 +00:00
Reference in New Issue Copy Permalink