summaryrefslogtreecommitdiff
path: root/gtk/gtkenums.h
diff options
context:
space:
mode:
authorWilliam Jon McCann <william.jon.mccann@gmail.com>2014-01-21 11:31:21 -0500
committerWilliam Jon McCann <william.jon.mccann@gmail.com>2014-01-21 13:33:46 -0500
commitab41ef518af16d94161c1f1b2338c4ed10d45748 (patch)
treeb979806d53098ae97a4ef8a12d1bc487f0296aaa /gtk/gtkenums.h
parent75e3433d7b86d04770066b4985aaf37176df67ef (diff)
downloadgtk+-ab41ef518af16d94161c1f1b2338c4ed10d45748.tar.gz
docs: add docs for GtkDirectionType and GtkDeleteType
Diffstat (limited to 'gtk/gtkenums.h')
-rw-r--r--gtk/gtkenums.h30
1 files changed, 30 insertions, 0 deletions
diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h
index 631a2a3da6..69b106ebdb 100644
--- a/gtk/gtkenums.h
+++ b/gtk/gtkenums.h
@@ -178,6 +178,25 @@ typedef enum
} GtkButtonBoxStyle;
+/**
+ * GtkDeleteType:
+ * @GTK_DELETE_CHARS: Delete characters.
+ * @GTK_DELETE_WORD_ENDS: Delete only the portion of the word to the
+ * left/right of cursor if we're in the middle of a word.
+ * @GTK_DELETE_WORDS: Delete words.
+ * @GTK_DELETE_DISPLAY_LINES: Delete display-lines. Display-lines
+ * refers to the visible lines, with respect to to the current line
+ * breaks. As opposed to paragraphs, which are defined by line
+ * breaks in the input.
+ * @GTK_DELETE_DISPLAY_LINE_ENDS: Delete only the portion of the
+ * display-line to the left/right of cursor.
+ * @GTK_DELETE_PARAGRAPH_ENDS: Delete to the end of the
+ * paragraph. Like C-k in Emacs (or its reverse).
+ * @GTK_DELETE_PARAGRAPHS: Delete entire line. Like C-k in pico.
+ * @GTK_DELETE_WHITESPACE: Delete only whitespace. Like M-\ in Emacs.
+ *
+ * See also: #GtkEntry::delete-from-cursor.
+ */
typedef enum
{
GTK_DELETE_CHARS,
@@ -193,6 +212,17 @@ typedef enum
} GtkDeleteType;
/* Focus movement types */
+/**
+ * GtkDirectionType:
+ * @GTK_DIR_TAB_FORWARD: Move forward.
+ * @GTK_DIR_TAB_BACKWARD: Move backward.
+ * @GTK_DIR_UP: Move up.
+ * @GTK_DIR_DOWN: Move down.
+ * @GTK_DIR_LEFT: Move left.
+ * @GTK_DIR_RIGHT: Move right.
+ *
+ * Focus movement types.
+ */
typedef enum
{
GTK_DIR_TAB_FORWARD,