*
* 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
+ * 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, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * 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/.
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
-#ifndef GTK_TEXT_ITER_H
-#define GTK_TEXT_ITER_H
+#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/gtktextattributes.h>
+#include <gtk/gtktextchild.h>
#include <gtk/gtktexttag.h>
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
+
+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
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 dummy10;
- gint dummy11;
gint dummy5;
gint dummy6;
- gpointer dummy7;
- gpointer dummy8;
- gint dummy9;
- gpointer pad1;
- guint pad2;
+ 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. */
-GtkTextBuffer *gtk_text_iter_get_buffer(const GtkTextIter *iter);
+GtkTextBuffer *gtk_text_iter_get_buffer (const GtkTextIter *iter);
/*
* Life cycle
GtkTextIter *gtk_text_iter_copy (const GtkTextIter *iter);
void gtk_text_iter_free (GtkTextIter *iter);
+GDK_AVAILABLE_IN_3_2
+void gtk_text_iter_assign (GtkTextIter *iter,
+ const GtkTextIter *other);
+
+GType gtk_text_iter_get_type (void) G_GNUC_CONST;
/*
* Convert to different kinds of index
gint gtk_text_iter_get_line_offset (const GtkTextIter *iter);
gint gtk_text_iter_get_line_index (const GtkTextIter *iter);
+gint gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter);
+gint gtk_text_iter_get_visible_line_index (const GtkTextIter *iter);
+
/*
* "Dereference" operators
*/
gunichar gtk_text_iter_get_char (const GtkTextIter *iter);
-/* includes the 0xFFFD char for pixmaps/widgets, so char offsets
- into the returned string map properly into buffer char offsets */
+/* includes the 0xFFFC char for pixmaps/widgets, so char offsets
+ * into the returned string map properly into buffer char offsets
+ */
gchar *gtk_text_iter_get_slice (const GtkTextIter *start,
const GtkTextIter *end);
-/* includes only text, no 0xFFFD */
+/* includes only text, no 0xFFFC */
gchar *gtk_text_iter_get_text (const GtkTextIter *start,
const GtkTextIter *end);
/* exclude invisible chars */
GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter);
GSList * gtk_text_iter_get_marks (const GtkTextIter *iter);
+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) */
+ * whether the list is of on-toggles or off-toggles)
+ */
GSList *gtk_text_iter_get_toggled_tags (const GtkTextIter *iter,
- gboolean toggled_on);
+ gboolean toggled_on);
gboolean gtk_text_iter_begins_tag (const GtkTextIter *iter,
GtkTextTag *tag);
gboolean gtk_text_iter_has_tag (const GtkTextIter *iter,
GtkTextTag *tag);
+GSList *gtk_text_iter_get_tags (const GtkTextIter *iter);
gboolean gtk_text_iter_editable (const GtkTextIter *iter,
gboolean default_setting);
-
-gboolean gtk_text_iter_starts_line (const GtkTextIter *iter);
-gboolean gtk_text_iter_ends_line (const GtkTextIter *iter);
+gboolean gtk_text_iter_can_insert (const GtkTextIter *iter,
+ gboolean default_editability);
+
+gboolean gtk_text_iter_starts_word (const GtkTextIter *iter);
+gboolean gtk_text_iter_ends_word (const GtkTextIter *iter);
+gboolean gtk_text_iter_inside_word (const GtkTextIter *iter);
+gboolean gtk_text_iter_starts_sentence (const GtkTextIter *iter);
+gboolean gtk_text_iter_ends_sentence (const GtkTextIter *iter);
+gboolean gtk_text_iter_inside_sentence (const GtkTextIter *iter);
+gboolean gtk_text_iter_starts_line (const GtkTextIter *iter);
+gboolean gtk_text_iter_ends_line (const GtkTextIter *iter);
+gboolean gtk_text_iter_is_cursor_position (const GtkTextIter *iter);
gint gtk_text_iter_get_chars_in_line (const GtkTextIter *iter);
+gint gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter);
-gboolean gtk_text_iter_get_attributes (const GtkTextIter *iter,
- GtkTextAttributes *values);
-
-gboolean gtk_text_iter_is_last (const GtkTextIter *iter);
-gboolean gtk_text_iter_is_first (const GtkTextIter *iter);
+gboolean gtk_text_iter_get_attributes (const GtkTextIter *iter,
+ GtkTextAttributes *values);
+PangoLanguage* gtk_text_iter_get_language (const GtkTextIter *iter);
+gboolean gtk_text_iter_is_end (const GtkTextIter *iter);
+gboolean gtk_text_iter_is_start (const GtkTextIter *iter);
/*
* Moving around the buffer
*/
-gboolean gtk_text_iter_next_char (GtkTextIter *iter);
-gboolean gtk_text_iter_prev_char (GtkTextIter *iter);
+gboolean gtk_text_iter_forward_char (GtkTextIter *iter);
+gboolean gtk_text_iter_backward_char (GtkTextIter *iter);
gboolean gtk_text_iter_forward_chars (GtkTextIter *iter,
gint count);
gboolean gtk_text_iter_backward_chars (GtkTextIter *iter,
gint count);
gboolean gtk_text_iter_backward_lines (GtkTextIter *iter,
gint count);
+gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter);
+gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter);
gboolean gtk_text_iter_forward_word_ends (GtkTextIter *iter,
gint count);
gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter,
gint count);
-gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter);
-gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter);
+
+gboolean gtk_text_iter_forward_visible_line (GtkTextIter *iter);
+gboolean gtk_text_iter_backward_visible_line (GtkTextIter *iter);
+gboolean gtk_text_iter_forward_visible_lines (GtkTextIter *iter,
+ gint count);
+gboolean gtk_text_iter_backward_visible_lines (GtkTextIter *iter,
+ gint count);
+
+gboolean gtk_text_iter_forward_visible_word_end (GtkTextIter *iter);
+gboolean gtk_text_iter_backward_visible_word_start (GtkTextIter *iter);
+gboolean gtk_text_iter_forward_visible_word_ends (GtkTextIter *iter,
+ gint count);
+gboolean gtk_text_iter_backward_visible_word_starts (GtkTextIter *iter,
+ gint count);
+
+gboolean gtk_text_iter_forward_sentence_end (GtkTextIter *iter);
+gboolean gtk_text_iter_backward_sentence_start (GtkTextIter *iter);
+gboolean gtk_text_iter_forward_sentence_ends (GtkTextIter *iter,
+ gint count);
+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.
+ */
+gboolean gtk_text_iter_forward_cursor_position (GtkTextIter *iter);
+gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter);
+gboolean gtk_text_iter_forward_cursor_positions (GtkTextIter *iter,
+ gint count);
+gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter,
+ gint count);
+
+gboolean gtk_text_iter_forward_visible_cursor_position (GtkTextIter *iter);
+gboolean gtk_text_iter_backward_visible_cursor_position (GtkTextIter *iter);
+gboolean gtk_text_iter_forward_visible_cursor_positions (GtkTextIter *iter,
+ gint count);
+gboolean gtk_text_iter_backward_visible_cursor_positions (GtkTextIter *iter,
+ gint count);
void gtk_text_iter_set_offset (GtkTextIter *iter,
gint char_offset);
gint line_number);
void gtk_text_iter_set_line_offset (GtkTextIter *iter,
gint char_on_line);
+void gtk_text_iter_set_line_index (GtkTextIter *iter,
+ gint byte_on_line);
void gtk_text_iter_forward_to_end (GtkTextIter *iter);
-gboolean gtk_text_iter_forward_to_newline (GtkTextIter *iter);
+gboolean gtk_text_iter_forward_to_line_end (GtkTextIter *iter);
+
+void gtk_text_iter_set_visible_line_offset (GtkTextIter *iter,
+ gint char_on_line);
+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. */
+ * means "any tag toggle", otherwise the next toggle of the
+ * specified tag is located.
+ */
gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter,
GtkTextTag *tag);
typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data);
-gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter,
- GtkTextCharPredicate pred,
- gpointer user_data);
-
-gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter,
- GtkTextCharPredicate pred,
- gpointer user_data);
-
-gboolean gtk_text_iter_forward_search (GtkTextIter *iter,
- const char *str,
- gboolean visible_only,
- gboolean slice);
-
-gboolean gtk_text_iter_backward_search (GtkTextIter *iter,
- const char *str,
- gboolean visible_only,
- gboolean slice);
+gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter,
+ GtkTextCharPredicate pred,
+ gpointer user_data,
+ const GtkTextIter *limit);
+gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter,
+ GtkTextCharPredicate pred,
+ gpointer user_data,
+ const GtkTextIter *limit);
+
+gboolean gtk_text_iter_forward_search (const GtkTextIter *iter,
+ const gchar *str,
+ GtkTextSearchFlags flags,
+ GtkTextIter *match_start,
+ GtkTextIter *match_end,
+ const GtkTextIter *limit);
+
+gboolean gtk_text_iter_backward_search (const GtkTextIter *iter,
+ const gchar *str,
+ GtkTextSearchFlags flags,
+ GtkTextIter *match_start,
+ GtkTextIter *match_end,
+ const GtkTextIter *limit);
/*
* Comparisons
const GtkTextIter *rhs);
gint gtk_text_iter_compare (const GtkTextIter *lhs,
const GtkTextIter *rhs);
-gboolean gtk_text_iter_in_region (const GtkTextIter *iter,
+gboolean gtk_text_iter_in_range (const GtkTextIter *iter,
const GtkTextIter *start,
const GtkTextIter *end);
/* Put these two in ascending order */
-void gtk_text_iter_reorder (GtkTextIter *first,
+void gtk_text_iter_order (GtkTextIter *first,
GtkTextIter *second);
-/* Debug */
-void gtk_text_iter_spew (const GtkTextIter *iter,
- const gchar *desc);
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
#endif
-
-
projects / ~andy / gtk / blobdiff