]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gdk/tmpl/cursors.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gdk / tmpl / cursors.sgml
index eb4442a109664ed1c4cff6644a3d27c03c22e28f..89abff656b2d4d04e2977fbef9c5b856ca21ced4 100644 (file)
@@ -6,7 +6,21 @@ 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 ##### -->
@@ -14,13 +28,18 @@ Standard and pixmap cursors
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### STRUCT GdkCursor ##### -->
 <para>
 A <type>GdkCursor</type> structure represents a cursor.
 </para>
 
-@type: 
-@ref_count: 
+@type: the #GdkCursorType of the cursor
 
 <!-- ##### ENUM GdkCursorType ##### -->
 <para>
@@ -104,9 +123,10 @@ The standard cursors available.
 @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: 
+@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().
+  gdk_cursor_new_from_pixmap() or gdk_cursor_new_from_pixbuf()
 
 <!-- ##### FUNCTION gdk_cursor_new ##### -->
 <para>
@@ -142,6 +162,16 @@ The standard cursors available.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_cursor_new_from_name ##### -->
+<para>
+
+</para>
+
+@display: 
+@name: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_cursor_new_for_display ##### -->
 <para>
 
@@ -161,7 +191,7 @@ The standard cursors available.
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_cursor_ref ##### -->
+<!-- ##### FUNCTION gdk_cursor_get_image ##### -->
 <para>
 
 </para>
@@ -170,18 +200,20 @@ The standard cursors available.
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_cursor_unref ##### -->
+<!-- ##### FUNCTION gdk_cursor_ref ##### -->
 <para>
 
 </para>
 
 @cursor: 
+@Returns: 
 
 
-<!-- ##### MACRO gdk_cursor_destroy ##### -->
+<!-- ##### FUNCTION gdk_cursor_unref ##### -->
 <para>
-Destroys a cursor, freeing any resources allocated for it.
+
 </para>
 
+@cursor: