diff options
author | Matthias Clasen <mclasen@redhat.com> | 2013-03-20 18:17:32 -0400 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2013-05-05 15:38:47 -0400 |
commit | 20c8c8b91cf2719249a729492ec84b7282dc03fb (patch) | |
tree | d53cf50689bceedbea093895d0e51a7c204cef76 /gtk/gtktextiter.h | |
parent | 8470eb84c080718120b5daf130db744bf6ec220b (diff) | |
download | gtk+-20c8c8b91cf2719249a729492ec84b7282dc03fb.tar.gz |
Add annotations to gtk headers
Add annotations to all exported functions in GTK+ headers.
Diffstat (limited to 'gtk/gtktextiter.h')
-rw-r--r-- | gtk/gtktextiter.h | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/gtk/gtktextiter.h b/gtk/gtktextiter.h index 5fb99123ef..830d28e14a 100644 --- a/gtk/gtktextiter.h +++ b/gtk/gtktextiter.h @@ -78,142 +78,207 @@ struct _GtkTextIter { /* This is primarily intended for language bindings that want to avoid a "buffer" argument to text insertions, deletions, etc. */ +GDK_AVAILABLE_IN_ALL GtkTextBuffer *gtk_text_iter_get_buffer (const GtkTextIter *iter); /* * Life cycle */ +GDK_AVAILABLE_IN_ALL GtkTextIter *gtk_text_iter_copy (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_free (GtkTextIter *iter); GDK_AVAILABLE_IN_3_2 void gtk_text_iter_assign (GtkTextIter *iter, const GtkTextIter *other); +GDK_AVAILABLE_IN_ALL GType gtk_text_iter_get_type (void) G_GNUC_CONST; /* * Convert to different kinds of index */ +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_offset (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_line (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_line_offset (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_line_index (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_visible_line_index (const GtkTextIter *iter); /* * "Dereference" operators */ +GDK_AVAILABLE_IN_ALL gunichar gtk_text_iter_get_char (const GtkTextIter *iter); /* includes the 0xFFFC char for pixmaps/widgets, so char offsets * into the returned string map properly into buffer char offsets */ +GDK_AVAILABLE_IN_ALL gchar *gtk_text_iter_get_slice (const GtkTextIter *start, const GtkTextIter *end); /* includes only text, no 0xFFFC */ +GDK_AVAILABLE_IN_ALL gchar *gtk_text_iter_get_text (const GtkTextIter *start, const GtkTextIter *end); /* exclude invisible chars */ +GDK_AVAILABLE_IN_ALL gchar *gtk_text_iter_get_visible_slice (const GtkTextIter *start, const GtkTextIter *end); +GDK_AVAILABLE_IN_ALL gchar *gtk_text_iter_get_visible_text (const GtkTextIter *start, const GtkTextIter *end); +GDK_AVAILABLE_IN_ALL GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL GSList * gtk_text_iter_get_marks (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter); /* Return list of tags toggled at this point (toggled_on determines * whether the list is of on-toggles or off-toggles) */ +GDK_AVAILABLE_IN_ALL GSList *gtk_text_iter_get_toggled_tags (const GtkTextIter *iter, gboolean toggled_on); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_begins_tag (const GtkTextIter *iter, GtkTextTag *tag); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_ends_tag (const GtkTextIter *iter, GtkTextTag *tag); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_toggles_tag (const GtkTextIter *iter, GtkTextTag *tag); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_has_tag (const GtkTextIter *iter, GtkTextTag *tag); +GDK_AVAILABLE_IN_ALL GSList *gtk_text_iter_get_tags (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_editable (const GtkTextIter *iter, gboolean default_setting); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_can_insert (const GtkTextIter *iter, gboolean default_editability); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_starts_word (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_ends_word (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_inside_word (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_starts_sentence (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_ends_sentence (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_inside_sentence (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_starts_line (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_ends_line (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_is_cursor_position (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_chars_in_line (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_get_attributes (const GtkTextIter *iter, GtkTextAttributes *values); +GDK_AVAILABLE_IN_ALL PangoLanguage* gtk_text_iter_get_language (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_is_end (const GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_is_start (const GtkTextIter *iter); /* * Moving around the buffer */ +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_char (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_char (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_chars (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_chars (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_line (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_line (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_lines (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_lines (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_word_ends (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_visible_line (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_visible_line (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_visible_lines (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_visible_lines (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_visible_word_end (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_visible_word_start (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_visible_word_ends (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_visible_word_starts (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_sentence_end (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_sentence_start (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_sentence_ends (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter, gint count); /* cursor positions are almost equivalent to chars, but not quite; @@ -221,33 +286,49 @@ gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter, * chars. Also, you can't put the cursor between \r\n at the end * of a line. */ +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_cursor_position (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_cursor_positions (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_visible_cursor_position (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_visible_cursor_position (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_visible_cursor_positions (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_visible_cursor_positions (GtkTextIter *iter, gint count); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_set_offset (GtkTextIter *iter, gint char_offset); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_set_line (GtkTextIter *iter, gint line_number); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_set_line_offset (GtkTextIter *iter, gint char_on_line); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_set_line_index (GtkTextIter *iter, gint byte_on_line); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_forward_to_end (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_to_line_end (GtkTextIter *iter); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_set_visible_line_offset (GtkTextIter *iter, gint char_on_line); +GDK_AVAILABLE_IN_ALL void gtk_text_iter_set_visible_line_index (GtkTextIter *iter, gint byte_on_line); @@ -255,23 +336,28 @@ void gtk_text_iter_set_visible_line_index (GtkTextIter *iter, * means "any tag toggle", otherwise the next toggle of the * specified tag is located. */ +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter, GtkTextTag *tag); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter, GtkTextTag *tag); typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter, GtkTextCharPredicate pred, gpointer user_data, const GtkTextIter *limit); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter, GtkTextCharPredicate pred, gpointer user_data, const GtkTextIter *limit); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_forward_search (const GtkTextIter *iter, const gchar *str, GtkTextSearchFlags flags, @@ -279,6 +365,7 @@ gboolean gtk_text_iter_forward_search (const GtkTextIter *iter, GtkTextIter *match_end, const GtkTextIter *limit); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_backward_search (const GtkTextIter *iter, const gchar *str, GtkTextSearchFlags flags, @@ -289,15 +376,19 @@ gboolean gtk_text_iter_backward_search (const GtkTextIter *iter, /* * Comparisons */ +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_equal (const GtkTextIter *lhs, const GtkTextIter *rhs); +GDK_AVAILABLE_IN_ALL gint gtk_text_iter_compare (const GtkTextIter *lhs, const GtkTextIter *rhs); +GDK_AVAILABLE_IN_ALL gboolean gtk_text_iter_in_range (const GtkTextIter *iter, const GtkTextIter *start, const GtkTextIter *end); /* Put these two in ascending order */ +GDK_AVAILABLE_IN_ALL void gtk_text_iter_order (GtkTextIter *first, GtkTextIter *second); |