[gtk+] Update docs

From: Matthias Clasen <matthiasc src gnome org>
To: commits-list gnome org
Cc:
Subject: [gtk+] Update docs
Date: Fri, 8 May 2015 17:34:48 +0000 (UTC)
commit 7d83edd4e01b34e83474f8b8b49d3e6c3acb610d
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri May 8 09:55:28 2015 -0400

    Update docs

 docs/reference/gdk/Makefile.am                     |   37 ++++++++++++++++++-
 docs/reference/gdk/images/alias_cursor.png         |  Bin 0 -> 1383 bytes
 docs/reference/gdk/images/all_scroll_cursor.png    |  Bin 0 -> 1776 bytes
 docs/reference/gdk/images/cell_cursor.png          |  Bin 0 -> 1155 bytes
 docs/reference/gdk/images/col_resize_cursor.png    |  Bin 0 -> 1479 bytes
 docs/reference/gdk/images/copy_cursor.png          |  Bin 0 -> 1325 bytes
 docs/reference/gdk/images/crosshair_cursor.png     |  Bin 0 -> 985 bytes
 docs/reference/gdk/images/default_cursor.png       |  Bin 0 -> 1252 bytes
 docs/reference/gdk/images/e_resize_cursor.png      |  Bin 0 -> 1289 bytes
 docs/reference/gdk/images/ew_resize_cursor.png     |  Bin 0 -> 1479 bytes
 docs/reference/gdk/images/grab_cursor.png          |  Bin 0 -> 1392 bytes
 docs/reference/gdk/images/grabbing_cursor.png      |  Bin 0 -> 1216 bytes
 docs/reference/gdk/images/hand_cursor.png          |  Bin 0 -> 1416 bytes
 docs/reference/gdk/images/help_cursor.png          |  Bin 0 -> 1549 bytes
 docs/reference/gdk/images/move_cursor.png          |  Bin 0 -> 1601 bytes
 docs/reference/gdk/images/n_resize_cursor.png      |  Bin 0 -> 1287 bytes
 docs/reference/gdk/images/ne_resize_cursor.png     |  Bin 0 -> 1423 bytes
 docs/reference/gdk/images/nesw_resize_cursor.png   |  Bin 0 -> 1248 bytes
 docs/reference/gdk/images/no_drop_cursor.png       |  Bin 0 -> 1176 bytes
 docs/reference/gdk/images/not_allowed_cursor.png   |  Bin 0 -> 2280 bytes
 docs/reference/gdk/images/ns_resize_cursor.png     |  Bin 0 -> 1411 bytes
 docs/reference/gdk/images/nw_resize_cursor.png     |  Bin 0 -> 1545 bytes
 docs/reference/gdk/images/nwse_resize_cursor.png   |  Bin 0 -> 1223 bytes
 docs/reference/gdk/images/pointer_cursor.png       |  Bin 0 -> 1416 bytes
 docs/reference/gdk/images/progress_cursor.png      |  Bin 0 -> 1879 bytes
 docs/reference/gdk/images/row_resize_cursor.png    |  Bin 0 -> 1411 bytes
 docs/reference/gdk/images/s_resize_cursor.png      |  Bin 0 -> 1208 bytes
 docs/reference/gdk/images/se_resize_cursor.png     |  Bin 0 -> 1338 bytes
 docs/reference/gdk/images/sw_resize_cursor.png     |  Bin 0 -> 1369 bytes
 docs/reference/gdk/images/text_cursor.png          |  Bin 0 -> 844 bytes
 docs/reference/gdk/images/vertical_text_cursor.png |  Bin 0 -> 823 bytes
 docs/reference/gdk/images/w_resize_cursor.png      |  Bin 0 -> 1355 bytes
 docs/reference/gdk/images/wait_cursor.png          |  Bin 0 -> 2013 bytes
 docs/reference/gdk/images/zoom_in_cursor.png       |  Bin 0 -> 2289 bytes
 docs/reference/gdk/images/zoom_out_cursor.png      |  Bin 0 -> 2170 bytes
 gdk/gdkcursor.c                                    |   39 ++++++++++++++++++++
 gdk/gdkcursor.h                                    |    7 +++-
 37 files changed, 81 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/gdk/Makefile.am b/docs/reference/gdk/Makefile.am
index 06c33f3..aef7cab 100644
--- a/docs/reference/gdk/Makefile.am
+++ b/docs/reference/gdk/Makefile.am
@@ -134,7 +134,42 @@ HTML_IMAGES =                              \
        images/umbrella.png             \
        images/ur_angle.png             \
        images/watch.png                \
-       images/xterm.png
+       images/xterm.png                \
+       images/alias_cursor.png         \
+       images/all_scroll_cursor.png    \
+       images/cell_cursor.png          \
+       images/col_resize_cursor.png    \
+       images/copy_cursor.png          \
+       images/crosshair_cursor.png     \
+       images/default_cursor.png       \
+       images/e_resize_cursor.png      \
+       images/ew_resize_cursor.png     \
+       images/grabbing_cursor.png      \
+       images/grab_cursor.png          \
+       images/hand_cursor.png          \
+       images/help_cursor.png          \
+       images/move_cursor.png          \
+       images/ne_resize_cursor.png     \
+       images/nesw_resize_cursor.png   \
+       images/no_drop_cursor.png       \
+       images/not_allowed_cursor.png   \
+       images/n_resize_cursor.png      \
+       images/ns_resize_cursor.png     \
+       images/nw_resize_cursor.png     \
+       images/nwse_resize_cursor.png   \
+       images/pointer_cursor.png       \
+       images/progress_cursor.png      \
+       images/row_resize_cursor.png    \
+       images/se_resize_cursor.png     \
+       images/s_resize_cursor.png      \
+       images/sw_resize_cursor.png     \
+       images/text_cursor.png          \
+       images/vertical_text_cursor.png \
+       images/wait_cursor.png          \
+       images/w_resize_cursor.png      \
+       images/X_cursor.png             \
+       images/zoom_in_cursor.png       \
+       images/zoom_out_cursor.png
 
 if ENABLE_DOC_CROSS_REFERENCES
 # Extra options to supply to gtkdoc-fixref
diff --git a/docs/reference/gdk/images/alias_cursor.png b/docs/reference/gdk/images/alias_cursor.png
new file mode 100644
index 0000000..70a7956
Binary files /dev/null and b/docs/reference/gdk/images/alias_cursor.png differ
diff --git a/docs/reference/gdk/images/all_scroll_cursor.png b/docs/reference/gdk/images/all_scroll_cursor.png
new file mode 100644
index 0000000..b42ae85
Binary files /dev/null and b/docs/reference/gdk/images/all_scroll_cursor.png differ
diff --git a/docs/reference/gdk/images/cell_cursor.png b/docs/reference/gdk/images/cell_cursor.png
new file mode 100644
index 0000000..0bb0935
Binary files /dev/null and b/docs/reference/gdk/images/cell_cursor.png differ
diff --git a/docs/reference/gdk/images/col_resize_cursor.png b/docs/reference/gdk/images/col_resize_cursor.png
new file mode 100644
index 0000000..8dbd462
Binary files /dev/null and b/docs/reference/gdk/images/col_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/copy_cursor.png b/docs/reference/gdk/images/copy_cursor.png
new file mode 100644
index 0000000..c2350b8
Binary files /dev/null and b/docs/reference/gdk/images/copy_cursor.png differ
diff --git a/docs/reference/gdk/images/crosshair_cursor.png b/docs/reference/gdk/images/crosshair_cursor.png
new file mode 100644
index 0000000..7247e06
Binary files /dev/null and b/docs/reference/gdk/images/crosshair_cursor.png differ
diff --git a/docs/reference/gdk/images/default_cursor.png b/docs/reference/gdk/images/default_cursor.png
new file mode 100644
index 0000000..aa39aa4
Binary files /dev/null and b/docs/reference/gdk/images/default_cursor.png differ
diff --git a/docs/reference/gdk/images/e_resize_cursor.png b/docs/reference/gdk/images/e_resize_cursor.png
new file mode 100644
index 0000000..f06bf46
Binary files /dev/null and b/docs/reference/gdk/images/e_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/ew_resize_cursor.png b/docs/reference/gdk/images/ew_resize_cursor.png
new file mode 100644
index 0000000..8dbd462
Binary files /dev/null and b/docs/reference/gdk/images/ew_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/grab_cursor.png b/docs/reference/gdk/images/grab_cursor.png
new file mode 100644
index 0000000..a920eef
Binary files /dev/null and b/docs/reference/gdk/images/grab_cursor.png differ
diff --git a/docs/reference/gdk/images/grabbing_cursor.png b/docs/reference/gdk/images/grabbing_cursor.png
new file mode 100644
index 0000000..33418ac
Binary files /dev/null and b/docs/reference/gdk/images/grabbing_cursor.png differ
diff --git a/docs/reference/gdk/images/hand_cursor.png b/docs/reference/gdk/images/hand_cursor.png
new file mode 100644
index 0000000..b510203
Binary files /dev/null and b/docs/reference/gdk/images/hand_cursor.png differ
diff --git a/docs/reference/gdk/images/help_cursor.png b/docs/reference/gdk/images/help_cursor.png
new file mode 100644
index 0000000..5440fd9
Binary files /dev/null and b/docs/reference/gdk/images/help_cursor.png differ
diff --git a/docs/reference/gdk/images/move_cursor.png b/docs/reference/gdk/images/move_cursor.png
new file mode 100644
index 0000000..6028099
Binary files /dev/null and b/docs/reference/gdk/images/move_cursor.png differ
diff --git a/docs/reference/gdk/images/n_resize_cursor.png b/docs/reference/gdk/images/n_resize_cursor.png
new file mode 100644
index 0000000..fbd8420
Binary files /dev/null and b/docs/reference/gdk/images/n_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/ne_resize_cursor.png b/docs/reference/gdk/images/ne_resize_cursor.png
new file mode 100644
index 0000000..0ca3f6e
Binary files /dev/null and b/docs/reference/gdk/images/ne_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/nesw_resize_cursor.png 
b/docs/reference/gdk/images/nesw_resize_cursor.png
new file mode 100644
index 0000000..aa3bf68
Binary files /dev/null and b/docs/reference/gdk/images/nesw_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/no_drop_cursor.png b/docs/reference/gdk/images/no_drop_cursor.png
new file mode 100644
index 0000000..4f9968f
Binary files /dev/null and b/docs/reference/gdk/images/no_drop_cursor.png differ
diff --git a/docs/reference/gdk/images/not_allowed_cursor.png 
b/docs/reference/gdk/images/not_allowed_cursor.png
new file mode 100644
index 0000000..1305af8
Binary files /dev/null and b/docs/reference/gdk/images/not_allowed_cursor.png differ
diff --git a/docs/reference/gdk/images/ns_resize_cursor.png b/docs/reference/gdk/images/ns_resize_cursor.png
new file mode 100644
index 0000000..acb1283
Binary files /dev/null and b/docs/reference/gdk/images/ns_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/nw_resize_cursor.png b/docs/reference/gdk/images/nw_resize_cursor.png
new file mode 100644
index 0000000..6691557
Binary files /dev/null and b/docs/reference/gdk/images/nw_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/nwse_resize_cursor.png 
b/docs/reference/gdk/images/nwse_resize_cursor.png
new file mode 100644
index 0000000..183001d
Binary files /dev/null and b/docs/reference/gdk/images/nwse_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/pointer_cursor.png b/docs/reference/gdk/images/pointer_cursor.png
new file mode 100644
index 0000000..b510203
Binary files /dev/null and b/docs/reference/gdk/images/pointer_cursor.png differ
diff --git a/docs/reference/gdk/images/progress_cursor.png b/docs/reference/gdk/images/progress_cursor.png
new file mode 100644
index 0000000..7afe983
Binary files /dev/null and b/docs/reference/gdk/images/progress_cursor.png differ
diff --git a/docs/reference/gdk/images/row_resize_cursor.png b/docs/reference/gdk/images/row_resize_cursor.png
new file mode 100644
index 0000000..acb1283
Binary files /dev/null and b/docs/reference/gdk/images/row_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/s_resize_cursor.png b/docs/reference/gdk/images/s_resize_cursor.png
new file mode 100644
index 0000000..5e6bf50
Binary files /dev/null and b/docs/reference/gdk/images/s_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/se_resize_cursor.png b/docs/reference/gdk/images/se_resize_cursor.png
new file mode 100644
index 0000000..f6e4002
Binary files /dev/null and b/docs/reference/gdk/images/se_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/sw_resize_cursor.png b/docs/reference/gdk/images/sw_resize_cursor.png
new file mode 100644
index 0000000..1963383
Binary files /dev/null and b/docs/reference/gdk/images/sw_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/text_cursor.png b/docs/reference/gdk/images/text_cursor.png
new file mode 100644
index 0000000..53cec46
Binary files /dev/null and b/docs/reference/gdk/images/text_cursor.png differ
diff --git a/docs/reference/gdk/images/vertical_text_cursor.png 
b/docs/reference/gdk/images/vertical_text_cursor.png
new file mode 100644
index 0000000..17241bc
Binary files /dev/null and b/docs/reference/gdk/images/vertical_text_cursor.png differ
diff --git a/docs/reference/gdk/images/w_resize_cursor.png b/docs/reference/gdk/images/w_resize_cursor.png
new file mode 100644
index 0000000..65383b1
Binary files /dev/null and b/docs/reference/gdk/images/w_resize_cursor.png differ
diff --git a/docs/reference/gdk/images/wait_cursor.png b/docs/reference/gdk/images/wait_cursor.png
new file mode 100644
index 0000000..21ccd2f
Binary files /dev/null and b/docs/reference/gdk/images/wait_cursor.png differ
diff --git a/docs/reference/gdk/images/zoom_in_cursor.png b/docs/reference/gdk/images/zoom_in_cursor.png
new file mode 100644
index 0000000..ae3114d
Binary files /dev/null and b/docs/reference/gdk/images/zoom_in_cursor.png differ
diff --git a/docs/reference/gdk/images/zoom_out_cursor.png b/docs/reference/gdk/images/zoom_out_cursor.png
new file mode 100644
index 0000000..846a3dd
Binary files /dev/null and b/docs/reference/gdk/images/zoom_out_cursor.png differ
diff --git a/gdk/gdkcursor.c b/gdk/gdkcursor.c
index ae8b3a6..b854c6c 100644
--- a/gdk/gdkcursor.c
+++ b/gdk/gdkcursor.c
@@ -225,6 +225,7 @@ gdk_cursor_get_cursor_type (GdkCursor *cursor)
  * @cursor_type: cursor to create
  *
  * Creates a new cursor from the set of builtin cursors.
+ *
  * Some useful ones are:
  * - ![](right_ptr.png) #GDK_RIGHT_PTR (right-facing arrow)
  * - ![](crosshair.png) #GDK_CROSSHAIR (crosshair)
@@ -266,6 +267,44 @@ gdk_cursor_new_for_display (GdkDisplay    *display,
  * Creates a new cursor by looking up @name in the current cursor
  * theme.
  *
+ * A recommended set of cursor names that will work across different
+ * platforms can be found in the CSS specification:
+ * - "none"
+ * - ![](default_cursor.png) "default"
+ * - ![](help_cursor.png) "help"
+ * - ![](pointer_cursor.png) "pointer"
+ * - ![](progress_cursor.png) "progress"
+ * - ![](wait_cursor.png) "wait"
+ * - ![](cell_cursor.png) "cell"
+ * - ![](crosshair_cursor.png) "crosshair"
+ * - ![](text_cursor.png) "text"
+ * - ![](vertical_text_cursor.png) "vertical-text"
+ * - ![](alias_cursor.png) "alias"
+ * - ![](copy_cursor.png) "copy"
+ * - ![](move_cursor.png) "move"
+ * - ![](no_drop_cursor.png) "no-drop"
+ * - ![](not_allowed_cursor.png) "not-allowed"
+ * - ![](grab_cursor.png) "grab"
+ * - ![](grabbing_cursor.png) "grabbing"
+ * - ![](all_scroll_cursor.png) "all-scroll"
+ * - ![](col_resize_cursor.png) "col-resize"
+ * - ![](row_resize_cursor.png) "row-resize"
+ * - ![](n_resize_cursor.png) "n-resize"
+ * - ![](e_resize_cursor.png) "e-resize"
+ * - ![](s_resize_cursor.png) "s-resize"
+ * - ![](w_resize_cursor.png) "w-resize"
+ * - ![](ne_resize_cursor.png) "ne-resize"
+ * - ![](nw_resize_cursor.png) "nw-resize"
+ * - ![](sw_resize_cursor.png) "sw-resize"
+ * - ![](se_resize_cursor.png) "se-resize"
+ * - ![](ew_resize_cursor.png) "ew-resize"
+ * - ![](ns_resize_cursor.png) "ns-resize"
+ * - ![](nesw_resize_cursor.png) "nesw-resize"
+ * - ![](nwse_resize_cursor.png) "nwse-resize"
+ * - ![](zoom_in_cursor.png) "zoom-in"
+ * - ![](zoom_out_cursor.png) "zoom-out"
+ *
+ *
  * Returns: (nullable): a new #GdkCursor, or %NULL if there is no
  *   cursor with the given name
  *
diff --git a/gdk/gdkcursor.h b/gdk/gdkcursor.h
index 683ab07..13dbe91 100644
--- a/gdk/gdkcursor.h
+++ b/gdk/gdkcursor.h
@@ -124,7 +124,12 @@ G_BEGIN_DECLS
  * @GDK_CURSOR_IS_PIXMAP: type of cursors constructed with
  *   gdk_cursor_new_from_pixbuf()
  *
- * The standard cursors available.
+ * Predefined cursors.
+ *
+ * Note that these IDs are directly taken from the X cursor font, and many
+ * of these cursors are either not useful, or are not available on other platforms.
+ *
+ * The recommended way to create cursors is to use gdk_cursor_new_from_name().
  */
 typedef enum
 {
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]