summaryrefslogtreecommitdiff
path: root/gtk/gtktextiter.h
diff options
context:
space:
mode:
authorSébastien Wilmet <swilmet@gnome.org>2013-06-25 11:58:57 +0200
committerSébastien Wilmet <swilmet@gnome.org>2013-06-25 13:21:08 +0200
commit67d1183ac905bf32d0340fe2ac04bb28f6026867 (patch)
tree9882badf9e9b1946fcdca3493ad87643ff21452a /gtk/gtktextiter.h
parentc40155c8e6336a3ef1ef4105b478598caca362af (diff)
downloadgtk+-67d1183ac905bf32d0340fe2ac04bb28f6026867.tar.gz
Document GtkTextSearchFlags
Move the doc about the flags from gtk_text_iter_forward_search() to the enum. https://bugzilla.gnome.org/show_bug.cgi?id=390048
Diffstat (limited to 'gtk/gtktextiter.h')
-rw-r--r--gtk/gtktextiter.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/gtk/gtktextiter.h b/gtk/gtktextiter.h
index 830d28e14a..57ce274f8e 100644
--- a/gtk/gtktextiter.h
+++ b/gtk/gtktextiter.h
@@ -35,6 +35,21 @@
G_BEGIN_DECLS
+/**
+ * GtkTextSearchFlags:
+ * @GTK_TEXT_SEARCH_VISIBLE_ONLY: Search only visible data. A search match may
+ * have invisible text interspersed.
+ * @GTK_TEXT_SEARCH_TEXT_ONLY: Search only text. A match may have pixbufs or
+ * child widgets mixed inside the matched range.
+ * @GTK_TEXT_SEARCH_CASE_INSENSITIVE: The text will be matched regardless of
+ * what case it is in.
+ *
+ * Flags affecting how a search is done.
+ *
+ * If neither #GTK_TEXT_SEARCH_VISIBLE_ONLY nor #GTK_TEXT_SEARCH_TEXT_ONLY are
+ * enabled, the match must be exact; the special 0xFFFC character will match
+ * embedded pixbufs or child widgets.
+ */
typedef enum {
GTK_TEXT_SEARCH_VISIBLE_ONLY = 1 << 0,
GTK_TEXT_SEARCH_TEXT_ONLY = 1 << 1,