forked from AuroraMiddleware/gtk
8282698201
This changes gtk_text_buffer_insert_texture() to gtk_text_buffer_insert_paintable() which is strictly more useful (as textures are paintables). It also fixes the code to actually support drawing the paintables (as well as tracking changes to the paintables.
409 lines
16 KiB
C
409 lines
16 KiB
C
/* GTK - The GIMP Toolkit
|
||
* gtktextiter.h Copyright (C) 2000 Red Hat, Inc.
|
||
*
|
||
* This library is free software; you can redistribute it and/or
|
||
* modify it under the terms of the GNU Lesser General Public
|
||
* License as published by the Free Software Foundation; either
|
||
* version 2 of the License, or (at your option) any later version.
|
||
*
|
||
* This library is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
* Lesser General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU Lesser General Public
|
||
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||
*/
|
||
|
||
/*
|
||
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
|
||
* file for a list of people on the GTK+ Team. See the ChangeLog
|
||
* files for a list of changes. These files are distributed with
|
||
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
|
||
*/
|
||
|
||
#ifndef __GTK_TEXT_ITER_H__
|
||
#define __GTK_TEXT_ITER_H__
|
||
|
||
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
|
||
#error "Only <gtk/gtk.h> can be included directly."
|
||
#endif
|
||
|
||
#include <gtk/gtktextchild.h>
|
||
#include <gtk/gtktexttag.h>
|
||
|
||
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 paintables 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 paintables or child widgets.
|
||
*/
|
||
typedef enum {
|
||
GTK_TEXT_SEARCH_VISIBLE_ONLY = 1 << 0,
|
||
GTK_TEXT_SEARCH_TEXT_ONLY = 1 << 1,
|
||
GTK_TEXT_SEARCH_CASE_INSENSITIVE = 1 << 2
|
||
/* Possible future plans: SEARCH_REGEXP */
|
||
} GtkTextSearchFlags;
|
||
|
||
/*
|
||
* Iter: represents a location in the text. Becomes invalid if the
|
||
* characters/pixmaps/widgets (indexable objects) in the text buffer
|
||
* are changed.
|
||
*/
|
||
|
||
typedef struct _GtkTextBuffer GtkTextBuffer;
|
||
|
||
#define GTK_TYPE_TEXT_ITER (gtk_text_iter_get_type ())
|
||
|
||
struct _GtkTextIter {
|
||
/* GtkTextIter is an opaque datatype; ignore all these fields.
|
||
* Initialize the iter with gtk_text_buffer_get_iter_*
|
||
* functions
|
||
*/
|
||
/*< private >*/
|
||
gpointer dummy1;
|
||
gpointer dummy2;
|
||
gint dummy3;
|
||
gint dummy4;
|
||
gint dummy5;
|
||
gint dummy6;
|
||
gint dummy7;
|
||
gint dummy8;
|
||
gpointer dummy9;
|
||
gpointer dummy10;
|
||
gint dummy11;
|
||
gint dummy12;
|
||
/* padding */
|
||
gint dummy13;
|
||
gpointer dummy14;
|
||
};
|
||
|
||
|
||
/* 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_ALL
|
||
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
|
||
GdkPaintable *gtk_text_iter_get_paintable (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_starts_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
|
||
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;
|
||
* in some languages, you can’t put the cursor between certain
|
||
* 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);
|
||
|
||
/* returns TRUE if a toggle was found; NULL for the tag pointer
|
||
* 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,
|
||
GtkTextIter *match_start,
|
||
GtkTextIter *match_end,
|
||
const GtkTextIter *limit);
|
||
|
||
GDK_AVAILABLE_IN_ALL
|
||
gboolean gtk_text_iter_backward_search (const GtkTextIter *iter,
|
||
const gchar *str,
|
||
GtkTextSearchFlags flags,
|
||
GtkTextIter *match_start,
|
||
GtkTextIter *match_end,
|
||
const GtkTextIter *limit);
|
||
|
||
/*
|
||
* 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);
|
||
|
||
G_END_DECLS
|
||
|
||
#endif
|