1 /* GTK - The GIMP Toolkit
2 * gtktextbuffer.c Copyright (C) 2000 Red Hat, Inc.
3 * Copyright (C) 2004 Nokia Corporation
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
33 #include "gtkclipboard.h"
35 #include "gtkinvisible.h"
36 #include "gtkmarshalers.h"
37 #include "gtktextbuffer.h"
38 #include "gtktextbufferrichtext.h"
39 #include "gtktextbtree.h"
40 #include "gtktextiterprivate.h"
41 #include "gtkprivate.h"
46 #define GTK_TEXT_BUFFER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBufferPrivate))
48 typedef struct _GtkTextBufferPrivate GtkTextBufferPrivate;
50 struct _GtkTextBufferPrivate
52 GtkTargetList *copy_target_list;
53 GtkTargetEntry *copy_target_entries;
54 gint n_copy_target_entries;
56 GtkTargetList *paste_target_list;
57 GtkTargetEntry *paste_target_entries;
58 gint n_paste_target_entries;
62 typedef struct _ClipboardRequest ClipboardRequest;
64 struct _ClipboardRequest
66 GtkTextBuffer *buffer;
68 gboolean default_editable;
69 gboolean is_clipboard;
70 gboolean replace_selection;
99 PROP_COPY_TARGET_LIST,
100 PROP_PASTE_TARGET_LIST
103 static void gtk_text_buffer_finalize (GObject *object);
105 static void gtk_text_buffer_real_insert_text (GtkTextBuffer *buffer,
109 static void gtk_text_buffer_real_insert_pixbuf (GtkTextBuffer *buffer,
112 static void gtk_text_buffer_real_insert_anchor (GtkTextBuffer *buffer,
114 GtkTextChildAnchor *anchor);
115 static void gtk_text_buffer_real_delete_range (GtkTextBuffer *buffer,
118 static void gtk_text_buffer_real_apply_tag (GtkTextBuffer *buffer,
120 const GtkTextIter *start_char,
121 const GtkTextIter *end_char);
122 static void gtk_text_buffer_real_remove_tag (GtkTextBuffer *buffer,
124 const GtkTextIter *start_char,
125 const GtkTextIter *end_char);
126 static void gtk_text_buffer_real_changed (GtkTextBuffer *buffer);
127 static void gtk_text_buffer_real_mark_set (GtkTextBuffer *buffer,
128 const GtkTextIter *iter,
131 static GtkTextBTree* get_btree (GtkTextBuffer *buffer);
132 static void free_log_attr_cache (GtkTextLogAttrCache *cache);
134 static void remove_all_selection_clipboards (GtkTextBuffer *buffer);
135 static void update_selection_clipboards (GtkTextBuffer *buffer);
137 static GtkTextBuffer *create_clipboard_contents_buffer (GtkTextBuffer *buffer);
139 static void gtk_text_buffer_free_target_lists (GtkTextBuffer *buffer);
141 static guint signals[LAST_SIGNAL] = { 0 };
143 static void gtk_text_buffer_set_property (GObject *object,
147 static void gtk_text_buffer_get_property (GObject *object,
151 static void gtk_text_buffer_notify (GObject *object,
154 G_DEFINE_TYPE (GtkTextBuffer, gtk_text_buffer, G_TYPE_OBJECT)
157 gtk_text_buffer_class_init (GtkTextBufferClass *klass)
159 GObjectClass *object_class = G_OBJECT_CLASS (klass);
161 object_class->finalize = gtk_text_buffer_finalize;
162 object_class->set_property = gtk_text_buffer_set_property;
163 object_class->get_property = gtk_text_buffer_get_property;
164 object_class->notify = gtk_text_buffer_notify;
166 klass->insert_text = gtk_text_buffer_real_insert_text;
167 klass->insert_pixbuf = gtk_text_buffer_real_insert_pixbuf;
168 klass->insert_child_anchor = gtk_text_buffer_real_insert_anchor;
169 klass->delete_range = gtk_text_buffer_real_delete_range;
170 klass->apply_tag = gtk_text_buffer_real_apply_tag;
171 klass->remove_tag = gtk_text_buffer_real_remove_tag;
172 klass->changed = gtk_text_buffer_real_changed;
173 klass->mark_set = gtk_text_buffer_real_mark_set;
176 g_object_class_install_property (object_class,
178 g_param_spec_object ("tag-table",
180 P_("Text Tag Table"),
181 GTK_TYPE_TEXT_TAG_TABLE,
182 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
184 /* Normal properties*/
187 * GtkTextBuffer:text:
189 * The text content of the buffer. Without child widgets and images,
190 * see gtk_text_buffer_get_text() for more information.
194 g_object_class_install_property (object_class,
196 g_param_spec_string ("text",
198 P_("Current text of the buffer"),
200 GTK_PARAM_READWRITE));
203 * GtkTextBuffer:has-selection:
205 * Whether the buffer has some text currently selected.
209 g_object_class_install_property (object_class,
211 g_param_spec_boolean ("has-selection",
213 P_("Whether the buffer has some text currently selected"),
215 GTK_PARAM_READABLE));
218 * GtkTextBuffer:cursor-position:
220 * The position of the insert mark (as offset from the beginning
221 * of the buffer). It is useful for getting notified when the
226 g_object_class_install_property (object_class,
227 PROP_CURSOR_POSITION,
228 g_param_spec_int ("cursor-position",
229 P_("Cursor position"),
230 P_("The position of the insert mark (as offset from the beginning of the buffer)"),
232 GTK_PARAM_READABLE));
235 * GtkTextBuffer:copy-target-list:
237 * The list of targets this buffer supports for clipboard copying
242 g_object_class_install_property (object_class,
243 PROP_COPY_TARGET_LIST,
244 g_param_spec_boxed ("copy-target-list",
245 P_("Copy target list"),
246 P_("The list of targets this buffer supports for clipboard copying and DND source"),
247 GTK_TYPE_TARGET_LIST,
248 GTK_PARAM_READABLE));
251 * GtkTextBuffer:paste-target-list:
253 * The list of targets this buffer supports for clipboard pasting
254 * and as DND destination.
258 g_object_class_install_property (object_class,
259 PROP_PASTE_TARGET_LIST,
260 g_param_spec_boxed ("paste-target-list",
261 P_("Paste target list"),
262 P_("The list of targets this buffer supports for clipboard pasting and DND destination"),
263 GTK_TYPE_TARGET_LIST,
264 GTK_PARAM_READABLE));
267 * GtkTextBuffer::insert-text:
268 * @textbuffer: the object which received the signal
269 * @location: position to insert @text in @textbuffer
270 * @text: the UTF-8 text to be inserted
271 * @len: length of the inserted text in bytes
273 * The insert_text signal is emitted to insert text in a #GtkTextBuffer.
274 * Insertion actually occurs in the default handler.
276 * Note that if your handler runs before the default handler it must not
277 * invalidate the @location iter (or has to revalidate it).
278 * The default signal handler revalidates it to point to the end of the
282 * gtk_text_buffer_insert(),
283 * gtk_text_buffer_insert_range().
285 signals[INSERT_TEXT] =
286 g_signal_new (I_("insert_text"),
287 G_OBJECT_CLASS_TYPE (object_class),
289 G_STRUCT_OFFSET (GtkTextBufferClass, insert_text),
291 _gtk_marshal_VOID__BOXED_STRING_INT,
294 GTK_TYPE_TEXT_ITER | G_SIGNAL_TYPE_STATIC_SCOPE,
295 G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE,
299 * GtkTextBuffer::insert-pixbuf:
300 * @textbuffer: the object which received the signal
301 * @location: position to insert @pixbuf in @textbuffer
302 * @pixbuf: the #GdkPixbuf to be inserted
304 * The insert_pixbuf signal is emitted to insert a #GdkPixbuf
305 * in a #GtkTextBuffer. Insertion actually occurs in the default handler.
307 * Note that if your handler runs before the default handler it must not
308 * invalidate the @location iter (or has to revalidate it).
309 * The default signal handler revalidates it to be placed after the
312 * See also: gtk_text_buffer_insert_pixbuf().
314 signals[INSERT_PIXBUF] =
315 g_signal_new (I_("insert_pixbuf"),
316 G_OBJECT_CLASS_TYPE (object_class),
318 G_STRUCT_OFFSET (GtkTextBufferClass, insert_pixbuf),
320 _gtk_marshal_VOID__BOXED_OBJECT,
323 GTK_TYPE_TEXT_ITER | G_SIGNAL_TYPE_STATIC_SCOPE,
328 * GtkTextBuffer::insert-child-anchor:
329 * @textbuffer: the object which received the signal
330 * @location: position to insert @anchor in @textbuffer
331 * @anchor: the #GtkTextChildAnchor to be inserted
333 * The insert_child_anchor signal is emitted to insert a
334 * #GtkTextChildAnchor in a #GtkTextBuffer.
335 * Insertion actually occurs in the default handler.
337 * Note that if your handler runs before the default handler it must
338 * not invalidate the @location iter (or has to revalidate it).
339 * The default signal handler revalidates it to be placed after the
342 * See also: gtk_text_buffer_insert_child_anchor().
344 signals[INSERT_CHILD_ANCHOR] =
345 g_signal_new (I_("insert_child_anchor"),
346 G_OBJECT_CLASS_TYPE (object_class),
348 G_STRUCT_OFFSET (GtkTextBufferClass, insert_child_anchor),
350 _gtk_marshal_VOID__BOXED_OBJECT,
353 GTK_TYPE_TEXT_ITER | G_SIGNAL_TYPE_STATIC_SCOPE,
354 GTK_TYPE_TEXT_CHILD_ANCHOR);
357 * GtkTextBuffer::delete-range:
358 * @textbuffer: the object which received the signal
359 * @start: the start of the range to be deleted
360 * @end: the end of the range to be deleted
362 * The delete_range signal is emitted to delete a range
363 * from a #GtkTextBuffer.
365 * Note that if your handler runs before the default handler it must not
366 * invalidate the @start and @end iters (or has to revalidate them).
367 * The default signal handler revalidates the @start and @end iters to
368 * both point point to the location where text was deleted. Handlers
369 * which run after the default handler (see g_signal_connect_after())
370 * do not have access to the deleted text.
372 * See also: gtk_text_buffer_delete().
374 signals[DELETE_RANGE] =
375 g_signal_new (I_("delete_range"),
376 G_OBJECT_CLASS_TYPE (object_class),
378 G_STRUCT_OFFSET (GtkTextBufferClass, delete_range),
380 _gtk_marshal_VOID__BOXED_BOXED,
383 GTK_TYPE_TEXT_ITER | G_SIGNAL_TYPE_STATIC_SCOPE,
384 GTK_TYPE_TEXT_ITER | G_SIGNAL_TYPE_STATIC_SCOPE);
387 * GtkTextBuffer::changed:
388 * @textbuffer: the object which received the signal
390 * The changed signal is emitted when the content of a #GtkTextBuffer
394 g_signal_new (I_("changed"),
395 G_OBJECT_CLASS_TYPE (object_class),
397 G_STRUCT_OFFSET (GtkTextBufferClass, changed),
399 _gtk_marshal_VOID__VOID,
404 * GtkTextBuffer::modified-changed:
405 * @textbuffer: the object which received the signal
407 * The modified_changed signal is emitted when the modified bit of a
408 * #GtkTextBuffer flips.
411 * gtk_text_buffer_set_modified().
413 signals[MODIFIED_CHANGED] =
414 g_signal_new (I_("modified_changed"),
415 G_OBJECT_CLASS_TYPE (object_class),
417 G_STRUCT_OFFSET (GtkTextBufferClass, modified_changed),
419 _gtk_marshal_VOID__VOID,
424 * GtkTextBuffer::mark-set:
425 * @textbuffer: the object which received the signal
426 * @location: The location of @mark in @textbuffer
427 * @mark: The mark that is set
429 * The mark_set signal is emitted as notification
430 * after a #GtkTextMark is set.
433 * gtk_text_buffer_create_mark(),
434 * gtk_text_buffer_move_mark().
437 g_signal_new (I_("mark_set"),
438 G_OBJECT_CLASS_TYPE (object_class),
440 G_STRUCT_OFFSET (GtkTextBufferClass, mark_set),
442 _gtk_marshal_VOID__BOXED_OBJECT,
449 * GtkTextBuffer::mark-deleted:
450 * @textbuffer: the object which received the signal
451 * @mark: The mark that was deleted
453 * The mark_deleted signal is emitted as notification
454 * after a #GtkTextMark is deleted.
457 * gtk_text_buffer_delete_mark().
459 signals[MARK_DELETED] =
460 g_signal_new (I_("mark_deleted"),
461 G_OBJECT_CLASS_TYPE (object_class),
463 G_STRUCT_OFFSET (GtkTextBufferClass, mark_deleted),
465 _gtk_marshal_VOID__OBJECT,
471 * GtkTextBuffer::apply-tag:
472 * @textbuffer: the object which received the signal
473 * @tag: the applied tag
474 * @start: the start of the range the tag is applied to
475 * @end: the end of the range the tag is applied to
477 * The apply_tag signal is emitted to apply a tag to a
478 * range of text in a #GtkTextBuffer.
479 * Applying actually occurs in the default handler.
481 * Note that if your handler runs before the default handler it must not
482 * invalidate the @start and @end iters (or has to revalidate them).
485 * gtk_text_buffer_apply_tag(),
486 * gtk_text_buffer_insert_with_tags(),
487 * gtk_text_buffer_insert_range().
490 g_signal_new (I_("apply_tag"),
491 G_OBJECT_CLASS_TYPE (object_class),
493 G_STRUCT_OFFSET (GtkTextBufferClass, apply_tag),
495 _gtk_marshal_VOID__OBJECT_BOXED_BOXED,
504 * GtkTextBuffer::remove-tag:
505 * @textbuffer: the object which received the signal
506 * @tag: the tag to be removed
507 * @start: the start of the range the tag is removed from
508 * @end: the end of the range the tag is removed from
510 * The remove_tag signal is emitted to remove all occurrences of @tag from a
511 * range of text in a #GtkTextBuffer.
512 * Removal actually occurs in the default handler.
514 * Note that if your handler runs before the default handler it must not
515 * invalidate the @start and @end iters (or has to revalidate them).
518 * gtk_text_buffer_remove_tag().
520 signals[REMOVE_TAG] =
521 g_signal_new (I_("remove_tag"),
522 G_OBJECT_CLASS_TYPE (object_class),
524 G_STRUCT_OFFSET (GtkTextBufferClass, remove_tag),
526 _gtk_marshal_VOID__OBJECT_BOXED_BOXED,
534 * GtkTextBuffer::begin-user-action:
535 * @textbuffer: the object which received the signal
537 * The begin_user_action signal is emitted at the beginning of a single
538 * user-visible operation on a #GtkTextBuffer.
541 * gtk_text_buffer_begin_user_action(),
542 * gtk_text_buffer_insert_interactive(),
543 * gtk_text_buffer_insert_range_interactive(),
544 * gtk_text_buffer_delete_interactive(),
545 * gtk_text_buffer_backspace(),
546 * gtk_text_buffer_delete_selection().
548 signals[BEGIN_USER_ACTION] =
549 g_signal_new (I_("begin_user_action"),
550 G_OBJECT_CLASS_TYPE (object_class),
552 G_STRUCT_OFFSET (GtkTextBufferClass, begin_user_action),
554 _gtk_marshal_VOID__VOID,
559 * GtkTextBuffer::end-user-action:
560 * @textbuffer: the object which received the signal
562 * The end_user_action signal is emitted at the end of a single
563 * user-visible operation #GtkTextBuffer.
566 * gtk_text_buffer_end_user_action(),
567 * gtk_text_buffer_insert_interactive(),
568 * gtk_text_buffer_insert_range_interactive(),
569 * gtk_text_buffer_delete_interactive(),
570 * gtk_text_buffer_backspace(),
571 * gtk_text_buffer_delete_selection(),
572 * gtk_text_buffer_backspace().
574 signals[END_USER_ACTION] =
575 g_signal_new (I_("end_user_action"),
576 G_OBJECT_CLASS_TYPE (object_class),
578 G_STRUCT_OFFSET (GtkTextBufferClass, end_user_action),
580 _gtk_marshal_VOID__VOID,
584 g_type_class_add_private (object_class, sizeof (GtkTextBufferPrivate));
588 gtk_text_buffer_init (GtkTextBuffer *buffer)
590 buffer->clipboard_contents_buffers = NULL;
591 buffer->tag_table = NULL;
593 /* allow copying of arbiatray stuff in the internal rich text format */
594 gtk_text_buffer_register_serialize_tagset (buffer, NULL);
598 set_table (GtkTextBuffer *buffer, GtkTextTagTable *table)
600 g_return_if_fail (buffer->tag_table == NULL);
604 buffer->tag_table = table;
605 g_object_ref (buffer->tag_table);
606 _gtk_text_tag_table_add_buffer (table, buffer);
610 static GtkTextTagTable*
611 get_table (GtkTextBuffer *buffer)
613 if (buffer->tag_table == NULL)
615 buffer->tag_table = gtk_text_tag_table_new ();
616 _gtk_text_tag_table_add_buffer (buffer->tag_table, buffer);
619 return buffer->tag_table;
623 gtk_text_buffer_set_property (GObject *object,
628 GtkTextBuffer *text_buffer;
630 text_buffer = GTK_TEXT_BUFFER (object);
635 set_table (text_buffer, g_value_get_object (value));
639 gtk_text_buffer_set_text (text_buffer,
640 g_value_get_string (value), -1);
649 gtk_text_buffer_get_property (GObject *object,
654 GtkTextBuffer *text_buffer;
657 text_buffer = GTK_TEXT_BUFFER (object);
662 g_value_set_object (value, get_table (text_buffer));
667 GtkTextIter start, end;
669 gtk_text_buffer_get_start_iter (text_buffer, &start);
670 gtk_text_buffer_get_end_iter (text_buffer, &end);
672 g_value_take_string (value,
673 gtk_text_buffer_get_text (text_buffer,
674 &start, &end, FALSE));
678 case PROP_HAS_SELECTION:
679 g_value_set_boolean (value, text_buffer->has_selection);
682 case PROP_CURSOR_POSITION:
683 gtk_text_buffer_get_iter_at_mark (text_buffer, &iter,
684 gtk_text_buffer_get_insert (text_buffer));
685 g_value_set_int (value, gtk_text_iter_get_offset (&iter));
688 case PROP_COPY_TARGET_LIST:
689 g_value_set_boxed (value, gtk_text_buffer_get_copy_target_list (text_buffer));
692 case PROP_PASTE_TARGET_LIST:
693 g_value_set_boxed (value, gtk_text_buffer_get_paste_target_list (text_buffer));
702 gtk_text_buffer_notify (GObject *object,
705 if (!strcmp (pspec->name, "copy-target-list") ||
706 !strcmp (pspec->name, "paste-target-list"))
708 gtk_text_buffer_free_target_lists (GTK_TEXT_BUFFER (object));
713 * gtk_text_buffer_new:
714 * @table: a tag table, or %NULL to create a new one
716 * Creates a new text buffer.
718 * Return value: a new text buffer
721 gtk_text_buffer_new (GtkTextTagTable *table)
723 GtkTextBuffer *text_buffer;
725 text_buffer = g_object_new (GTK_TYPE_TEXT_BUFFER, "tag-table", table, NULL);
731 gtk_text_buffer_finalize (GObject *object)
733 GtkTextBuffer *buffer;
735 buffer = GTK_TEXT_BUFFER (object);
737 remove_all_selection_clipboards (buffer);
739 if (buffer->tag_table)
741 _gtk_text_tag_table_remove_buffer (buffer->tag_table, buffer);
742 g_object_unref (buffer->tag_table);
743 buffer->tag_table = NULL;
748 _gtk_text_btree_unref (buffer->btree);
749 buffer->btree = NULL;
752 if (buffer->log_attr_cache)
753 free_log_attr_cache (buffer->log_attr_cache);
755 buffer->log_attr_cache = NULL;
757 gtk_text_buffer_free_target_lists (buffer);
759 G_OBJECT_CLASS (gtk_text_buffer_parent_class)->finalize (object);
763 get_btree (GtkTextBuffer *buffer)
765 if (buffer->btree == NULL)
766 buffer->btree = _gtk_text_btree_new (gtk_text_buffer_get_tag_table (buffer),
769 return buffer->btree;
773 _gtk_text_buffer_get_btree (GtkTextBuffer *buffer)
775 return get_btree (buffer);
779 * gtk_text_buffer_get_tag_table:
780 * @buffer: a #GtkTextBuffer
782 * Get the #GtkTextTagTable associated with this buffer.
784 * Return value: the buffer's tag table
787 gtk_text_buffer_get_tag_table (GtkTextBuffer *buffer)
789 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
791 return get_table (buffer);
795 * gtk_text_buffer_set_text:
796 * @buffer: a #GtkTextBuffer
797 * @text: UTF-8 text to insert
798 * @len: length of @text in bytes
800 * Deletes current contents of @buffer, and inserts @text instead. If
801 * @len is -1, @text must be nul-terminated. @text must be valid UTF-8.
804 gtk_text_buffer_set_text (GtkTextBuffer *buffer,
808 GtkTextIter start, end;
810 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
811 g_return_if_fail (text != NULL);
816 gtk_text_buffer_get_bounds (buffer, &start, &end);
818 gtk_text_buffer_delete (buffer, &start, &end);
822 gtk_text_buffer_get_iter_at_offset (buffer, &start, 0);
823 gtk_text_buffer_insert (buffer, &start, text, len);
826 g_object_notify (G_OBJECT (buffer), "text");
836 gtk_text_buffer_real_insert_text (GtkTextBuffer *buffer,
841 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
842 g_return_if_fail (iter != NULL);
844 _gtk_text_btree_insert (iter, text, len);
846 g_signal_emit (buffer, signals[CHANGED], 0);
847 g_object_notify (G_OBJECT (buffer), "cursor-position");
851 gtk_text_buffer_emit_insert (GtkTextBuffer *buffer,
856 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
857 g_return_if_fail (iter != NULL);
858 g_return_if_fail (text != NULL);
863 g_return_if_fail (g_utf8_validate (text, len, NULL));
867 g_signal_emit (buffer, signals[INSERT_TEXT], 0,
873 * gtk_text_buffer_insert:
874 * @buffer: a #GtkTextBuffer
875 * @iter: a position in the buffer
876 * @text: UTF-8 format text to insert
877 * @len: length of text in bytes, or -1
879 * Inserts @len bytes of @text at position @iter. If @len is -1,
880 * @text must be nul-terminated and will be inserted in its
881 * entirety. Emits the "insert_text" signal; insertion actually occurs
882 * in the default handler for the signal. @iter is invalidated when
883 * insertion occurs (because the buffer contents change), but the
884 * default signal handler revalidates it to point to the end of the
888 gtk_text_buffer_insert (GtkTextBuffer *buffer,
893 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
894 g_return_if_fail (iter != NULL);
895 g_return_if_fail (text != NULL);
896 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
898 gtk_text_buffer_emit_insert (buffer, iter, text, len);
902 * gtk_text_buffer_insert_at_cursor:
903 * @buffer: a #GtkTextBuffer
904 * @text: some text in UTF-8 format
905 * @len: length of text, in bytes
907 * Simply calls gtk_text_buffer_insert(), using the current
908 * cursor position as the insertion point.
911 gtk_text_buffer_insert_at_cursor (GtkTextBuffer *buffer,
917 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
918 g_return_if_fail (text != NULL);
920 gtk_text_buffer_get_iter_at_mark (buffer, &iter,
921 gtk_text_buffer_get_mark (buffer,
924 gtk_text_buffer_insert (buffer, &iter, text, len);
928 * gtk_text_buffer_insert_interactive:
929 * @buffer: a #GtkTextBuffer
930 * @iter: a position in @buffer
931 * @text: some UTF-8 text
932 * @len: length of text in bytes, or -1
933 * @default_editable: default editability of buffer
935 * Like gtk_text_buffer_insert(), but the insertion will not occur if
936 * @iter is at a non-editable location in the buffer. Usually you
937 * want to prevent insertions at ineditable locations if the insertion
938 * results from a user action (is interactive).
940 * @default_editable indicates the editability of text that doesn't
941 * have a tag affecting editability applied to it. Typically the
942 * result of gtk_text_view_get_editable() is appropriate here.
944 * Return value: whether text was actually inserted
947 gtk_text_buffer_insert_interactive (GtkTextBuffer *buffer,
951 gboolean default_editable)
953 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
954 g_return_val_if_fail (text != NULL, FALSE);
955 g_return_val_if_fail (gtk_text_iter_get_buffer (iter) == buffer, FALSE);
957 if (gtk_text_iter_can_insert (iter, default_editable))
959 gtk_text_buffer_begin_user_action (buffer);
960 gtk_text_buffer_emit_insert (buffer, iter, text, len);
961 gtk_text_buffer_end_user_action (buffer);
969 * gtk_text_buffer_insert_interactive_at_cursor:
970 * @buffer: a #GtkTextBuffer
971 * @text: text in UTF-8 format
972 * @len: length of text in bytes, or -1
973 * @default_editable: default editability of buffer
975 * Calls gtk_text_buffer_insert_interactive() at the cursor
978 * @default_editable indicates the editability of text that doesn't
979 * have a tag affecting editability applied to it. Typically the
980 * result of gtk_text_view_get_editable() is appropriate here.
982 * Return value: whether text was actually inserted
985 gtk_text_buffer_insert_interactive_at_cursor (GtkTextBuffer *buffer,
988 gboolean default_editable)
992 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
993 g_return_val_if_fail (text != NULL, FALSE);
995 gtk_text_buffer_get_iter_at_mark (buffer, &iter,
996 gtk_text_buffer_get_mark (buffer,
999 return gtk_text_buffer_insert_interactive (buffer, &iter, text, len,
1004 possibly_not_text (gunichar ch,
1007 return ch == GTK_TEXT_UNKNOWN_CHAR;
1011 insert_text_range (GtkTextBuffer *buffer,
1013 const GtkTextIter *orig_start,
1014 const GtkTextIter *orig_end,
1015 gboolean interactive)
1019 text = gtk_text_iter_get_text (orig_start, orig_end);
1021 gtk_text_buffer_emit_insert (buffer, iter, text, -1);
1026 typedef struct _Range Range;
1029 GtkTextBuffer *buffer;
1030 GtkTextMark *start_mark;
1031 GtkTextMark *end_mark;
1032 GtkTextMark *whole_end_mark;
1033 GtkTextIter *range_start;
1034 GtkTextIter *range_end;
1035 GtkTextIter *whole_end;
1039 save_range (GtkTextIter *range_start,
1040 GtkTextIter *range_end,
1041 GtkTextIter *whole_end)
1045 r = g_new (Range, 1);
1047 r->buffer = gtk_text_iter_get_buffer (range_start);
1048 g_object_ref (r->buffer);
1051 gtk_text_buffer_create_mark (gtk_text_iter_get_buffer (range_start),
1056 gtk_text_buffer_create_mark (gtk_text_iter_get_buffer (range_start),
1062 gtk_text_buffer_create_mark (gtk_text_iter_get_buffer (range_start),
1067 r->range_start = range_start;
1068 r->range_end = range_end;
1069 r->whole_end = whole_end;
1075 restore_range (Range *r)
1077 gtk_text_buffer_get_iter_at_mark (r->buffer,
1081 gtk_text_buffer_get_iter_at_mark (r->buffer,
1085 gtk_text_buffer_get_iter_at_mark (r->buffer,
1089 gtk_text_buffer_delete_mark (r->buffer, r->start_mark);
1090 gtk_text_buffer_delete_mark (r->buffer, r->end_mark);
1091 gtk_text_buffer_delete_mark (r->buffer, r->whole_end_mark);
1093 /* Due to the gravities on the marks, the ordering could have
1094 * gotten mangled; we switch to an empty range in that
1098 if (gtk_text_iter_compare (r->range_start, r->range_end) > 0)
1099 *r->range_start = *r->range_end;
1101 if (gtk_text_iter_compare (r->range_end, r->whole_end) > 0)
1102 *r->range_end = *r->whole_end;
1104 g_object_unref (r->buffer);
1109 insert_range_untagged (GtkTextBuffer *buffer,
1111 const GtkTextIter *orig_start,
1112 const GtkTextIter *orig_end,
1113 gboolean interactive)
1115 GtkTextIter range_start;
1116 GtkTextIter range_end;
1117 GtkTextIter start, end;
1120 if (gtk_text_iter_equal (orig_start, orig_end))
1123 start = *orig_start;
1126 range_start = start;
1131 if (gtk_text_iter_equal (&range_start, &range_end))
1133 /* Figure out how to move forward */
1135 g_assert (gtk_text_iter_compare (&range_end, &end) <= 0);
1137 if (gtk_text_iter_equal (&range_end, &end))
1139 /* nothing left to do */
1142 else if (gtk_text_iter_get_char (&range_end) == GTK_TEXT_UNKNOWN_CHAR)
1144 GdkPixbuf *pixbuf = NULL;
1145 GtkTextChildAnchor *anchor = NULL;
1146 pixbuf = gtk_text_iter_get_pixbuf (&range_end);
1147 anchor = gtk_text_iter_get_child_anchor (&range_end);
1151 r = save_range (&range_start,
1155 gtk_text_buffer_insert_pixbuf (buffer,
1162 gtk_text_iter_forward_char (&range_end);
1164 range_start = range_end;
1168 /* Just skip anchors */
1170 gtk_text_iter_forward_char (&range_end);
1171 range_start = range_end;
1175 /* The GTK_TEXT_UNKNOWN_CHAR was in a text segment, so
1178 gtk_text_iter_forward_find_char (&range_end,
1179 possibly_not_text, NULL,
1182 g_assert (gtk_text_iter_compare (&range_end, &end) <= 0);
1187 /* Text segment starts here, so forward search to
1188 * find its possible endpoint
1190 gtk_text_iter_forward_find_char (&range_end,
1191 possibly_not_text, NULL,
1194 g_assert (gtk_text_iter_compare (&range_end, &end) <= 0);
1199 r = save_range (&range_start,
1203 insert_text_range (buffer,
1212 range_start = range_end;
1218 insert_range_not_inside_self (GtkTextBuffer *buffer,
1220 const GtkTextIter *orig_start,
1221 const GtkTextIter *orig_end,
1222 gboolean interactive)
1224 /* Find each range of uniformly-tagged text, insert it,
1225 * then apply the tags.
1227 GtkTextIter start = *orig_start;
1228 GtkTextIter end = *orig_end;
1229 GtkTextIter range_start;
1230 GtkTextIter range_end;
1232 if (gtk_text_iter_equal (orig_start, orig_end))
1235 gtk_text_iter_order (&start, &end);
1237 range_start = start;
1243 GtkTextIter start_iter;
1248 if (gtk_text_iter_equal (&range_start, &end))
1249 break; /* All done */
1251 g_assert (gtk_text_iter_compare (&range_start, &end) < 0);
1253 gtk_text_iter_forward_to_tag_toggle (&range_end, NULL);
1255 g_assert (!gtk_text_iter_equal (&range_start, &range_end));
1257 /* Clamp to the end iterator */
1258 if (gtk_text_iter_compare (&range_end, &end) > 0)
1261 /* We have a range with unique tags; insert it, and
1264 start_offset = gtk_text_iter_get_offset (iter);
1266 r = save_range (&range_start, &range_end, &end);
1268 insert_range_untagged (buffer, iter, &range_start, &range_end, interactive);
1273 gtk_text_buffer_get_iter_at_offset (buffer, &start_iter, start_offset);
1275 tags = gtk_text_iter_get_tags (&range_start);
1277 while (tmp_list != NULL)
1279 gtk_text_buffer_apply_tag (buffer,
1284 tmp_list = g_slist_next (tmp_list);
1286 g_slist_free (tags);
1288 range_start = range_end;
1293 gtk_text_buffer_real_insert_range (GtkTextBuffer *buffer,
1295 const GtkTextIter *orig_start,
1296 const GtkTextIter *orig_end,
1297 gboolean interactive)
1299 GtkTextBuffer *src_buffer;
1301 /* Find each range of uniformly-tagged text, insert it,
1302 * then apply the tags.
1304 if (gtk_text_iter_equal (orig_start, orig_end))
1308 gtk_text_buffer_begin_user_action (buffer);
1310 src_buffer = gtk_text_iter_get_buffer (orig_start);
1312 if (gtk_text_iter_get_buffer (iter) != src_buffer ||
1313 !gtk_text_iter_in_range (iter, orig_start, orig_end))
1315 insert_range_not_inside_self (buffer, iter, orig_start, orig_end, interactive);
1319 /* If you insert a range into itself, it could loop infinitely
1320 * because the region being copied keeps growing as we insert. So
1321 * we have to separately copy the range before and after
1322 * the insertion point.
1324 GtkTextIter start = *orig_start;
1325 GtkTextIter end = *orig_end;
1326 GtkTextIter range_start;
1327 GtkTextIter range_end;
1331 gtk_text_iter_order (&start, &end);
1333 range_start = start;
1335 first_half = save_range (&range_start, &range_end, &end);
1337 range_start = *iter;
1339 second_half = save_range (&range_start, &range_end, &end);
1341 restore_range (first_half);
1342 insert_range_not_inside_self (buffer, iter, &range_start, &range_end, interactive);
1344 restore_range (second_half);
1345 insert_range_not_inside_self (buffer, iter, &range_start, &range_end, interactive);
1349 gtk_text_buffer_end_user_action (buffer);
1353 * gtk_text_buffer_insert_range:
1354 * @buffer: a #GtkTextBuffer
1355 * @iter: a position in @buffer
1356 * @start: a position in a #GtkTextBuffer
1357 * @end: another position in the same buffer as @start
1359 * Copies text, tags, and pixbufs between @start and @end (the order
1360 * of @start and @end doesn't matter) and inserts the copy at @iter.
1361 * Used instead of simply getting/inserting text because it preserves
1362 * images and tags. If @start and @end are in a different buffer from
1363 * @buffer, the two buffers must share the same tag table.
1365 * Implemented via emissions of the insert_text and apply_tag signals,
1369 gtk_text_buffer_insert_range (GtkTextBuffer *buffer,
1371 const GtkTextIter *start,
1372 const GtkTextIter *end)
1374 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1375 g_return_if_fail (iter != NULL);
1376 g_return_if_fail (start != NULL);
1377 g_return_if_fail (end != NULL);
1378 g_return_if_fail (gtk_text_iter_get_buffer (start) ==
1379 gtk_text_iter_get_buffer (end));
1380 g_return_if_fail (gtk_text_iter_get_buffer (start)->tag_table ==
1382 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
1384 gtk_text_buffer_real_insert_range (buffer, iter, start, end, FALSE);
1388 * gtk_text_buffer_insert_range_interactive:
1389 * @buffer: a #GtkTextBuffer
1390 * @iter: a position in @buffer
1391 * @start: a position in a #GtkTextBuffer
1392 * @end: another position in the same buffer as @start
1393 * @default_editable: default editability of the buffer
1395 * Same as gtk_text_buffer_insert_range(), but does nothing if the
1396 * insertion point isn't editable. The @default_editable parameter
1397 * indicates whether the text is editable at @iter if no tags
1398 * enclosing @iter affect editability. Typically the result of
1399 * gtk_text_view_get_editable() is appropriate here.
1401 * Returns: whether an insertion was possible at @iter
1404 gtk_text_buffer_insert_range_interactive (GtkTextBuffer *buffer,
1406 const GtkTextIter *start,
1407 const GtkTextIter *end,
1408 gboolean default_editable)
1410 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
1411 g_return_val_if_fail (iter != NULL, FALSE);
1412 g_return_val_if_fail (start != NULL, FALSE);
1413 g_return_val_if_fail (end != NULL, FALSE);
1414 g_return_val_if_fail (gtk_text_iter_get_buffer (start) ==
1415 gtk_text_iter_get_buffer (end), FALSE);
1416 g_return_val_if_fail (gtk_text_iter_get_buffer (start)->tag_table ==
1417 buffer->tag_table, FALSE);
1420 if (gtk_text_iter_can_insert (iter, default_editable))
1422 gtk_text_buffer_real_insert_range (buffer, iter, start, end, TRUE);
1430 * gtk_text_buffer_insert_with_tags:
1431 * @buffer: a #GtkTextBuffer
1432 * @iter: an iterator in @buffer
1434 * @len: length of @text, or -1
1435 * @first_tag: first tag to apply to @text
1436 * @Varargs: NULL-terminated list of tags to apply
1438 * Inserts @text into @buffer at @iter, applying the list of tags to
1439 * the newly-inserted text. The last tag specified must be NULL to
1440 * terminate the list. Equivalent to calling gtk_text_buffer_insert(),
1441 * then gtk_text_buffer_apply_tag() on the inserted text;
1442 * gtk_text_buffer_insert_with_tags() is just a convenience function.
1445 gtk_text_buffer_insert_with_tags (GtkTextBuffer *buffer,
1449 GtkTextTag *first_tag,
1457 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1458 g_return_if_fail (iter != NULL);
1459 g_return_if_fail (text != NULL);
1460 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
1462 start_offset = gtk_text_iter_get_offset (iter);
1464 gtk_text_buffer_insert (buffer, iter, text, len);
1466 if (first_tag == NULL)
1469 gtk_text_buffer_get_iter_at_offset (buffer, &start, start_offset);
1471 va_start (args, first_tag);
1475 gtk_text_buffer_apply_tag (buffer, tag, &start, iter);
1477 tag = va_arg (args, GtkTextTag*);
1484 * gtk_text_buffer_insert_with_tags_by_name:
1485 * @buffer: a #GtkTextBuffer
1486 * @iter: position in @buffer
1488 * @len: length of @text, or -1
1489 * @first_tag_name: name of a tag to apply to @text
1490 * @Varargs: more tag names
1492 * Same as gtk_text_buffer_insert_with_tags(), but allows you
1493 * to pass in tag names instead of tag objects.
1496 gtk_text_buffer_insert_with_tags_by_name (GtkTextBuffer *buffer,
1500 const gchar *first_tag_name,
1506 const gchar *tag_name;
1508 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1509 g_return_if_fail (iter != NULL);
1510 g_return_if_fail (text != NULL);
1511 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
1513 start_offset = gtk_text_iter_get_offset (iter);
1515 gtk_text_buffer_insert (buffer, iter, text, len);
1517 if (first_tag_name == NULL)
1520 gtk_text_buffer_get_iter_at_offset (buffer, &start, start_offset);
1522 va_start (args, first_tag_name);
1523 tag_name = first_tag_name;
1528 tag = gtk_text_tag_table_lookup (buffer->tag_table,
1533 g_warning ("%s: no tag with name '%s'!", G_STRLOC, tag_name);
1537 gtk_text_buffer_apply_tag (buffer, tag, &start, iter);
1539 tag_name = va_arg (args, const gchar*);
1551 gtk_text_buffer_real_delete_range (GtkTextBuffer *buffer,
1555 gboolean has_selection;
1557 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1558 g_return_if_fail (start != NULL);
1559 g_return_if_fail (end != NULL);
1561 _gtk_text_btree_delete (start, end);
1563 /* may have deleted the selection... */
1564 update_selection_clipboards (buffer);
1566 has_selection = gtk_text_buffer_get_selection_bounds (buffer, NULL, NULL);
1567 if (has_selection != buffer->has_selection)
1569 buffer->has_selection = has_selection;
1570 g_object_notify (G_OBJECT (buffer), "has-selection");
1573 g_signal_emit (buffer, signals[CHANGED], 0);
1574 g_object_notify (G_OBJECT (buffer), "cursor-position");
1578 gtk_text_buffer_emit_delete (GtkTextBuffer *buffer,
1582 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1583 g_return_if_fail (start != NULL);
1584 g_return_if_fail (end != NULL);
1586 if (gtk_text_iter_equal (start, end))
1589 gtk_text_iter_order (start, end);
1591 g_signal_emit (buffer,
1592 signals[DELETE_RANGE],
1598 * gtk_text_buffer_delete:
1599 * @buffer: a #GtkTextBuffer
1600 * @start: a position in @buffer
1601 * @end: another position in @buffer
1603 * Deletes text between @start and @end. The order of @start and @end
1604 * is not actually relevant; gtk_text_buffer_delete() will reorder
1605 * them. This function actually emits the "delete_range" signal, and
1606 * the default handler of that signal deletes the text. Because the
1607 * buffer is modified, all outstanding iterators become invalid after
1608 * calling this function; however, the @start and @end will be
1609 * re-initialized to point to the location where text was deleted.
1612 gtk_text_buffer_delete (GtkTextBuffer *buffer,
1616 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1617 g_return_if_fail (start != NULL);
1618 g_return_if_fail (end != NULL);
1619 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
1620 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
1622 gtk_text_buffer_emit_delete (buffer, start, end);
1626 * gtk_text_buffer_delete_interactive:
1627 * @buffer: a #GtkTextBuffer
1628 * @start_iter: start of range to delete
1629 * @end_iter: end of range
1630 * @default_editable: whether the buffer is editable by default
1632 * Deletes all <emphasis>editable</emphasis> text in the given range.
1633 * Calls gtk_text_buffer_delete() for each editable sub-range of
1634 * [@start,@end). @start and @end are revalidated to point to
1635 * the location of the last deleted range, or left untouched if
1636 * no text was deleted.
1638 * Return value: whether some text was actually deleted
1641 gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
1642 GtkTextIter *start_iter,
1643 GtkTextIter *end_iter,
1644 gboolean default_editable)
1646 GtkTextMark *end_mark;
1647 GtkTextMark *start_mark;
1649 gboolean current_state;
1650 gboolean deleted_stuff = FALSE;
1652 /* Delete all editable text in the range start_iter, end_iter */
1654 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
1655 g_return_val_if_fail (start_iter != NULL, FALSE);
1656 g_return_val_if_fail (end_iter != NULL, FALSE);
1657 g_return_val_if_fail (gtk_text_iter_get_buffer (start_iter) == buffer, FALSE);
1658 g_return_val_if_fail (gtk_text_iter_get_buffer (end_iter) == buffer, FALSE);
1661 gtk_text_buffer_begin_user_action (buffer);
1663 gtk_text_iter_order (start_iter, end_iter);
1665 start_mark = gtk_text_buffer_create_mark (buffer, NULL,
1667 end_mark = gtk_text_buffer_create_mark (buffer, NULL,
1670 gtk_text_buffer_get_iter_at_mark (buffer, &iter, start_mark);
1672 current_state = gtk_text_iter_editable (&iter, default_editable);
1677 gboolean done = FALSE;
1680 gtk_text_iter_forward_to_tag_toggle (&iter, NULL);
1682 gtk_text_buffer_get_iter_at_mark (buffer, &end, end_mark);
1684 if (gtk_text_iter_compare (&iter, &end) >= 0)
1687 iter = end; /* clamp to the last boundary */
1690 new_state = gtk_text_iter_editable (&iter, default_editable);
1692 if (current_state == new_state)
1698 /* We're ending an editable region. Delete said region. */
1701 gtk_text_buffer_get_iter_at_mark (buffer, &start, start_mark);
1703 gtk_text_buffer_emit_delete (buffer, &start, &iter);
1705 deleted_stuff = TRUE;
1707 /* revalidate user's iterators. */
1708 *start_iter = start;
1718 if (current_state && !new_state)
1720 /* End of an editable region. Delete it. */
1723 gtk_text_buffer_get_iter_at_mark (buffer, &start, start_mark);
1725 gtk_text_buffer_emit_delete (buffer, &start, &iter);
1727 current_state = FALSE;
1728 deleted_stuff = TRUE;
1730 /* revalidate user's iterators. */
1731 *start_iter = start;
1736 /* We are at the start of an editable region. We won't be deleting
1737 * the previous region. Move start mark to start of this region.
1740 g_assert (!current_state && new_state);
1742 gtk_text_buffer_move_mark (buffer, start_mark,
1746 current_state = TRUE;
1754 gtk_text_buffer_delete_mark (buffer, start_mark);
1755 gtk_text_buffer_delete_mark (buffer, end_mark);
1757 gtk_text_buffer_end_user_action (buffer);
1759 return deleted_stuff;
1763 * Extracting textual buffer contents
1767 * gtk_text_buffer_get_text:
1768 * @buffer: a #GtkTextBuffer
1769 * @start: start of a range
1770 * @end: end of a range
1771 * @include_hidden_chars: whether to include invisible text
1773 * Returns the text in the range [@start,@end). Excludes undisplayed
1774 * text (text marked with tags that set the invisibility attribute) if
1775 * @include_hidden_chars is %FALSE. Does not include characters
1776 * representing embedded images, so byte and character indexes into
1777 * the returned string do <emphasis>not</emphasis> correspond to byte
1778 * and character indexes into the buffer. Contrast with
1779 * gtk_text_buffer_get_slice().
1781 * Return value: an allocated UTF-8 string
1784 gtk_text_buffer_get_text (GtkTextBuffer *buffer,
1785 const GtkTextIter *start,
1786 const GtkTextIter *end,
1787 gboolean include_hidden_chars)
1789 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
1790 g_return_val_if_fail (start != NULL, NULL);
1791 g_return_val_if_fail (end != NULL, NULL);
1792 g_return_val_if_fail (gtk_text_iter_get_buffer (start) == buffer, NULL);
1793 g_return_val_if_fail (gtk_text_iter_get_buffer (end) == buffer, NULL);
1795 if (include_hidden_chars)
1796 return gtk_text_iter_get_text (start, end);
1798 return gtk_text_iter_get_visible_text (start, end);
1802 * gtk_text_buffer_get_slice:
1803 * @buffer: a #GtkTextBuffer
1804 * @start: start of a range
1805 * @end: end of a range
1806 * @include_hidden_chars: whether to include invisible text
1808 * Returns the text in the range [@start,@end). Excludes undisplayed
1809 * text (text marked with tags that set the invisibility attribute) if
1810 * @include_hidden_chars is %FALSE. The returned string includes a
1811 * 0xFFFC character whenever the buffer contains
1812 * embedded images, so byte and character indexes into
1813 * the returned string <emphasis>do</emphasis> correspond to byte
1814 * and character indexes into the buffer. Contrast with
1815 * gtk_text_buffer_get_text(). Note that 0xFFFC can occur in normal
1816 * text as well, so it is not a reliable indicator that a pixbuf or
1817 * widget is in the buffer.
1819 * Return value: an allocated UTF-8 string
1822 gtk_text_buffer_get_slice (GtkTextBuffer *buffer,
1823 const GtkTextIter *start,
1824 const GtkTextIter *end,
1825 gboolean include_hidden_chars)
1827 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
1828 g_return_val_if_fail (start != NULL, NULL);
1829 g_return_val_if_fail (end != NULL, NULL);
1830 g_return_val_if_fail (gtk_text_iter_get_buffer (start) == buffer, NULL);
1831 g_return_val_if_fail (gtk_text_iter_get_buffer (end) == buffer, NULL);
1833 if (include_hidden_chars)
1834 return gtk_text_iter_get_slice (start, end);
1836 return gtk_text_iter_get_visible_slice (start, end);
1844 gtk_text_buffer_real_insert_pixbuf (GtkTextBuffer *buffer,
1848 _gtk_text_btree_insert_pixbuf (iter, pixbuf);
1850 g_signal_emit (buffer, signals[CHANGED], 0);
1854 * gtk_text_buffer_insert_pixbuf:
1855 * @buffer: a #GtkTextBuffer
1856 * @iter: location to insert the pixbuf
1857 * @pixbuf: a #GdkPixbuf
1859 * Inserts an image into the text buffer at @iter. The image will be
1860 * counted as one character in character counts, and when obtaining
1861 * the buffer contents as a string, will be represented by the Unicode
1862 * "object replacement character" 0xFFFC. Note that the "slice"
1863 * variants for obtaining portions of the buffer as a string include
1864 * this character for pixbufs, but the "text" variants do
1865 * not. e.g. see gtk_text_buffer_get_slice() and
1866 * gtk_text_buffer_get_text().
1869 gtk_text_buffer_insert_pixbuf (GtkTextBuffer *buffer,
1873 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1874 g_return_if_fail (iter != NULL);
1875 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
1876 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
1878 g_signal_emit (buffer, signals[INSERT_PIXBUF], 0,
1888 gtk_text_buffer_real_insert_anchor (GtkTextBuffer *buffer,
1890 GtkTextChildAnchor *anchor)
1892 _gtk_text_btree_insert_child_anchor (iter, anchor);
1894 g_signal_emit (buffer, signals[CHANGED], 0);
1898 * gtk_text_buffer_insert_child_anchor:
1899 * @buffer: a #GtkTextBuffer
1900 * @iter: location to insert the anchor
1901 * @anchor: a #GtkTextChildAnchor
1903 * Inserts a child widget anchor into the text buffer at @iter. The
1904 * anchor will be counted as one character in character counts, and
1905 * when obtaining the buffer contents as a string, will be represented
1906 * by the Unicode "object replacement character" 0xFFFC. Note that the
1907 * "slice" variants for obtaining portions of the buffer as a string
1908 * include this character for child anchors, but the "text" variants do
1909 * not. E.g. see gtk_text_buffer_get_slice() and
1910 * gtk_text_buffer_get_text(). Consider
1911 * gtk_text_buffer_create_child_anchor() as a more convenient
1912 * alternative to this function. The buffer will add a reference to
1913 * the anchor, so you can unref it after insertion.
1916 gtk_text_buffer_insert_child_anchor (GtkTextBuffer *buffer,
1918 GtkTextChildAnchor *anchor)
1920 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1921 g_return_if_fail (iter != NULL);
1922 g_return_if_fail (GTK_IS_TEXT_CHILD_ANCHOR (anchor));
1923 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
1925 g_signal_emit (buffer, signals[INSERT_CHILD_ANCHOR], 0,
1931 * gtk_text_buffer_create_child_anchor:
1932 * @buffer: a #GtkTextBuffer
1933 * @iter: location in the buffer
1935 * This is a convenience function which simply creates a child anchor
1936 * with gtk_text_child_anchor_new() and inserts it into the buffer
1937 * with gtk_text_buffer_insert_child_anchor(). The new anchor is
1938 * owned by the buffer; no reference count is returned to
1939 * the caller of gtk_text_buffer_create_child_anchor().
1941 * Return value: the created child anchor
1944 gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
1947 GtkTextChildAnchor *anchor;
1949 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
1950 g_return_val_if_fail (iter != NULL, NULL);
1951 g_return_val_if_fail (gtk_text_iter_get_buffer (iter) == buffer, NULL);
1953 anchor = gtk_text_child_anchor_new ();
1955 gtk_text_buffer_insert_child_anchor (buffer, iter, anchor);
1957 g_object_unref (anchor);
1967 gtk_text_buffer_mark_set (GtkTextBuffer *buffer,
1968 const GtkTextIter *location,
1971 /* IMO this should NOT work like insert_text and delete_range,
1972 * where the real action happens in the default handler.
1974 * The reason is that the default handler would be _required_,
1975 * i.e. the whole widget would start breaking and segfaulting if the
1976 * default handler didn't get run. So you can't really override the
1977 * default handler or stop the emission; that is, this signal is
1978 * purely for notification, and not to allow users to modify the
1982 g_object_ref (mark);
1984 g_signal_emit (buffer,
1990 g_object_unref (mark);
1994 * gtk_text_buffer_set_mark:
1995 * @buffer: a #GtkTextBuffer
1996 * @mark_name: name of the mark
1997 * @iter: location for the mark
1998 * @left_gravity: if the mark is created by this function, gravity for
2000 * @should_exist: if %TRUE, warn if the mark does not exist, and return
2003 * Move the mark to the given position, if not @should_exist,
2006 * Return value: mark
2009 gtk_text_buffer_set_mark (GtkTextBuffer *buffer,
2010 GtkTextMark *existing_mark,
2011 const gchar *mark_name,
2012 const GtkTextIter *iter,
2013 gboolean left_gravity,
2014 gboolean should_exist)
2016 GtkTextIter location;
2019 g_return_val_if_fail (gtk_text_iter_get_buffer (iter) == buffer, NULL);
2021 mark = _gtk_text_btree_set_mark (get_btree (buffer),
2028 _gtk_text_btree_get_iter_at_mark (get_btree (buffer),
2032 gtk_text_buffer_mark_set (buffer, &location, mark);
2038 * gtk_text_buffer_create_mark:
2039 * @buffer: a #GtkTextBuffer
2040 * @mark_name: name for mark, or %NULL
2041 * @where: location to place mark
2042 * @left_gravity: whether the mark has left gravity
2044 * Creates a mark at position @where. If @mark_name is %NULL, the mark
2045 * is anonymous; otherwise, the mark can be retrieved by name using
2046 * gtk_text_buffer_get_mark(). If a mark has left gravity, and text is
2047 * inserted at the mark's current location, the mark will be moved to
2048 * the left of the newly-inserted text. If the mark has right gravity
2049 * (@left_gravity = %FALSE), the mark will end up on the right of
2050 * newly-inserted text. The standard left-to-right cursor is a mark
2051 * with right gravity (when you type, the cursor stays on the right
2052 * side of the text you're typing).
2054 * The caller of this function does <emphasis>not</emphasis> own a
2055 * reference to the returned #GtkTextMark, so you can ignore the
2056 * return value if you like. Marks are owned by the buffer and go
2057 * away when the buffer does.
2059 * Emits the "mark_set" signal as notification of the mark's initial
2062 * Return value: the new #GtkTextMark object
2065 gtk_text_buffer_create_mark (GtkTextBuffer *buffer,
2066 const gchar *mark_name,
2067 const GtkTextIter *where,
2068 gboolean left_gravity)
2070 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2072 return gtk_text_buffer_set_mark (buffer, NULL, mark_name, where,
2073 left_gravity, FALSE);
2077 * gtk_text_buffer_add_mark:
2078 * @buffer: a #GtkTextBuffer
2079 * @mark: the mark to add
2080 * @where: location to place mark
2082 * Adds the mark at position @where. The mark must not be added to
2083 * another buffer, and if its name is not %NULL then there must not
2084 * be another mark in the buffer with the same name.
2086 * Emits the "mark_set" signal as notification of the mark's initial
2092 gtk_text_buffer_add_mark (GtkTextBuffer *buffer,
2094 const GtkTextIter *where)
2098 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2099 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2100 g_return_if_fail (where != NULL);
2101 g_return_if_fail (gtk_text_mark_get_buffer (mark) == NULL);
2103 name = gtk_text_mark_get_name (mark);
2105 if (name != NULL && gtk_text_buffer_get_mark (buffer, name) != NULL)
2107 g_critical ("Mark %s already exists in the buffer", name);
2111 gtk_text_buffer_set_mark (buffer, mark, NULL, where, FALSE, FALSE);
2115 * gtk_text_buffer_move_mark:
2116 * @buffer: a #GtkTextBuffer
2117 * @mark: a #GtkTextMark
2118 * @where: new location for @mark in @buffer
2120 * Moves @mark to the new location @where. Emits the "mark_set" signal
2121 * as notification of the move.
2124 gtk_text_buffer_move_mark (GtkTextBuffer *buffer,
2126 const GtkTextIter *where)
2128 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2129 g_return_if_fail (!gtk_text_mark_get_deleted (mark));
2130 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2132 gtk_text_buffer_set_mark (buffer, mark, NULL, where, FALSE, TRUE);
2136 * gtk_text_buffer_get_iter_at_mark:
2137 * @buffer: a #GtkTextBuffer
2138 * @iter: iterator to initialize
2139 * @mark: a #GtkTextMark in @buffer
2141 * Initializes @iter with the current position of @mark.
2144 gtk_text_buffer_get_iter_at_mark (GtkTextBuffer *buffer,
2148 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2149 g_return_if_fail (!gtk_text_mark_get_deleted (mark));
2150 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2152 _gtk_text_btree_get_iter_at_mark (get_btree (buffer),
2158 * gtk_text_buffer_delete_mark:
2159 * @buffer: a #GtkTextBuffer
2160 * @mark: a #GtkTextMark in @buffer
2162 * Deletes @mark, so that it's no longer located anywhere in the
2163 * buffer. Removes the reference the buffer holds to the mark, so if
2164 * you haven't called g_object_ref() on the mark, it will be freed. Even
2165 * if the mark isn't freed, most operations on @mark become
2166 * invalid, until it gets added to a buffer again with
2167 * gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to
2168 * find out if a mark has been removed from its buffer.
2169 * The "mark_deleted" signal will be emitted as notification after
2170 * the mark is deleted.
2173 gtk_text_buffer_delete_mark (GtkTextBuffer *buffer,
2176 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2177 g_return_if_fail (!gtk_text_mark_get_deleted (mark));
2178 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2180 g_object_ref (mark);
2182 _gtk_text_btree_remove_mark (get_btree (buffer), mark);
2184 /* See rationale above for MARK_SET on why we emit this after
2185 * removing the mark, rather than removing the mark in a default
2188 g_signal_emit (buffer, signals[MARK_DELETED],
2192 g_object_unref (mark);
2196 * gtk_text_buffer_get_mark:
2197 * @buffer: a #GtkTextBuffer
2198 * @name: a mark name
2200 * Returns the mark named @name in buffer @buffer, or %NULL if no such
2201 * mark exists in the buffer.
2203 * Return value: a #GtkTextMark, or %NULL
2206 gtk_text_buffer_get_mark (GtkTextBuffer *buffer,
2211 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2212 g_return_val_if_fail (name != NULL, NULL);
2214 mark = _gtk_text_btree_get_mark_by_name (get_btree (buffer), name);
2221 * gtk_text_buffer_move_mark_by_name:
2222 * @buffer: a #GtkTextBuffer
2223 * @name: name of a mark
2224 * @where: new location for mark
2226 * Moves the mark named @name (which must exist) to location @where.
2227 * See gtk_text_buffer_move_mark() for details.
2230 gtk_text_buffer_move_mark_by_name (GtkTextBuffer *buffer,
2232 const GtkTextIter *where)
2236 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2237 g_return_if_fail (name != NULL);
2239 mark = _gtk_text_btree_get_mark_by_name (get_btree (buffer), name);
2243 g_warning ("%s: no mark named '%s'", G_STRLOC, name);
2247 gtk_text_buffer_move_mark (buffer, mark, where);
2251 * gtk_text_buffer_delete_mark_by_name:
2252 * @buffer: a #GtkTextBuffer
2253 * @name: name of a mark in @buffer
2255 * Deletes the mark named @name; the mark must exist. See
2256 * gtk_text_buffer_delete_mark() for details.
2259 gtk_text_buffer_delete_mark_by_name (GtkTextBuffer *buffer,
2264 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2265 g_return_if_fail (name != NULL);
2267 mark = _gtk_text_btree_get_mark_by_name (get_btree (buffer), name);
2271 g_warning ("%s: no mark named '%s'", G_STRLOC, name);
2275 gtk_text_buffer_delete_mark (buffer, mark);
2279 * gtk_text_buffer_get_insert:
2280 * @buffer: a #GtkTextBuffer
2282 * Returns the mark that represents the cursor (insertion point).
2283 * Equivalent to calling gtk_text_buffer_get_mark() to get the mark
2284 * named "insert", but very slightly more efficient, and involves less
2287 * Return value: insertion point mark
2290 gtk_text_buffer_get_insert (GtkTextBuffer *buffer)
2292 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2294 /* FIXME use struct member in btree */
2295 return gtk_text_buffer_get_mark (buffer, "insert");
2299 * gtk_text_buffer_get_selection_bound:
2300 * @buffer: a #GtkTextBuffer
2302 * Returns the mark that represents the selection bound. Equivalent
2303 * to calling gtk_text_buffer_get_mark() to get the mark named
2304 * "selection_bound", but very slightly more efficient, and involves
2307 * The currently-selected text in @buffer is the region between the
2308 * "selection_bound" and "insert" marks. If "selection_bound" and
2309 * "insert" are in the same place, then there is no current selection.
2310 * gtk_text_buffer_get_selection_bounds() is another convenient function
2311 * for handling the selection, if you just want to know whether there's a
2312 * selection and what its bounds are.
2314 * Return value: selection bound mark
2317 gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer)
2319 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2321 /* FIXME use struct member in btree */
2322 return gtk_text_buffer_get_mark (buffer, "selection_bound");
2326 * gtk_text_buffer_get_iter_at_child_anchor:
2327 * @buffer: a #GtkTextBuffer
2328 * @iter: an iterator to be initialized
2329 * @anchor: a child anchor that appears in @buffer
2331 * Obtains the location of @anchor within @buffer.
2334 gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer *buffer,
2336 GtkTextChildAnchor *anchor)
2338 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2339 g_return_if_fail (iter != NULL);
2340 g_return_if_fail (GTK_IS_TEXT_CHILD_ANCHOR (anchor));
2341 g_return_if_fail (!gtk_text_child_anchor_get_deleted (anchor));
2343 _gtk_text_btree_get_iter_at_child_anchor (get_btree (buffer),
2349 * gtk_text_buffer_place_cursor:
2350 * @buffer: a #GtkTextBuffer
2351 * @where: where to put the cursor
2353 * This function moves the "insert" and "selection_bound" marks
2354 * simultaneously. If you move them to the same place in two steps
2355 * with gtk_text_buffer_move_mark(), you will temporarily select a
2356 * region in between their old and new locations, which can be pretty
2357 * inefficient since the temporarily-selected region will force stuff
2358 * to be recalculated. This function moves them as a unit, which can
2362 gtk_text_buffer_place_cursor (GtkTextBuffer *buffer,
2363 const GtkTextIter *where)
2365 gtk_text_buffer_select_range (buffer, where, where);
2370 * gtk_text_buffer_select_range:
2371 * @buffer: a #GtkTextBuffer
2372 * @ins: where to put the "insert" mark
2373 * @bound: where to put the "selection_bound" mark
2375 * This function moves the "insert" and "selection_bound" marks
2376 * simultaneously. If you move them in two steps
2377 * with gtk_text_buffer_move_mark(), you will temporarily select a
2378 * region in between their old and new locations, which can be pretty
2379 * inefficient since the temporarily-selected region will force stuff
2380 * to be recalculated. This function moves them as a unit, which can
2386 gtk_text_buffer_select_range (GtkTextBuffer *buffer,
2387 const GtkTextIter *ins,
2388 const GtkTextIter *bound)
2390 GtkTextIter real_ins;
2391 GtkTextIter real_bound;
2393 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2396 real_bound = *bound;
2398 _gtk_text_btree_select_range (get_btree (buffer), &real_ins, &real_bound);
2399 gtk_text_buffer_mark_set (buffer, &real_ins,
2400 gtk_text_buffer_get_mark (buffer,
2402 gtk_text_buffer_mark_set (buffer, &real_bound,
2403 gtk_text_buffer_get_mark (buffer,
2404 "selection_bound"));
2412 * gtk_text_buffer_create_tag:
2413 * @buffer: a #GtkTextBuffer
2414 * @tag_name: name of the new tag, or %NULL
2415 * @first_property_name: name of first property to set, or %NULL
2416 * @Varargs: %NULL-terminated list of property names and values
2419 * Creates a tag and adds it to the tag table for @buffer.
2420 * Equivalent to calling gtk_text_tag_new() and then adding the
2421 * tag to the buffer's tag table. The returned tag is owned by
2422 * the buffer's tag table, so the ref count will be equal to one.
2424 * If @tag_name is %NULL, the tag is anonymous.
2426 * If @tag_name is non-%NULL, a tag called @tag_name must not already
2427 * exist in the tag table for this buffer.
2429 * The @first_property_name argument and subsequent arguments are a list
2430 * of properties to set on the tag, as with g_object_set().
2432 * Return value: a new tag
2435 gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
2436 const gchar *tag_name,
2437 const gchar *first_property_name,
2443 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2445 tag = gtk_text_tag_new (tag_name);
2447 gtk_text_tag_table_add (get_table (buffer), tag);
2449 if (first_property_name)
2451 va_start (list, first_property_name);
2452 g_object_set_valist (G_OBJECT (tag), first_property_name, list);
2456 g_object_unref (tag);
2462 gtk_text_buffer_real_apply_tag (GtkTextBuffer *buffer,
2464 const GtkTextIter *start,
2465 const GtkTextIter *end)
2467 if (tag->table != buffer->tag_table)
2469 g_warning ("Can only apply tags that are in the tag table for the buffer");
2473 _gtk_text_btree_tag (start, end, tag, TRUE);
2477 gtk_text_buffer_real_remove_tag (GtkTextBuffer *buffer,
2479 const GtkTextIter *start,
2480 const GtkTextIter *end)
2482 if (tag->table != buffer->tag_table)
2484 g_warning ("Can only remove tags that are in the tag table for the buffer");
2488 _gtk_text_btree_tag (start, end, tag, FALSE);
2492 gtk_text_buffer_real_changed (GtkTextBuffer *buffer)
2494 gtk_text_buffer_set_modified (buffer, TRUE);
2498 gtk_text_buffer_real_mark_set (GtkTextBuffer *buffer,
2499 const GtkTextIter *iter,
2502 GtkTextMark *insert;
2504 insert = gtk_text_buffer_get_insert (buffer);
2506 if (mark == insert || mark == gtk_text_buffer_get_selection_bound (buffer))
2508 gboolean has_selection;
2510 update_selection_clipboards (buffer);
2512 has_selection = gtk_text_buffer_get_selection_bounds (buffer,
2516 if (has_selection != buffer->has_selection)
2518 buffer->has_selection = has_selection;
2519 g_object_notify (G_OBJECT (buffer), "has-selection");
2524 g_object_notify (G_OBJECT (buffer), "cursor-position");
2528 gtk_text_buffer_emit_tag (GtkTextBuffer *buffer,
2531 const GtkTextIter *start,
2532 const GtkTextIter *end)
2534 GtkTextIter start_tmp = *start;
2535 GtkTextIter end_tmp = *end;
2537 g_return_if_fail (tag != NULL);
2539 gtk_text_iter_order (&start_tmp, &end_tmp);
2542 g_signal_emit (buffer, signals[APPLY_TAG],
2544 tag, &start_tmp, &end_tmp);
2546 g_signal_emit (buffer, signals[REMOVE_TAG],
2548 tag, &start_tmp, &end_tmp);
2553 * gtk_text_buffer_apply_tag:
2554 * @buffer: a #GtkTextBuffer
2555 * @tag: a #GtkTextTag
2556 * @start: one bound of range to be tagged
2557 * @end: other bound of range to be tagged
2559 * Emits the "apply_tag" signal on @buffer. The default
2560 * handler for the signal applies @tag to the given range.
2561 * @start and @end do not have to be in order.
2564 gtk_text_buffer_apply_tag (GtkTextBuffer *buffer,
2566 const GtkTextIter *start,
2567 const GtkTextIter *end)
2569 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2570 g_return_if_fail (GTK_IS_TEXT_TAG (tag));
2571 g_return_if_fail (start != NULL);
2572 g_return_if_fail (end != NULL);
2573 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2574 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2575 g_return_if_fail (tag->table == buffer->tag_table);
2577 gtk_text_buffer_emit_tag (buffer, tag, TRUE, start, end);
2581 * gtk_text_buffer_remove_tag:
2582 * @buffer: a #GtkTextBuffer
2583 * @tag: a #GtkTextTag
2584 * @start: one bound of range to be untagged
2585 * @end: other bound of range to be untagged
2587 * Emits the "remove_tag" signal. The default handler for the signal
2588 * removes all occurrences of @tag from the given range. @start and
2589 * @end don't have to be in order.
2592 gtk_text_buffer_remove_tag (GtkTextBuffer *buffer,
2594 const GtkTextIter *start,
2595 const GtkTextIter *end)
2598 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2599 g_return_if_fail (GTK_IS_TEXT_TAG (tag));
2600 g_return_if_fail (start != NULL);
2601 g_return_if_fail (end != NULL);
2602 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2603 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2604 g_return_if_fail (tag->table == buffer->tag_table);
2606 gtk_text_buffer_emit_tag (buffer, tag, FALSE, start, end);
2611 * gtk_text_buffer_apply_tag_by_name:
2612 * @buffer: a #GtkTextBuffer
2613 * @name: name of a named #GtkTextTag
2614 * @start: one bound of range to be tagged
2615 * @end: other bound of range to be tagged
2617 * Calls gtk_text_tag_table_lookup() on the buffer's tag table to
2618 * get a #GtkTextTag, then calls gtk_text_buffer_apply_tag().
2621 gtk_text_buffer_apply_tag_by_name (GtkTextBuffer *buffer,
2623 const GtkTextIter *start,
2624 const GtkTextIter *end)
2628 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2629 g_return_if_fail (name != NULL);
2630 g_return_if_fail (start != NULL);
2631 g_return_if_fail (end != NULL);
2632 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2633 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2635 tag = gtk_text_tag_table_lookup (get_table (buffer),
2640 g_warning ("Unknown tag `%s'", name);
2644 gtk_text_buffer_emit_tag (buffer, tag, TRUE, start, end);
2648 * gtk_text_buffer_remove_tag_by_name:
2649 * @buffer: a #GtkTextBuffer
2650 * @name: name of a #GtkTextTag
2651 * @start: one bound of range to be untagged
2652 * @end: other bound of range to be untagged
2654 * Calls gtk_text_tag_table_lookup() on the buffer's tag table to
2655 * get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
2658 gtk_text_buffer_remove_tag_by_name (GtkTextBuffer *buffer,
2660 const GtkTextIter *start,
2661 const GtkTextIter *end)
2665 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2666 g_return_if_fail (name != NULL);
2667 g_return_if_fail (start != NULL);
2668 g_return_if_fail (end != NULL);
2669 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2670 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2672 tag = gtk_text_tag_table_lookup (get_table (buffer),
2677 g_warning ("Unknown tag `%s'", name);
2681 gtk_text_buffer_emit_tag (buffer, tag, FALSE, start, end);
2685 pointer_cmp (gconstpointer a,
2697 * gtk_text_buffer_remove_all_tags:
2698 * @buffer: a #GtkTextBuffer
2699 * @start: one bound of range to be untagged
2700 * @end: other bound of range to be untagged
2702 * Removes all tags in the range between @start and @end. Be careful
2703 * with this function; it could remove tags added in code unrelated to
2704 * the code you're currently writing. That is, using this function is
2705 * probably a bad idea if you have two or more unrelated code sections
2709 gtk_text_buffer_remove_all_tags (GtkTextBuffer *buffer,
2710 const GtkTextIter *start,
2711 const GtkTextIter *end)
2713 GtkTextIter first, second, tmp;
2716 GSList *prev, *next;
2719 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2720 g_return_if_fail (start != NULL);
2721 g_return_if_fail (end != NULL);
2722 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2723 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2728 gtk_text_iter_order (&first, &second);
2730 /* Get all tags turned on at the start */
2731 tags = gtk_text_iter_get_tags (&first);
2733 /* Find any that are toggled on within the range */
2735 while (gtk_text_iter_forward_to_tag_toggle (&tmp, NULL))
2740 if (gtk_text_iter_compare (&tmp, &second) >= 0)
2741 break; /* past the end of the range */
2743 toggled = gtk_text_iter_get_toggled_tags (&tmp, TRUE);
2745 /* We could end up with a really big-ass list here.
2748 tmp_list2 = toggled;
2749 while (tmp_list2 != NULL)
2751 tags = g_slist_prepend (tags, tmp_list2->data);
2753 tmp_list2 = g_slist_next (tmp_list2);
2756 g_slist_free (toggled);
2760 tags = g_slist_sort (tags, pointer_cmp);
2762 /* Strip duplicates */
2766 while (tmp_list != NULL)
2768 if (tag == tmp_list->data)
2771 next = tmp_list->next;
2775 tmp_list->next = NULL;
2777 g_slist_free (tmp_list);
2780 /* prev is unchanged */
2784 /* not a duplicate */
2785 tag = GTK_TEXT_TAG (tmp_list->data);
2787 tmp_list = tmp_list->next;
2791 g_slist_foreach (tags, (GFunc) g_object_ref, NULL);
2794 while (tmp_list != NULL)
2796 tag = GTK_TEXT_TAG (tmp_list->data);
2798 gtk_text_buffer_remove_tag (buffer, tag, &first, &second);
2800 tmp_list = tmp_list->next;
2803 g_slist_foreach (tags, (GFunc) g_object_unref, NULL);
2805 g_slist_free (tags);
2810 * Obtain various iterators
2814 * gtk_text_buffer_get_iter_at_line_offset:
2815 * @buffer: a #GtkTextBuffer
2816 * @iter: iterator to initialize
2817 * @line_number: line number counting from 0
2818 * @char_offset: char offset from start of line
2820 * Obtains an iterator pointing to @char_offset within the given
2821 * line. The @char_offset must exist, offsets off the end of the line
2822 * are not allowed. Note <emphasis>characters</emphasis>, not bytes;
2823 * UTF-8 may encode one character as multiple bytes.
2826 gtk_text_buffer_get_iter_at_line_offset (GtkTextBuffer *buffer,
2831 g_return_if_fail (iter != NULL);
2832 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2834 _gtk_text_btree_get_iter_at_line_char (get_btree (buffer),
2835 iter, line_number, char_offset);
2839 * gtk_text_buffer_get_iter_at_line_index:
2840 * @buffer: a #GtkTextBuffer
2841 * @iter: iterator to initialize
2842 * @line_number: line number counting from 0
2843 * @byte_index: byte index from start of line
2845 * Obtains an iterator pointing to @byte_index within the given line.
2846 * @byte_index must be the start of a UTF-8 character, and must not be
2847 * beyond the end of the line. Note <emphasis>bytes</emphasis>, not
2848 * characters; UTF-8 may encode one character as multiple bytes.
2851 gtk_text_buffer_get_iter_at_line_index (GtkTextBuffer *buffer,
2856 g_return_if_fail (iter != NULL);
2857 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2859 _gtk_text_btree_get_iter_at_line_byte (get_btree (buffer),
2860 iter, line_number, byte_index);
2864 * gtk_text_buffer_get_iter_at_line:
2865 * @buffer: a #GtkTextBuffer
2866 * @iter: iterator to initialize
2867 * @line_number: line number counting from 0
2869 * Initializes @iter to the start of the given line.
2872 gtk_text_buffer_get_iter_at_line (GtkTextBuffer *buffer,
2876 g_return_if_fail (iter != NULL);
2877 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2879 gtk_text_buffer_get_iter_at_line_offset (buffer, iter, line_number, 0);
2883 * gtk_text_buffer_get_iter_at_offset:
2884 * @buffer: a #GtkTextBuffer
2885 * @iter: iterator to initialize
2886 * @char_offset: char offset from start of buffer, counting from 0, or -1
2888 * Initializes @iter to a position @char_offset chars from the start
2889 * of the entire buffer. If @char_offset is -1 or greater than the number
2890 * of characters in the buffer, @iter is initialized to the end iterator,
2891 * the iterator one past the last valid character in the buffer.
2894 gtk_text_buffer_get_iter_at_offset (GtkTextBuffer *buffer,
2898 g_return_if_fail (iter != NULL);
2899 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2901 _gtk_text_btree_get_iter_at_char (get_btree (buffer), iter, char_offset);
2905 * gtk_text_buffer_get_start_iter:
2906 * @buffer: a #GtkTextBuffer
2907 * @iter: iterator to initialize
2909 * Initialized @iter with the first position in the text buffer. This
2910 * is the same as using gtk_text_buffer_get_iter_at_offset() to get
2911 * the iter at character offset 0.
2914 gtk_text_buffer_get_start_iter (GtkTextBuffer *buffer,
2917 g_return_if_fail (iter != NULL);
2918 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2920 _gtk_text_btree_get_iter_at_char (get_btree (buffer), iter, 0);
2924 * gtk_text_buffer_get_end_iter:
2925 * @buffer: a #GtkTextBuffer
2926 * @iter: iterator to initialize
2928 * Initializes @iter with the "end iterator," one past the last valid
2929 * character in the text buffer. If dereferenced with
2930 * gtk_text_iter_get_char(), the end iterator has a character value of
2931 * 0. The entire buffer lies in the range from the first position in
2932 * the buffer (call gtk_text_buffer_get_start_iter() to get
2933 * character position 0) to the end iterator.
2936 gtk_text_buffer_get_end_iter (GtkTextBuffer *buffer,
2939 g_return_if_fail (iter != NULL);
2940 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2942 _gtk_text_btree_get_end_iter (get_btree (buffer), iter);
2946 * gtk_text_buffer_get_bounds:
2947 * @buffer: a #GtkTextBuffer
2948 * @start: iterator to initialize with first position in the buffer
2949 * @end: iterator to initialize with the end iterator
2951 * Retrieves the first and last iterators in the buffer, i.e. the
2952 * entire buffer lies within the range [@start,@end).
2955 gtk_text_buffer_get_bounds (GtkTextBuffer *buffer,
2959 g_return_if_fail (start != NULL);
2960 g_return_if_fail (end != NULL);
2961 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2963 _gtk_text_btree_get_iter_at_char (get_btree (buffer), start, 0);
2964 _gtk_text_btree_get_end_iter (get_btree (buffer), end);
2972 * gtk_text_buffer_get_modified:
2973 * @buffer: a #GtkTextBuffer
2975 * Indicates whether the buffer has been modified since the last call
2976 * to gtk_text_buffer_set_modified() set the modification flag to
2977 * %FALSE. Used for example to enable a "save" function in a text
2980 * Return value: %TRUE if the buffer has been modified
2983 gtk_text_buffer_get_modified (GtkTextBuffer *buffer)
2985 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
2987 return buffer->modified;
2991 * gtk_text_buffer_set_modified:
2992 * @buffer: a #GtkTextBuffer
2993 * @setting: modification flag setting
2995 * Used to keep track of whether the buffer has been modified since the
2996 * last time it was saved. Whenever the buffer is saved to disk, call
2997 * gtk_text_buffer_set_modified (@buffer, FALSE). When the buffer is modified,
2998 * it will automatically toggled on the modified bit again. When the modified
2999 * bit flips, the buffer emits a "modified_changed" signal.
3002 gtk_text_buffer_set_modified (GtkTextBuffer *buffer,
3005 gboolean fixed_setting;
3007 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
3009 fixed_setting = setting != FALSE;
3011 if (buffer->modified == fixed_setting)
3015 buffer->modified = fixed_setting;
3016 g_signal_emit (buffer, signals[MODIFIED_CHANGED], 0);
3021 * gtk_text_buffer_get_has_selection:
3022 * @buffer: a #GtkTextBuffer
3024 * Indicates whether the buffer has some text currently selected.
3026 * Return value: %TRUE if the there is text selected
3031 gtk_text_buffer_get_has_selection (GtkTextBuffer *buffer)
3033 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
3035 return buffer->has_selection;
3040 * Assorted other stuff
3044 * gtk_text_buffer_get_line_count:
3045 * @buffer: a #GtkTextBuffer
3047 * Obtains the number of lines in the buffer. This value is cached, so
3048 * the function is very fast.
3050 * Return value: number of lines in the buffer
3053 gtk_text_buffer_get_line_count (GtkTextBuffer *buffer)
3055 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), 0);
3057 return _gtk_text_btree_line_count (get_btree (buffer));
3061 * gtk_text_buffer_get_char_count:
3062 * @buffer: a #GtkTextBuffer
3064 * Gets the number of characters in the buffer; note that characters
3065 * and bytes are not the same, you can't e.g. expect the contents of
3066 * the buffer in string form to be this many bytes long. The character
3067 * count is cached, so this function is very fast.
3069 * Return value: number of characters in the buffer
3072 gtk_text_buffer_get_char_count (GtkTextBuffer *buffer)
3074 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), 0);
3076 return _gtk_text_btree_char_count (get_btree (buffer));
3079 /* Called when we lose the primary selection.
3082 clipboard_clear_selection_cb (GtkClipboard *clipboard,
3085 /* Move selection_bound to the insertion point */
3087 GtkTextIter selection_bound;
3088 GtkTextBuffer *buffer = GTK_TEXT_BUFFER (data);
3090 gtk_text_buffer_get_iter_at_mark (buffer, &insert,
3091 gtk_text_buffer_get_mark (buffer, "insert"));
3092 gtk_text_buffer_get_iter_at_mark (buffer, &selection_bound,
3093 gtk_text_buffer_get_mark (buffer, "selection_bound"));
3095 if (!gtk_text_iter_equal (&insert, &selection_bound))
3096 gtk_text_buffer_move_mark (buffer,
3097 gtk_text_buffer_get_mark (buffer, "selection_bound"),
3101 /* Called when we have the primary selection and someone else wants our
3102 * data in order to paste it.
3105 clipboard_get_selection_cb (GtkClipboard *clipboard,
3106 GtkSelectionData *selection_data,
3110 GtkTextBuffer *buffer = GTK_TEXT_BUFFER (data);
3111 GtkTextIter start, end;
3113 if (gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3115 if (info == GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS)
3117 /* Provide the address of the buffer; this will only be
3118 * used within-process
3120 gtk_selection_data_set (selection_data,
3121 selection_data->target,
3126 else if (info == GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT)
3131 str = gtk_text_buffer_serialize (buffer, buffer,
3132 selection_data->target,
3133 &start, &end, &len);
3135 gtk_selection_data_set (selection_data,
3136 selection_data->target,
3145 str = gtk_text_iter_get_visible_text (&start, &end);
3146 gtk_selection_data_set_text (selection_data, str, -1);
3152 static GtkTextBuffer *
3153 create_clipboard_contents_buffer (GtkTextBuffer *buffer)
3155 GtkTextBuffer *contents;
3157 contents = gtk_text_buffer_new (gtk_text_buffer_get_tag_table (buffer));
3159 g_object_set_data (G_OBJECT (contents), I_("gtk-text-buffer-clipboard-source"),
3161 g_object_set_data (G_OBJECT (contents), I_("gtk-text-buffer-clipboard"),
3162 GINT_TO_POINTER (1));
3164 /* Ref the source buffer as long as the clipboard contents buffer
3165 * exists, because it's needed for serializing the contents buffer.
3166 * See http://bugzilla.gnome.org/show_bug.cgi?id=339195
3168 g_object_ref (buffer);
3169 g_object_weak_ref (G_OBJECT (contents), (GWeakNotify) g_object_unref, buffer);
3174 /* Provide cut/copied data */
3176 clipboard_get_contents_cb (GtkClipboard *clipboard,
3177 GtkSelectionData *selection_data,
3181 GtkTextBuffer *contents = GTK_TEXT_BUFFER (data);
3183 g_assert (contents); /* This should never be called unless we own the clipboard */
3185 if (info == GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS)
3187 /* Provide the address of the clipboard buffer; this will only
3188 * be used within-process. OK to supply a NULL value for contents.
3190 gtk_selection_data_set (selection_data,
3191 selection_data->target,
3196 else if (info == GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT)
3198 GtkTextBuffer *clipboard_source_buffer;
3199 GtkTextIter start, end;
3203 clipboard_source_buffer = g_object_get_data (G_OBJECT (contents),
3204 "gtk-text-buffer-clipboard-source");
3206 gtk_text_buffer_get_bounds (contents, &start, &end);
3208 str = gtk_text_buffer_serialize (clipboard_source_buffer, contents,
3209 selection_data->target,
3210 &start, &end, &len);
3212 gtk_selection_data_set (selection_data,
3213 selection_data->target,
3221 GtkTextIter start, end;
3223 gtk_text_buffer_get_bounds (contents, &start, &end);
3225 str = gtk_text_iter_get_visible_text (&start, &end);
3226 gtk_selection_data_set_text (selection_data, str, -1);
3232 clipboard_clear_contents_cb (GtkClipboard *clipboard,
3235 GtkTextBuffer *contents = GTK_TEXT_BUFFER (data);
3237 g_object_unref (contents);
3241 get_paste_point (GtkTextBuffer *buffer,
3243 gboolean clear_afterward)
3245 GtkTextIter insert_point;
3246 GtkTextMark *paste_point_override;
3248 paste_point_override = gtk_text_buffer_get_mark (buffer,
3249 "gtk_paste_point_override");
3251 if (paste_point_override != NULL)
3253 gtk_text_buffer_get_iter_at_mark (buffer, &insert_point,
3254 paste_point_override);
3255 if (clear_afterward)
3256 gtk_text_buffer_delete_mark (buffer,
3257 gtk_text_buffer_get_mark (buffer,
3258 "gtk_paste_point_override"));
3262 gtk_text_buffer_get_iter_at_mark (buffer, &insert_point,
3263 gtk_text_buffer_get_mark (buffer,
3267 *iter = insert_point;
3271 pre_paste_prep (ClipboardRequest *request_data,
3272 GtkTextIter *insert_point)
3274 GtkTextBuffer *buffer = request_data->buffer;
3276 get_paste_point (buffer, insert_point, TRUE);
3278 /* If we're going to replace the selection, we insert before it to
3279 * avoid messing it up, then we delete the selection after inserting.
3281 if (request_data->replace_selection)
3283 GtkTextIter start, end;
3285 if (gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3286 *insert_point = start;
3291 post_paste_cleanup (ClipboardRequest *request_data)
3293 if (request_data->replace_selection)
3295 GtkTextIter start, end;
3297 if (gtk_text_buffer_get_selection_bounds (request_data->buffer,
3300 if (request_data->interactive)
3301 gtk_text_buffer_delete_interactive (request_data->buffer,
3304 request_data->default_editable);
3306 gtk_text_buffer_delete (request_data->buffer, &start, &end);
3312 free_clipboard_request (ClipboardRequest *request_data)
3314 g_object_unref (request_data->buffer);
3315 g_free (request_data);
3318 /* Called when we request a paste and receive the text data
3321 clipboard_text_received (GtkClipboard *clipboard,
3325 ClipboardRequest *request_data = data;
3326 GtkTextBuffer *buffer = request_data->buffer;
3330 GtkTextIter insert_point;
3332 if (request_data->interactive)
3333 gtk_text_buffer_begin_user_action (buffer);
3335 pre_paste_prep (request_data, &insert_point);
3337 if (request_data->interactive)
3338 gtk_text_buffer_insert_interactive (buffer, &insert_point,
3339 str, -1, request_data->default_editable);
3341 gtk_text_buffer_insert (buffer, &insert_point,
3344 post_paste_cleanup (request_data);
3346 if (request_data->interactive)
3347 gtk_text_buffer_end_user_action (buffer);
3350 free_clipboard_request (request_data);
3353 static GtkTextBuffer*
3354 selection_data_get_buffer (GtkSelectionData *selection_data,
3355 ClipboardRequest *request_data)
3358 GtkTextBuffer *src_buffer = NULL;
3360 /* If we can get the owner, the selection is in-process */
3361 owner = gdk_selection_owner_get_for_display (selection_data->display,
3362 selection_data->selection);
3367 if (gdk_window_get_window_type (owner) == GDK_WINDOW_FOREIGN)
3370 if (selection_data->type !=
3371 gdk_atom_intern_static_string ("GTK_TEXT_BUFFER_CONTENTS"))
3374 if (selection_data->length != sizeof (src_buffer))
3377 memcpy (&src_buffer, selection_data->data, sizeof (src_buffer));
3379 if (src_buffer == NULL)
3382 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (src_buffer), NULL);
3384 if (gtk_text_buffer_get_tag_table (src_buffer) !=
3385 gtk_text_buffer_get_tag_table (request_data->buffer))
3392 /* These are pretty handy functions; maybe something like them
3393 * should be in the public API. Also, there are other places in this
3394 * file where they could be used.
3397 save_iter (const GtkTextIter *iter,
3398 gboolean left_gravity)
3400 return gtk_text_buffer_create_mark (gtk_text_iter_get_buffer (iter),
3407 restore_iter (const GtkTextIter *iter,
3410 gtk_text_buffer_get_iter_at_mark (gtk_text_mark_get_buffer (save_id),
3411 (GtkTextIter*) iter,
3413 gtk_text_buffer_delete_mark (gtk_text_mark_get_buffer (save_id),
3419 clipboard_rich_text_received (GtkClipboard *clipboard,
3425 ClipboardRequest *request_data = data;
3426 GtkTextIter insert_point;
3427 gboolean retval = TRUE;
3428 GError *error = NULL;
3430 if (text != NULL && length > 0)
3432 pre_paste_prep (request_data, &insert_point);
3434 if (request_data->interactive)
3435 gtk_text_buffer_begin_user_action (request_data->buffer);
3437 if (!request_data->interactive ||
3438 gtk_text_iter_can_insert (&insert_point,
3439 request_data->default_editable))
3441 retval = gtk_text_buffer_deserialize (request_data->buffer,
3442 request_data->buffer,
3451 g_warning ("error pasting: %s\n", error->message);
3452 g_clear_error (&error);
3455 if (request_data->interactive)
3456 gtk_text_buffer_end_user_action (request_data->buffer);
3460 post_paste_cleanup (request_data);
3465 /* Request the text selection instead */
3466 gtk_clipboard_request_text (clipboard,
3467 clipboard_text_received,
3472 paste_from_buffer (ClipboardRequest *request_data,
3473 GtkTextBuffer *src_buffer,
3474 const GtkTextIter *start,
3475 const GtkTextIter *end)
3477 GtkTextIter insert_point;
3478 GtkTextBuffer *buffer = request_data->buffer;
3480 /* We're about to emit a bunch of signals, so be safe */
3481 g_object_ref (src_buffer);
3483 pre_paste_prep (request_data, &insert_point);
3485 if (request_data->interactive)
3486 gtk_text_buffer_begin_user_action (buffer);
3488 if (!gtk_text_iter_equal (start, end))
3490 if (!request_data->interactive ||
3491 (gtk_text_iter_can_insert (&insert_point,
3492 request_data->default_editable)))
3493 gtk_text_buffer_real_insert_range (buffer,
3497 request_data->interactive);
3500 post_paste_cleanup (request_data);
3502 if (request_data->interactive)
3503 gtk_text_buffer_end_user_action (buffer);
3505 g_object_unref (src_buffer);
3507 free_clipboard_request (request_data);
3511 clipboard_clipboard_buffer_received (GtkClipboard *clipboard,
3512 GtkSelectionData *selection_data,
3515 ClipboardRequest *request_data = data;
3516 GtkTextBuffer *src_buffer;
3518 src_buffer = selection_data_get_buffer (selection_data, request_data);
3522 GtkTextIter start, end;
3524 if (g_object_get_data (G_OBJECT (src_buffer), "gtk-text-buffer-clipboard"))
3526 gtk_text_buffer_get_bounds (src_buffer, &start, &end);
3528 paste_from_buffer (request_data, src_buffer,
3533 if (gtk_text_buffer_get_selection_bounds (src_buffer, &start, &end))
3534 paste_from_buffer (request_data, src_buffer,
3540 if (gtk_clipboard_wait_is_rich_text_available (clipboard,
3541 request_data->buffer))
3543 /* Request rich text */
3544 gtk_clipboard_request_rich_text (clipboard,
3545 request_data->buffer,
3546 clipboard_rich_text_received,
3551 /* Request the text selection instead */
3552 gtk_clipboard_request_text (clipboard,
3553 clipboard_text_received,
3561 GtkClipboard *clipboard;
3563 } SelectionClipboard;
3566 update_selection_clipboards (GtkTextBuffer *buffer)
3568 GtkTextBufferPrivate *priv;
3569 GSList *tmp_list = buffer->selection_clipboards;
3571 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
3573 gtk_text_buffer_get_copy_target_list (buffer);
3580 SelectionClipboard *selection_clipboard = tmp_list->data;
3581 GtkClipboard *clipboard = selection_clipboard->clipboard;
3583 /* Determine whether we have a selection and adjust X selection
3586 if (!gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3588 if (gtk_clipboard_get_owner (clipboard) == G_OBJECT (buffer))
3589 gtk_clipboard_clear (clipboard);
3593 /* Even if we already have the selection, we need to update our
3596 if (!gtk_clipboard_set_with_owner (clipboard,
3597 priv->copy_target_entries,
3598 priv->n_copy_target_entries,
3599 clipboard_get_selection_cb,
3600 clipboard_clear_selection_cb,
3602 clipboard_clear_selection_cb (clipboard, buffer);
3605 tmp_list = tmp_list->next;
3609 static SelectionClipboard *
3610 find_selection_clipboard (GtkTextBuffer *buffer,
3611 GtkClipboard *clipboard)
3613 GSList *tmp_list = buffer->selection_clipboards;
3616 SelectionClipboard *selection_clipboard = tmp_list->data;
3617 if (selection_clipboard->clipboard == clipboard)
3618 return selection_clipboard;
3620 tmp_list = tmp_list->next;
3627 * gtk_text_buffer_add_selection_clipboard:
3628 * @buffer: a #GtkTextBuffer
3629 * @clipboard: a #GtkClipboard
3631 * Adds @clipboard to the list of clipboards in which the selection
3632 * contents of @buffer are available. In most cases, @clipboard will be
3633 * the #GtkClipboard of type %GDK_SELECTION_PRIMARY for a view of @buffer.
3636 gtk_text_buffer_add_selection_clipboard (GtkTextBuffer *buffer,
3637 GtkClipboard *clipboard)
3639 SelectionClipboard *selection_clipboard;
3641 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
3642 g_return_if_fail (clipboard != NULL);
3644 selection_clipboard = find_selection_clipboard (buffer, clipboard);
3645 if (selection_clipboard)
3647 selection_clipboard->ref_count++;
3651 selection_clipboard = g_new (SelectionClipboard, 1);
3653 selection_clipboard->clipboard = clipboard;
3654 selection_clipboard->ref_count = 1;
3656 buffer->selection_clipboards = g_slist_prepend (buffer->selection_clipboards, selection_clipboard);
3661 * gtk_text_buffer_remove_selection_clipboard:
3662 * @buffer: a #GtkTextBuffer
3663 * @clipboard: a #GtkClipboard added to @buffer by
3664 * gtk_text_buffer_add_selection_clipboard()
3666 * Removes a #GtkClipboard added with
3667 * gtk_text_buffer_add_selection_clipboard().
3670 gtk_text_buffer_remove_selection_clipboard (GtkTextBuffer *buffer,
3671 GtkClipboard *clipboard)
3673 SelectionClipboard *selection_clipboard;
3675 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
3676 g_return_if_fail (clipboard != NULL);
3678 selection_clipboard = find_selection_clipboard (buffer, clipboard);
3679 g_return_if_fail (selection_clipboard != NULL);
3681 selection_clipboard->ref_count--;
3682 if (selection_clipboard->ref_count == 0)
3684 if (gtk_clipboard_get_owner (selection_clipboard->clipboard) == G_OBJECT (buffer))
3685 gtk_clipboard_clear (selection_clipboard->clipboard);
3687 buffer->selection_clipboards = g_slist_remove (buffer->selection_clipboards,
3688 selection_clipboard);
3690 g_free (selection_clipboard);
3695 remove_all_selection_clipboards (GtkTextBuffer *buffer)
3697 g_slist_foreach (buffer->selection_clipboards, (GFunc)g_free, NULL);
3698 g_slist_free (buffer->selection_clipboards);
3699 buffer->selection_clipboards = NULL;
3703 * gtk_text_buffer_paste_clipboard:
3704 * @buffer: a #GtkTextBuffer
3705 * @clipboard: the #GtkClipboard to paste from
3706 * @override_location: location to insert pasted text, or %NULL for
3708 * @default_editable: whether the buffer is editable by default
3710 * Pastes the contents of a clipboard at the insertion point, or at
3711 * @override_location. (Note: pasting is asynchronous, that is, we'll
3712 * ask for the paste data and return, and at some point later after
3713 * the main loop runs, the paste data will be inserted.)
3716 gtk_text_buffer_paste_clipboard (GtkTextBuffer *buffer,
3717 GtkClipboard *clipboard,
3718 GtkTextIter *override_location,
3719 gboolean default_editable)
3721 ClipboardRequest *data = g_new (ClipboardRequest, 1);
3722 GtkTextIter paste_point;
3723 GtkTextIter start, end;
3725 if (override_location != NULL)
3726 gtk_text_buffer_create_mark (buffer,
3727 "gtk_paste_point_override",
3728 override_location, FALSE);
3730 data->buffer = g_object_ref (buffer);
3731 data->interactive = TRUE;
3732 data->default_editable = default_editable;
3734 /* When pasting with the cursor inside the selection area, you
3735 * replace the selection with the new text, otherwise, you
3736 * simply insert the new text at the point where the click
3737 * occured, unselecting any selected text. The replace_selection
3738 * flag toggles this behavior.
3740 data->replace_selection = FALSE;
3742 get_paste_point (buffer, &paste_point, FALSE);
3743 if (gtk_text_buffer_get_selection_bounds (buffer, &start, &end) &&
3744 (gtk_text_iter_in_range (&paste_point, &start, &end) ||
3745 gtk_text_iter_equal (&paste_point, &end)))
3746 data->replace_selection = TRUE;
3748 gtk_clipboard_request_contents (clipboard,
3749 gdk_atom_intern_static_string ("GTK_TEXT_BUFFER_CONTENTS"),
3750 clipboard_clipboard_buffer_received, data);
3754 * gtk_text_buffer_delete_selection:
3755 * @buffer: a #GtkTextBuffer
3756 * @interactive: whether the deletion is caused by user interaction
3757 * @default_editable: whether the buffer is editable by default
3759 * Deletes the range between the "insert" and "selection_bound" marks,
3760 * that is, the currently-selected text. If @interactive is %TRUE,
3761 * the editability of the selection will be considered (users can't delete
3764 * Return value: whether there was a non-empty selection to delete
3767 gtk_text_buffer_delete_selection (GtkTextBuffer *buffer,
3768 gboolean interactive,
3769 gboolean default_editable)
3774 if (!gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3776 return FALSE; /* No selection */
3782 gtk_text_buffer_begin_user_action (buffer);
3783 gtk_text_buffer_delete_interactive (buffer, &start, &end, default_editable);
3784 gtk_text_buffer_end_user_action (buffer);
3787 gtk_text_buffer_delete (buffer, &start, &end);
3789 return TRUE; /* We deleted stuff */
3794 * gtk_text_buffer_backspace:
3795 * @buffer: a #GtkTextBuffer
3796 * @iter: a position in @buffer
3797 * @interactive: whether the deletion is caused by user interaction
3798 * @default_editable: whether the buffer is editable by default
3800 * Performs the appropriate action as if the user hit the delete
3801 * key with the cursor at the position specified by @iter. In the
3802 * normal case a single character will be deleted, but when
3803 * combining accents are involved, more than one character can
3804 * be deleted, and when precomposed character and accent combinations
3805 * are involved, less than one character will be deleted.
3807 * Because the buffer is modified, all outstanding iterators become
3808 * invalid after calling this function; however, the @iter will be
3809 * re-initialized to point to the location where text was deleted.
3811 * Return value: %TRUE if the buffer was modified
3816 gtk_text_buffer_backspace (GtkTextBuffer *buffer,
3818 gboolean interactive,
3819 gboolean default_editable)
3821 gchar *cluster_text;
3824 gboolean retval = FALSE;
3825 const PangoLogAttr *attrs;
3827 gboolean backspace_deletes_character;
3829 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
3830 g_return_val_if_fail (iter != NULL, FALSE);
3835 attrs = _gtk_text_buffer_get_line_log_attrs (buffer, &start, NULL);
3837 /* For no good reason, attrs is NULL for the empty last line in
3838 * a buffer. Special case that here. (#156164)
3842 offset = gtk_text_iter_get_line_offset (&start);
3843 backspace_deletes_character = attrs[offset].backspace_deletes_character;
3846 backspace_deletes_character = FALSE;
3848 gtk_text_iter_backward_cursor_position (&start);
3850 if (gtk_text_iter_equal (&start, &end))
3853 cluster_text = gtk_text_iter_get_text (&start, &end);
3856 gtk_text_buffer_begin_user_action (buffer);
3858 if (gtk_text_buffer_delete_interactive (buffer, &start, &end,
3861 if (backspace_deletes_character)
3863 gchar *normalized_text = g_utf8_normalize (cluster_text,
3864 strlen (cluster_text),
3866 glong len = g_utf8_strlen (normalized_text, -1);
3869 gtk_text_buffer_insert_interactive (buffer,
3872 g_utf8_offset_to_pointer (normalized_text, len - 1) - normalized_text,
3875 g_free (normalized_text);
3882 gtk_text_buffer_end_user_action (buffer);
3884 g_free (cluster_text);
3886 /* Revalidate the users iter */
3893 cut_or_copy (GtkTextBuffer *buffer,
3894 GtkClipboard *clipboard,
3895 gboolean delete_region_after,
3896 gboolean interactive,
3897 gboolean default_editable)
3899 GtkTextBufferPrivate *priv;
3901 /* We prefer to cut the selected region between selection_bound and
3902 * insertion point. If that region is empty, then we cut the region
3903 * between the "anchor" and the insertion point (this is for
3904 * C-space and M-w and other Emacs-style copy/yank keys). Note that
3905 * insert and selection_bound are guaranteed to exist, but the
3906 * anchor only exists sometimes.
3911 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
3913 gtk_text_buffer_get_copy_target_list (buffer);
3915 if (!gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3917 /* Let's try the anchor thing */
3918 GtkTextMark * anchor = gtk_text_buffer_get_mark (buffer, "anchor");
3924 gtk_text_buffer_get_iter_at_mark (buffer, &end, anchor);
3925 gtk_text_iter_order (&start, &end);
3929 if (!gtk_text_iter_equal (&start, &end))
3932 GtkTextBuffer *contents;
3934 contents = create_clipboard_contents_buffer (buffer);
3936 gtk_text_buffer_get_iter_at_offset (contents, &ins, 0);
3938 gtk_text_buffer_insert_range (contents, &ins, &start, &end);
3940 if (!gtk_clipboard_set_with_data (clipboard,
3941 priv->copy_target_entries,
3942 priv->n_copy_target_entries,
3943 clipboard_get_contents_cb,
3944 clipboard_clear_contents_cb,
3946 g_object_unref (contents);
3948 gtk_clipboard_set_can_store (clipboard,
3949 priv->copy_target_entries + 1,
3950 priv->n_copy_target_entries - 1);
3952 if (delete_region_after)
3955 gtk_text_buffer_delete_interactive (buffer, &start, &end,
3958 gtk_text_buffer_delete (buffer, &start, &end);
3964 * gtk_text_buffer_cut_clipboard:
3965 * @buffer: a #GtkTextBuffer
3966 * @clipboard: the #GtkClipboard object to cut to
3967 * @default_editable: default editability of the buffer
3969 * Copies the currently-selected text to a clipboard, then deletes
3970 * said text if it's editable.
3973 gtk_text_buffer_cut_clipboard (GtkTextBuffer *buffer,
3974 GtkClipboard *clipboard,
3975 gboolean default_editable)
3977 gtk_text_buffer_begin_user_action (buffer);
3978 cut_or_copy (buffer, clipboard, TRUE, TRUE, default_editable);
3979 gtk_text_buffer_end_user_action (buffer);
3983 * gtk_text_buffer_copy_clipboard:
3984 * @buffer: a #GtkTextBuffer
3985 * @clipboard: the #GtkClipboard object to copy to
3987 * Copies the currently-selected text to a clipboard.
3990 gtk_text_buffer_copy_clipboard (GtkTextBuffer *buffer,
3991 GtkClipboard *clipboard)
3993 gtk_text_buffer_begin_user_action (buffer);
3994 cut_or_copy (buffer, clipboard, FALSE, TRUE, TRUE);
3995 gtk_text_buffer_end_user_action (buffer);
4000 * gtk_text_buffer_get_selection_bounds:
4001 * @buffer: a #GtkTextBuffer a #GtkTextBuffer
4002 * @start: iterator to initialize with selection start
4003 * @end: iterator to initialize with selection end
4005 * Returns %TRUE if some text is selected; places the bounds
4006 * of the selection in @start and @end (if the selection has length 0,
4007 * then @start and @end are filled in with the same value).
4008 * @start and @end will be in ascending order. If @start and @end are
4009 * NULL, then they are not filled in, but the return value still indicates
4010 * whether text is selected.
4012 * Return value: whether the selection has nonzero length
4015 gtk_text_buffer_get_selection_bounds (GtkTextBuffer *buffer,
4019 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
4021 return _gtk_text_btree_get_selection_bounds (get_btree (buffer), start, end);
4025 * gtk_text_buffer_begin_user_action:
4026 * @buffer: a #GtkTextBuffer
4028 * Called to indicate that the buffer operations between here and a
4029 * call to gtk_text_buffer_end_user_action() are part of a single
4030 * user-visible operation. The operations between
4031 * gtk_text_buffer_begin_user_action() and
4032 * gtk_text_buffer_end_user_action() can then be grouped when creating
4033 * an undo stack. #GtkTextBuffer maintains a count of calls to
4034 * gtk_text_buffer_begin_user_action() that have not been closed with
4035 * a call to gtk_text_buffer_end_user_action(), and emits the
4036 * "begin_user_action" and "end_user_action" signals only for the
4037 * outermost pair of calls. This allows you to build user actions
4038 * from other user actions.
4040 * The "interactive" buffer mutation functions, such as
4041 * gtk_text_buffer_insert_interactive(), automatically call begin/end
4042 * user action around the buffer operations they perform, so there's
4043 * no need to add extra calls if you user action consists solely of a
4044 * single call to one of those functions.
4047 gtk_text_buffer_begin_user_action (GtkTextBuffer *buffer)
4049 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
4051 buffer->user_action_count += 1;
4053 if (buffer->user_action_count == 1)
4055 /* Outermost nested user action begin emits the signal */
4056 g_signal_emit (buffer, signals[BEGIN_USER_ACTION], 0);
4061 * gtk_text_buffer_end_user_action:
4062 * @buffer: a #GtkTextBuffer
4064 * Should be paired with a call to gtk_text_buffer_begin_user_action().
4065 * See that function for a full explanation.
4068 gtk_text_buffer_end_user_action (GtkTextBuffer *buffer)
4070 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
4071 g_return_if_fail (buffer->user_action_count > 0);
4073 buffer->user_action_count -= 1;
4075 if (buffer->user_action_count == 0)
4077 /* Ended the outermost-nested user action end, so emit the signal */
4078 g_signal_emit (buffer, signals[END_USER_ACTION], 0);
4083 gtk_text_buffer_free_target_lists (GtkTextBuffer *buffer)
4085 GtkTextBufferPrivate *priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
4087 if (priv->copy_target_list)
4089 gtk_target_list_unref (priv->copy_target_list);
4090 priv->copy_target_list = NULL;
4092 gtk_target_table_free (priv->copy_target_entries,
4093 priv->n_copy_target_entries);
4094 priv->copy_target_entries = NULL;
4095 priv->n_copy_target_entries = 0;
4098 if (priv->paste_target_list)
4100 gtk_target_list_unref (priv->paste_target_list);
4101 priv->paste_target_list = NULL;
4103 gtk_target_table_free (priv->paste_target_entries,
4104 priv->n_paste_target_entries);
4105 priv->paste_target_entries = NULL;
4106 priv->n_paste_target_entries = 0;
4110 static GtkTargetList *
4111 gtk_text_buffer_get_target_list (GtkTextBuffer *buffer,
4112 gboolean deserializable,
4113 GtkTargetEntry **entries,
4116 GtkTargetList *target_list;
4118 target_list = gtk_target_list_new (NULL, 0);
4120 gtk_target_list_add (target_list,
4121 gdk_atom_intern_static_string ("GTK_TEXT_BUFFER_CONTENTS"),
4122 GTK_TARGET_SAME_APP,
4123 GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS);
4125 gtk_target_list_add_rich_text_targets (target_list,
4126 GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT,
4130 gtk_target_list_add_text_targets (target_list,
4131 GTK_TEXT_BUFFER_TARGET_INFO_TEXT);
4133 *entries = gtk_target_table_new_from_list (target_list, n_entries);
4139 * gtk_text_buffer_get_copy_target_list:
4140 * @buffer: a #GtkTextBuffer
4142 * This function returns the list of targets this text buffer can
4143 * provide for copying and as DND source. The targets in the list are
4144 * added with %info values from the #GtkTextBufferTargetInfo enum,
4145 * using gtk_target_list_add_rich_text_targets() and
4146 * gtk_target_list_add_text_targets().
4148 * Return value: the #GtkTargetList
4153 gtk_text_buffer_get_copy_target_list (GtkTextBuffer *buffer)
4155 GtkTextBufferPrivate *priv;
4157 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
4159 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
4161 if (! priv->copy_target_list)
4162 priv->copy_target_list =
4163 gtk_text_buffer_get_target_list (buffer, FALSE,
4164 &priv->copy_target_entries,
4165 &priv->n_copy_target_entries);
4167 return priv->copy_target_list;
4171 * gtk_text_buffer_get_paste_target_list:
4172 * @buffer: a #GtkTextBuffer
4174 * This function returns the list of targets this text buffer supports
4175 * for pasting and as DND destination. The targets in the list are
4176 * added with %info values from the #GtkTextBufferTargetInfo enum,
4177 * using gtk_target_list_add_rich_text_targets() and
4178 * gtk_target_list_add_text_targets().
4180 * Return value: the #GtkTargetList
4185 gtk_text_buffer_get_paste_target_list (GtkTextBuffer *buffer)
4187 GtkTextBufferPrivate *priv;
4189 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
4191 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
4193 if (! priv->paste_target_list)
4194 priv->paste_target_list =
4195 gtk_text_buffer_get_target_list (buffer, TRUE,
4196 &priv->paste_target_entries,
4197 &priv->n_paste_target_entries);
4199 return priv->paste_target_list;
4203 * Logical attribute cache
4206 #define ATTR_CACHE_SIZE 2
4208 typedef struct _CacheEntry CacheEntry;
4213 PangoLogAttr *attrs;
4217 struct _GtkTextLogAttrCache
4219 gint chars_changed_stamp;
4220 CacheEntry entries[ATTR_CACHE_SIZE];
4224 free_log_attr_cache (GtkTextLogAttrCache *cache)
4227 while (i < ATTR_CACHE_SIZE)
4229 g_free (cache->entries[i].attrs);
4236 clear_log_attr_cache (GtkTextLogAttrCache *cache)
4239 while (i < ATTR_CACHE_SIZE)
4241 g_free (cache->entries[i].attrs);
4242 cache->entries[i].attrs = NULL;
4247 static PangoLogAttr*
4248 compute_log_attrs (const GtkTextIter *iter,
4254 gint char_len, byte_len;
4255 PangoLogAttr *attrs = NULL;
4260 gtk_text_iter_set_line_offset (&start, 0);
4261 gtk_text_iter_forward_line (&end);
4263 paragraph = gtk_text_iter_get_slice (&start, &end);
4264 char_len = g_utf8_strlen (paragraph, -1);
4265 byte_len = strlen (paragraph);
4267 g_assert (char_len > 0);
4270 *char_lenp = char_len;
4272 attrs = g_new (PangoLogAttr, char_len + 1);
4274 /* FIXME we need to follow PangoLayout and allow different language
4275 * tags within the paragraph
4277 pango_get_log_attrs (paragraph, byte_len, -1,
4278 gtk_text_iter_get_language (&start),
4287 /* The return value from this is valid until you call this a second time.
4290 _gtk_text_buffer_get_line_log_attrs (GtkTextBuffer *buffer,
4291 const GtkTextIter *anywhere_in_line,
4295 GtkTextLogAttrCache *cache;
4298 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
4299 g_return_val_if_fail (anywhere_in_line != NULL, NULL);
4301 /* special-case for empty last line in buffer */
4302 if (gtk_text_iter_is_end (anywhere_in_line) &&
4303 gtk_text_iter_get_line_offset (anywhere_in_line) == 0)
4310 /* FIXME we also need to recompute log attrs if the language tag at
4311 * the start of a paragraph changes
4314 if (buffer->log_attr_cache == NULL)
4316 buffer->log_attr_cache = g_new0 (GtkTextLogAttrCache, 1);
4317 buffer->log_attr_cache->chars_changed_stamp =
4318 _gtk_text_btree_get_chars_changed_stamp (get_btree (buffer));
4320 else if (buffer->log_attr_cache->chars_changed_stamp !=
4321 _gtk_text_btree_get_chars_changed_stamp (get_btree (buffer)))
4323 clear_log_attr_cache (buffer->log_attr_cache);
4326 cache = buffer->log_attr_cache;
4327 line = gtk_text_iter_get_line (anywhere_in_line);
4330 while (i < ATTR_CACHE_SIZE)
4332 if (cache->entries[i].attrs &&
4333 cache->entries[i].line == line)
4336 *char_len = cache->entries[i].char_len;
4337 return cache->entries[i].attrs;
4342 /* Not in cache; open up the first cache entry */
4343 g_free (cache->entries[ATTR_CACHE_SIZE-1].attrs);
4345 g_memmove (cache->entries + 1, cache->entries,
4346 sizeof (CacheEntry) * (ATTR_CACHE_SIZE - 1));
4348 cache->entries[0].line = line;
4349 cache->entries[0].attrs = compute_log_attrs (anywhere_in_line,
4350 &cache->entries[0].char_len);
4353 *char_len = cache->entries[0].char_len;
4355 return cache->entries[0].attrs;
4359 _gtk_text_buffer_notify_will_remove_tag (GtkTextBuffer *buffer,
4362 /* This removes tag from the buffer, but DOESN'T emit the
4363 * remove_tag signal, because we can't afford to have user
4364 * code messing things up at this point; the tag MUST be removed
4368 _gtk_text_btree_notify_will_remove_tag (buffer->btree, tag);
4376 _gtk_text_buffer_spew (GtkTextBuffer *buffer)
4378 _gtk_text_btree_spew (get_btree (buffer));
4381 #define __GTK_TEXT_BUFFER_C__
4382 #include "gtkaliasdef.c"