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 /* It's more robust to ask for the state again then to assume that
1728 * we're on the next not-editable segment. We don't know what the
1729 * ::delete-range handler did.... maybe it deleted the following not-editable
1730 * segment because it was associated with the editable segment.
1732 current_state = gtk_text_iter_editable (&iter, default_editable);
1733 deleted_stuff = TRUE;
1735 /* revalidate user's iterators. */
1736 *start_iter = start;
1741 /* We are at the start of an editable region. We won't be deleting
1742 * the previous region. Move start mark to start of this region.
1745 g_assert (!current_state && new_state);
1747 gtk_text_buffer_move_mark (buffer, start_mark,
1751 current_state = TRUE;
1759 gtk_text_buffer_delete_mark (buffer, start_mark);
1760 gtk_text_buffer_delete_mark (buffer, end_mark);
1762 gtk_text_buffer_end_user_action (buffer);
1764 return deleted_stuff;
1768 * Extracting textual buffer contents
1772 * gtk_text_buffer_get_text:
1773 * @buffer: a #GtkTextBuffer
1774 * @start: start of a range
1775 * @end: end of a range
1776 * @include_hidden_chars: whether to include invisible text
1778 * Returns the text in the range [@start,@end). Excludes undisplayed
1779 * text (text marked with tags that set the invisibility attribute) if
1780 * @include_hidden_chars is %FALSE. Does not include characters
1781 * representing embedded images, so byte and character indexes into
1782 * the returned string do <emphasis>not</emphasis> correspond to byte
1783 * and character indexes into the buffer. Contrast with
1784 * gtk_text_buffer_get_slice().
1786 * Return value: an allocated UTF-8 string
1789 gtk_text_buffer_get_text (GtkTextBuffer *buffer,
1790 const GtkTextIter *start,
1791 const GtkTextIter *end,
1792 gboolean include_hidden_chars)
1794 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
1795 g_return_val_if_fail (start != NULL, NULL);
1796 g_return_val_if_fail (end != NULL, NULL);
1797 g_return_val_if_fail (gtk_text_iter_get_buffer (start) == buffer, NULL);
1798 g_return_val_if_fail (gtk_text_iter_get_buffer (end) == buffer, NULL);
1800 if (include_hidden_chars)
1801 return gtk_text_iter_get_text (start, end);
1803 return gtk_text_iter_get_visible_text (start, end);
1807 * gtk_text_buffer_get_slice:
1808 * @buffer: a #GtkTextBuffer
1809 * @start: start of a range
1810 * @end: end of a range
1811 * @include_hidden_chars: whether to include invisible text
1813 * Returns the text in the range [@start,@end). Excludes undisplayed
1814 * text (text marked with tags that set the invisibility attribute) if
1815 * @include_hidden_chars is %FALSE. The returned string includes a
1816 * 0xFFFC character whenever the buffer contains
1817 * embedded images, so byte and character indexes into
1818 * the returned string <emphasis>do</emphasis> correspond to byte
1819 * and character indexes into the buffer. Contrast with
1820 * gtk_text_buffer_get_text(). Note that 0xFFFC can occur in normal
1821 * text as well, so it is not a reliable indicator that a pixbuf or
1822 * widget is in the buffer.
1824 * Return value: an allocated UTF-8 string
1827 gtk_text_buffer_get_slice (GtkTextBuffer *buffer,
1828 const GtkTextIter *start,
1829 const GtkTextIter *end,
1830 gboolean include_hidden_chars)
1832 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
1833 g_return_val_if_fail (start != NULL, NULL);
1834 g_return_val_if_fail (end != NULL, NULL);
1835 g_return_val_if_fail (gtk_text_iter_get_buffer (start) == buffer, NULL);
1836 g_return_val_if_fail (gtk_text_iter_get_buffer (end) == buffer, NULL);
1838 if (include_hidden_chars)
1839 return gtk_text_iter_get_slice (start, end);
1841 return gtk_text_iter_get_visible_slice (start, end);
1849 gtk_text_buffer_real_insert_pixbuf (GtkTextBuffer *buffer,
1853 _gtk_text_btree_insert_pixbuf (iter, pixbuf);
1855 g_signal_emit (buffer, signals[CHANGED], 0);
1859 * gtk_text_buffer_insert_pixbuf:
1860 * @buffer: a #GtkTextBuffer
1861 * @iter: location to insert the pixbuf
1862 * @pixbuf: a #GdkPixbuf
1864 * Inserts an image into the text buffer at @iter. The image will be
1865 * counted as one character in character counts, and when obtaining
1866 * the buffer contents as a string, will be represented by the Unicode
1867 * "object replacement character" 0xFFFC. Note that the "slice"
1868 * variants for obtaining portions of the buffer as a string include
1869 * this character for pixbufs, but the "text" variants do
1870 * not. e.g. see gtk_text_buffer_get_slice() and
1871 * gtk_text_buffer_get_text().
1874 gtk_text_buffer_insert_pixbuf (GtkTextBuffer *buffer,
1878 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1879 g_return_if_fail (iter != NULL);
1880 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
1881 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
1883 g_signal_emit (buffer, signals[INSERT_PIXBUF], 0,
1893 gtk_text_buffer_real_insert_anchor (GtkTextBuffer *buffer,
1895 GtkTextChildAnchor *anchor)
1897 _gtk_text_btree_insert_child_anchor (iter, anchor);
1899 g_signal_emit (buffer, signals[CHANGED], 0);
1903 * gtk_text_buffer_insert_child_anchor:
1904 * @buffer: a #GtkTextBuffer
1905 * @iter: location to insert the anchor
1906 * @anchor: a #GtkTextChildAnchor
1908 * Inserts a child widget anchor into the text buffer at @iter. The
1909 * anchor will be counted as one character in character counts, and
1910 * when obtaining the buffer contents as a string, will be represented
1911 * by the Unicode "object replacement character" 0xFFFC. Note that the
1912 * "slice" variants for obtaining portions of the buffer as a string
1913 * include this character for child anchors, but the "text" variants do
1914 * not. E.g. see gtk_text_buffer_get_slice() and
1915 * gtk_text_buffer_get_text(). Consider
1916 * gtk_text_buffer_create_child_anchor() as a more convenient
1917 * alternative to this function. The buffer will add a reference to
1918 * the anchor, so you can unref it after insertion.
1921 gtk_text_buffer_insert_child_anchor (GtkTextBuffer *buffer,
1923 GtkTextChildAnchor *anchor)
1925 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
1926 g_return_if_fail (iter != NULL);
1927 g_return_if_fail (GTK_IS_TEXT_CHILD_ANCHOR (anchor));
1928 g_return_if_fail (gtk_text_iter_get_buffer (iter) == buffer);
1930 g_signal_emit (buffer, signals[INSERT_CHILD_ANCHOR], 0,
1936 * gtk_text_buffer_create_child_anchor:
1937 * @buffer: a #GtkTextBuffer
1938 * @iter: location in the buffer
1940 * This is a convenience function which simply creates a child anchor
1941 * with gtk_text_child_anchor_new() and inserts it into the buffer
1942 * with gtk_text_buffer_insert_child_anchor(). The new anchor is
1943 * owned by the buffer; no reference count is returned to
1944 * the caller of gtk_text_buffer_create_child_anchor().
1946 * Return value: the created child anchor
1949 gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
1952 GtkTextChildAnchor *anchor;
1954 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
1955 g_return_val_if_fail (iter != NULL, NULL);
1956 g_return_val_if_fail (gtk_text_iter_get_buffer (iter) == buffer, NULL);
1958 anchor = gtk_text_child_anchor_new ();
1960 gtk_text_buffer_insert_child_anchor (buffer, iter, anchor);
1962 g_object_unref (anchor);
1972 gtk_text_buffer_mark_set (GtkTextBuffer *buffer,
1973 const GtkTextIter *location,
1976 /* IMO this should NOT work like insert_text and delete_range,
1977 * where the real action happens in the default handler.
1979 * The reason is that the default handler would be _required_,
1980 * i.e. the whole widget would start breaking and segfaulting if the
1981 * default handler didn't get run. So you can't really override the
1982 * default handler or stop the emission; that is, this signal is
1983 * purely for notification, and not to allow users to modify the
1987 g_object_ref (mark);
1989 g_signal_emit (buffer,
1995 g_object_unref (mark);
1999 * gtk_text_buffer_set_mark:
2000 * @buffer: a #GtkTextBuffer
2001 * @mark_name: name of the mark
2002 * @iter: location for the mark
2003 * @left_gravity: if the mark is created by this function, gravity for
2005 * @should_exist: if %TRUE, warn if the mark does not exist, and return
2008 * Move the mark to the given position, if not @should_exist,
2011 * Return value: mark
2014 gtk_text_buffer_set_mark (GtkTextBuffer *buffer,
2015 GtkTextMark *existing_mark,
2016 const gchar *mark_name,
2017 const GtkTextIter *iter,
2018 gboolean left_gravity,
2019 gboolean should_exist)
2021 GtkTextIter location;
2024 g_return_val_if_fail (gtk_text_iter_get_buffer (iter) == buffer, NULL);
2026 mark = _gtk_text_btree_set_mark (get_btree (buffer),
2033 _gtk_text_btree_get_iter_at_mark (get_btree (buffer),
2037 gtk_text_buffer_mark_set (buffer, &location, mark);
2043 * gtk_text_buffer_create_mark:
2044 * @buffer: a #GtkTextBuffer
2045 * @mark_name: name for mark, or %NULL
2046 * @where: location to place mark
2047 * @left_gravity: whether the mark has left gravity
2049 * Creates a mark at position @where. If @mark_name is %NULL, the mark
2050 * is anonymous; otherwise, the mark can be retrieved by name using
2051 * gtk_text_buffer_get_mark(). If a mark has left gravity, and text is
2052 * inserted at the mark's current location, the mark will be moved to
2053 * the left of the newly-inserted text. If the mark has right gravity
2054 * (@left_gravity = %FALSE), the mark will end up on the right of
2055 * newly-inserted text. The standard left-to-right cursor is a mark
2056 * with right gravity (when you type, the cursor stays on the right
2057 * side of the text you're typing).
2059 * The caller of this function does <emphasis>not</emphasis> own a
2060 * reference to the returned #GtkTextMark, so you can ignore the
2061 * return value if you like. Marks are owned by the buffer and go
2062 * away when the buffer does.
2064 * Emits the "mark_set" signal as notification of the mark's initial
2067 * Return value: the new #GtkTextMark object
2070 gtk_text_buffer_create_mark (GtkTextBuffer *buffer,
2071 const gchar *mark_name,
2072 const GtkTextIter *where,
2073 gboolean left_gravity)
2075 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2077 return gtk_text_buffer_set_mark (buffer, NULL, mark_name, where,
2078 left_gravity, FALSE);
2082 * gtk_text_buffer_add_mark:
2083 * @buffer: a #GtkTextBuffer
2084 * @mark: the mark to add
2085 * @where: location to place mark
2087 * Adds the mark at position @where. The mark must not be added to
2088 * another buffer, and if its name is not %NULL then there must not
2089 * be another mark in the buffer with the same name.
2091 * Emits the "mark_set" signal as notification of the mark's initial
2097 gtk_text_buffer_add_mark (GtkTextBuffer *buffer,
2099 const GtkTextIter *where)
2103 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2104 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2105 g_return_if_fail (where != NULL);
2106 g_return_if_fail (gtk_text_mark_get_buffer (mark) == NULL);
2108 name = gtk_text_mark_get_name (mark);
2110 if (name != NULL && gtk_text_buffer_get_mark (buffer, name) != NULL)
2112 g_critical ("Mark %s already exists in the buffer", name);
2116 gtk_text_buffer_set_mark (buffer, mark, NULL, where, FALSE, FALSE);
2120 * gtk_text_buffer_move_mark:
2121 * @buffer: a #GtkTextBuffer
2122 * @mark: a #GtkTextMark
2123 * @where: new location for @mark in @buffer
2125 * Moves @mark to the new location @where. Emits the "mark_set" signal
2126 * as notification of the move.
2129 gtk_text_buffer_move_mark (GtkTextBuffer *buffer,
2131 const GtkTextIter *where)
2133 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2134 g_return_if_fail (!gtk_text_mark_get_deleted (mark));
2135 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2137 gtk_text_buffer_set_mark (buffer, mark, NULL, where, FALSE, TRUE);
2141 * gtk_text_buffer_get_iter_at_mark:
2142 * @buffer: a #GtkTextBuffer
2143 * @iter: iterator to initialize
2144 * @mark: a #GtkTextMark in @buffer
2146 * Initializes @iter with the current position of @mark.
2149 gtk_text_buffer_get_iter_at_mark (GtkTextBuffer *buffer,
2153 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2154 g_return_if_fail (!gtk_text_mark_get_deleted (mark));
2155 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2157 _gtk_text_btree_get_iter_at_mark (get_btree (buffer),
2163 * gtk_text_buffer_delete_mark:
2164 * @buffer: a #GtkTextBuffer
2165 * @mark: a #GtkTextMark in @buffer
2167 * Deletes @mark, so that it's no longer located anywhere in the
2168 * buffer. Removes the reference the buffer holds to the mark, so if
2169 * you haven't called g_object_ref() on the mark, it will be freed. Even
2170 * if the mark isn't freed, most operations on @mark become
2171 * invalid, until it gets added to a buffer again with
2172 * gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to
2173 * find out if a mark has been removed from its buffer.
2174 * The "mark_deleted" signal will be emitted as notification after
2175 * the mark is deleted.
2178 gtk_text_buffer_delete_mark (GtkTextBuffer *buffer,
2181 g_return_if_fail (GTK_IS_TEXT_MARK (mark));
2182 g_return_if_fail (!gtk_text_mark_get_deleted (mark));
2183 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2185 g_object_ref (mark);
2187 _gtk_text_btree_remove_mark (get_btree (buffer), mark);
2189 /* See rationale above for MARK_SET on why we emit this after
2190 * removing the mark, rather than removing the mark in a default
2193 g_signal_emit (buffer, signals[MARK_DELETED],
2197 g_object_unref (mark);
2201 * gtk_text_buffer_get_mark:
2202 * @buffer: a #GtkTextBuffer
2203 * @name: a mark name
2205 * Returns the mark named @name in buffer @buffer, or %NULL if no such
2206 * mark exists in the buffer.
2208 * Return value: a #GtkTextMark, or %NULL
2211 gtk_text_buffer_get_mark (GtkTextBuffer *buffer,
2216 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2217 g_return_val_if_fail (name != NULL, NULL);
2219 mark = _gtk_text_btree_get_mark_by_name (get_btree (buffer), name);
2226 * gtk_text_buffer_move_mark_by_name:
2227 * @buffer: a #GtkTextBuffer
2228 * @name: name of a mark
2229 * @where: new location for mark
2231 * Moves the mark named @name (which must exist) to location @where.
2232 * See gtk_text_buffer_move_mark() for details.
2235 gtk_text_buffer_move_mark_by_name (GtkTextBuffer *buffer,
2237 const GtkTextIter *where)
2241 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2242 g_return_if_fail (name != NULL);
2244 mark = _gtk_text_btree_get_mark_by_name (get_btree (buffer), name);
2248 g_warning ("%s: no mark named '%s'", G_STRLOC, name);
2252 gtk_text_buffer_move_mark (buffer, mark, where);
2256 * gtk_text_buffer_delete_mark_by_name:
2257 * @buffer: a #GtkTextBuffer
2258 * @name: name of a mark in @buffer
2260 * Deletes the mark named @name; the mark must exist. See
2261 * gtk_text_buffer_delete_mark() for details.
2264 gtk_text_buffer_delete_mark_by_name (GtkTextBuffer *buffer,
2269 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2270 g_return_if_fail (name != NULL);
2272 mark = _gtk_text_btree_get_mark_by_name (get_btree (buffer), name);
2276 g_warning ("%s: no mark named '%s'", G_STRLOC, name);
2280 gtk_text_buffer_delete_mark (buffer, mark);
2284 * gtk_text_buffer_get_insert:
2285 * @buffer: a #GtkTextBuffer
2287 * Returns the mark that represents the cursor (insertion point).
2288 * Equivalent to calling gtk_text_buffer_get_mark() to get the mark
2289 * named "insert", but very slightly more efficient, and involves less
2292 * Return value: insertion point mark
2295 gtk_text_buffer_get_insert (GtkTextBuffer *buffer)
2297 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2299 /* FIXME use struct member in btree */
2300 return gtk_text_buffer_get_mark (buffer, "insert");
2304 * gtk_text_buffer_get_selection_bound:
2305 * @buffer: a #GtkTextBuffer
2307 * Returns the mark that represents the selection bound. Equivalent
2308 * to calling gtk_text_buffer_get_mark() to get the mark named
2309 * "selection_bound", but very slightly more efficient, and involves
2312 * The currently-selected text in @buffer is the region between the
2313 * "selection_bound" and "insert" marks. If "selection_bound" and
2314 * "insert" are in the same place, then there is no current selection.
2315 * gtk_text_buffer_get_selection_bounds() is another convenient function
2316 * for handling the selection, if you just want to know whether there's a
2317 * selection and what its bounds are.
2319 * Return value: selection bound mark
2322 gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer)
2324 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2326 /* FIXME use struct member in btree */
2327 return gtk_text_buffer_get_mark (buffer, "selection_bound");
2331 * gtk_text_buffer_get_iter_at_child_anchor:
2332 * @buffer: a #GtkTextBuffer
2333 * @iter: an iterator to be initialized
2334 * @anchor: a child anchor that appears in @buffer
2336 * Obtains the location of @anchor within @buffer.
2339 gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer *buffer,
2341 GtkTextChildAnchor *anchor)
2343 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2344 g_return_if_fail (iter != NULL);
2345 g_return_if_fail (GTK_IS_TEXT_CHILD_ANCHOR (anchor));
2346 g_return_if_fail (!gtk_text_child_anchor_get_deleted (anchor));
2348 _gtk_text_btree_get_iter_at_child_anchor (get_btree (buffer),
2354 * gtk_text_buffer_place_cursor:
2355 * @buffer: a #GtkTextBuffer
2356 * @where: where to put the cursor
2358 * This function moves the "insert" and "selection_bound" marks
2359 * simultaneously. If you move them to the same place in two steps
2360 * with gtk_text_buffer_move_mark(), you will temporarily select a
2361 * region in between their old and new locations, which can be pretty
2362 * inefficient since the temporarily-selected region will force stuff
2363 * to be recalculated. This function moves them as a unit, which can
2367 gtk_text_buffer_place_cursor (GtkTextBuffer *buffer,
2368 const GtkTextIter *where)
2370 gtk_text_buffer_select_range (buffer, where, where);
2375 * gtk_text_buffer_select_range:
2376 * @buffer: a #GtkTextBuffer
2377 * @ins: where to put the "insert" mark
2378 * @bound: where to put the "selection_bound" mark
2380 * This function moves the "insert" and "selection_bound" marks
2381 * simultaneously. If you move them in two steps
2382 * with gtk_text_buffer_move_mark(), you will temporarily select a
2383 * region in between their old and new locations, which can be pretty
2384 * inefficient since the temporarily-selected region will force stuff
2385 * to be recalculated. This function moves them as a unit, which can
2391 gtk_text_buffer_select_range (GtkTextBuffer *buffer,
2392 const GtkTextIter *ins,
2393 const GtkTextIter *bound)
2395 GtkTextIter real_ins;
2396 GtkTextIter real_bound;
2398 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2401 real_bound = *bound;
2403 _gtk_text_btree_select_range (get_btree (buffer), &real_ins, &real_bound);
2404 gtk_text_buffer_mark_set (buffer, &real_ins,
2405 gtk_text_buffer_get_mark (buffer,
2407 gtk_text_buffer_mark_set (buffer, &real_bound,
2408 gtk_text_buffer_get_mark (buffer,
2409 "selection_bound"));
2417 * gtk_text_buffer_create_tag:
2418 * @buffer: a #GtkTextBuffer
2419 * @tag_name: name of the new tag, or %NULL
2420 * @first_property_name: name of first property to set, or %NULL
2421 * @Varargs: %NULL-terminated list of property names and values
2424 * Creates a tag and adds it to the tag table for @buffer.
2425 * Equivalent to calling gtk_text_tag_new() and then adding the
2426 * tag to the buffer's tag table. The returned tag is owned by
2427 * the buffer's tag table, so the ref count will be equal to one.
2429 * If @tag_name is %NULL, the tag is anonymous.
2431 * If @tag_name is non-%NULL, a tag called @tag_name must not already
2432 * exist in the tag table for this buffer.
2434 * The @first_property_name argument and subsequent arguments are a list
2435 * of properties to set on the tag, as with g_object_set().
2437 * Return value: a new tag
2440 gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
2441 const gchar *tag_name,
2442 const gchar *first_property_name,
2448 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
2450 tag = gtk_text_tag_new (tag_name);
2452 gtk_text_tag_table_add (get_table (buffer), tag);
2454 if (first_property_name)
2456 va_start (list, first_property_name);
2457 g_object_set_valist (G_OBJECT (tag), first_property_name, list);
2461 g_object_unref (tag);
2467 gtk_text_buffer_real_apply_tag (GtkTextBuffer *buffer,
2469 const GtkTextIter *start,
2470 const GtkTextIter *end)
2472 if (tag->table != buffer->tag_table)
2474 g_warning ("Can only apply tags that are in the tag table for the buffer");
2478 _gtk_text_btree_tag (start, end, tag, TRUE);
2482 gtk_text_buffer_real_remove_tag (GtkTextBuffer *buffer,
2484 const GtkTextIter *start,
2485 const GtkTextIter *end)
2487 if (tag->table != buffer->tag_table)
2489 g_warning ("Can only remove tags that are in the tag table for the buffer");
2493 _gtk_text_btree_tag (start, end, tag, FALSE);
2497 gtk_text_buffer_real_changed (GtkTextBuffer *buffer)
2499 gtk_text_buffer_set_modified (buffer, TRUE);
2503 gtk_text_buffer_real_mark_set (GtkTextBuffer *buffer,
2504 const GtkTextIter *iter,
2507 GtkTextMark *insert;
2509 insert = gtk_text_buffer_get_insert (buffer);
2511 if (mark == insert || mark == gtk_text_buffer_get_selection_bound (buffer))
2513 gboolean has_selection;
2515 update_selection_clipboards (buffer);
2517 has_selection = gtk_text_buffer_get_selection_bounds (buffer,
2521 if (has_selection != buffer->has_selection)
2523 buffer->has_selection = has_selection;
2524 g_object_notify (G_OBJECT (buffer), "has-selection");
2529 g_object_notify (G_OBJECT (buffer), "cursor-position");
2533 gtk_text_buffer_emit_tag (GtkTextBuffer *buffer,
2536 const GtkTextIter *start,
2537 const GtkTextIter *end)
2539 GtkTextIter start_tmp = *start;
2540 GtkTextIter end_tmp = *end;
2542 g_return_if_fail (tag != NULL);
2544 gtk_text_iter_order (&start_tmp, &end_tmp);
2547 g_signal_emit (buffer, signals[APPLY_TAG],
2549 tag, &start_tmp, &end_tmp);
2551 g_signal_emit (buffer, signals[REMOVE_TAG],
2553 tag, &start_tmp, &end_tmp);
2558 * gtk_text_buffer_apply_tag:
2559 * @buffer: a #GtkTextBuffer
2560 * @tag: a #GtkTextTag
2561 * @start: one bound of range to be tagged
2562 * @end: other bound of range to be tagged
2564 * Emits the "apply_tag" signal on @buffer. The default
2565 * handler for the signal applies @tag to the given range.
2566 * @start and @end do not have to be in order.
2569 gtk_text_buffer_apply_tag (GtkTextBuffer *buffer,
2571 const GtkTextIter *start,
2572 const GtkTextIter *end)
2574 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2575 g_return_if_fail (GTK_IS_TEXT_TAG (tag));
2576 g_return_if_fail (start != NULL);
2577 g_return_if_fail (end != NULL);
2578 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2579 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2580 g_return_if_fail (tag->table == buffer->tag_table);
2582 gtk_text_buffer_emit_tag (buffer, tag, TRUE, start, end);
2586 * gtk_text_buffer_remove_tag:
2587 * @buffer: a #GtkTextBuffer
2588 * @tag: a #GtkTextTag
2589 * @start: one bound of range to be untagged
2590 * @end: other bound of range to be untagged
2592 * Emits the "remove_tag" signal. The default handler for the signal
2593 * removes all occurrences of @tag from the given range. @start and
2594 * @end don't have to be in order.
2597 gtk_text_buffer_remove_tag (GtkTextBuffer *buffer,
2599 const GtkTextIter *start,
2600 const GtkTextIter *end)
2603 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2604 g_return_if_fail (GTK_IS_TEXT_TAG (tag));
2605 g_return_if_fail (start != NULL);
2606 g_return_if_fail (end != NULL);
2607 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2608 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2609 g_return_if_fail (tag->table == buffer->tag_table);
2611 gtk_text_buffer_emit_tag (buffer, tag, FALSE, start, end);
2616 * gtk_text_buffer_apply_tag_by_name:
2617 * @buffer: a #GtkTextBuffer
2618 * @name: name of a named #GtkTextTag
2619 * @start: one bound of range to be tagged
2620 * @end: other bound of range to be tagged
2622 * Calls gtk_text_tag_table_lookup() on the buffer's tag table to
2623 * get a #GtkTextTag, then calls gtk_text_buffer_apply_tag().
2626 gtk_text_buffer_apply_tag_by_name (GtkTextBuffer *buffer,
2628 const GtkTextIter *start,
2629 const GtkTextIter *end)
2633 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2634 g_return_if_fail (name != NULL);
2635 g_return_if_fail (start != NULL);
2636 g_return_if_fail (end != NULL);
2637 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2638 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2640 tag = gtk_text_tag_table_lookup (get_table (buffer),
2645 g_warning ("Unknown tag `%s'", name);
2649 gtk_text_buffer_emit_tag (buffer, tag, TRUE, start, end);
2653 * gtk_text_buffer_remove_tag_by_name:
2654 * @buffer: a #GtkTextBuffer
2655 * @name: name of a #GtkTextTag
2656 * @start: one bound of range to be untagged
2657 * @end: other bound of range to be untagged
2659 * Calls gtk_text_tag_table_lookup() on the buffer's tag table to
2660 * get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
2663 gtk_text_buffer_remove_tag_by_name (GtkTextBuffer *buffer,
2665 const GtkTextIter *start,
2666 const GtkTextIter *end)
2670 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2671 g_return_if_fail (name != NULL);
2672 g_return_if_fail (start != NULL);
2673 g_return_if_fail (end != NULL);
2674 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2675 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2677 tag = gtk_text_tag_table_lookup (get_table (buffer),
2682 g_warning ("Unknown tag `%s'", name);
2686 gtk_text_buffer_emit_tag (buffer, tag, FALSE, start, end);
2690 pointer_cmp (gconstpointer a,
2702 * gtk_text_buffer_remove_all_tags:
2703 * @buffer: a #GtkTextBuffer
2704 * @start: one bound of range to be untagged
2705 * @end: other bound of range to be untagged
2707 * Removes all tags in the range between @start and @end. Be careful
2708 * with this function; it could remove tags added in code unrelated to
2709 * the code you're currently writing. That is, using this function is
2710 * probably a bad idea if you have two or more unrelated code sections
2714 gtk_text_buffer_remove_all_tags (GtkTextBuffer *buffer,
2715 const GtkTextIter *start,
2716 const GtkTextIter *end)
2718 GtkTextIter first, second, tmp;
2721 GSList *prev, *next;
2724 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2725 g_return_if_fail (start != NULL);
2726 g_return_if_fail (end != NULL);
2727 g_return_if_fail (gtk_text_iter_get_buffer (start) == buffer);
2728 g_return_if_fail (gtk_text_iter_get_buffer (end) == buffer);
2733 gtk_text_iter_order (&first, &second);
2735 /* Get all tags turned on at the start */
2736 tags = gtk_text_iter_get_tags (&first);
2738 /* Find any that are toggled on within the range */
2740 while (gtk_text_iter_forward_to_tag_toggle (&tmp, NULL))
2745 if (gtk_text_iter_compare (&tmp, &second) >= 0)
2746 break; /* past the end of the range */
2748 toggled = gtk_text_iter_get_toggled_tags (&tmp, TRUE);
2750 /* We could end up with a really big-ass list here.
2753 tmp_list2 = toggled;
2754 while (tmp_list2 != NULL)
2756 tags = g_slist_prepend (tags, tmp_list2->data);
2758 tmp_list2 = g_slist_next (tmp_list2);
2761 g_slist_free (toggled);
2765 tags = g_slist_sort (tags, pointer_cmp);
2767 /* Strip duplicates */
2771 while (tmp_list != NULL)
2773 if (tag == tmp_list->data)
2776 next = tmp_list->next;
2780 tmp_list->next = NULL;
2782 g_slist_free (tmp_list);
2785 /* prev is unchanged */
2789 /* not a duplicate */
2790 tag = GTK_TEXT_TAG (tmp_list->data);
2792 tmp_list = tmp_list->next;
2796 g_slist_foreach (tags, (GFunc) g_object_ref, NULL);
2799 while (tmp_list != NULL)
2801 tag = GTK_TEXT_TAG (tmp_list->data);
2803 gtk_text_buffer_remove_tag (buffer, tag, &first, &second);
2805 tmp_list = tmp_list->next;
2808 g_slist_foreach (tags, (GFunc) g_object_unref, NULL);
2810 g_slist_free (tags);
2815 * Obtain various iterators
2819 * gtk_text_buffer_get_iter_at_line_offset:
2820 * @buffer: a #GtkTextBuffer
2821 * @iter: iterator to initialize
2822 * @line_number: line number counting from 0
2823 * @char_offset: char offset from start of line
2825 * Obtains an iterator pointing to @char_offset within the given
2826 * line. The @char_offset must exist, offsets off the end of the line
2827 * are not allowed. Note <emphasis>characters</emphasis>, not bytes;
2828 * UTF-8 may encode one character as multiple bytes.
2831 gtk_text_buffer_get_iter_at_line_offset (GtkTextBuffer *buffer,
2836 g_return_if_fail (iter != NULL);
2837 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2839 _gtk_text_btree_get_iter_at_line_char (get_btree (buffer),
2840 iter, line_number, char_offset);
2844 * gtk_text_buffer_get_iter_at_line_index:
2845 * @buffer: a #GtkTextBuffer
2846 * @iter: iterator to initialize
2847 * @line_number: line number counting from 0
2848 * @byte_index: byte index from start of line
2850 * Obtains an iterator pointing to @byte_index within the given line.
2851 * @byte_index must be the start of a UTF-8 character, and must not be
2852 * beyond the end of the line. Note <emphasis>bytes</emphasis>, not
2853 * characters; UTF-8 may encode one character as multiple bytes.
2856 gtk_text_buffer_get_iter_at_line_index (GtkTextBuffer *buffer,
2861 g_return_if_fail (iter != NULL);
2862 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2864 _gtk_text_btree_get_iter_at_line_byte (get_btree (buffer),
2865 iter, line_number, byte_index);
2869 * gtk_text_buffer_get_iter_at_line:
2870 * @buffer: a #GtkTextBuffer
2871 * @iter: iterator to initialize
2872 * @line_number: line number counting from 0
2874 * Initializes @iter to the start of the given line.
2877 gtk_text_buffer_get_iter_at_line (GtkTextBuffer *buffer,
2881 g_return_if_fail (iter != NULL);
2882 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2884 gtk_text_buffer_get_iter_at_line_offset (buffer, iter, line_number, 0);
2888 * gtk_text_buffer_get_iter_at_offset:
2889 * @buffer: a #GtkTextBuffer
2890 * @iter: iterator to initialize
2891 * @char_offset: char offset from start of buffer, counting from 0, or -1
2893 * Initializes @iter to a position @char_offset chars from the start
2894 * of the entire buffer. If @char_offset is -1 or greater than the number
2895 * of characters in the buffer, @iter is initialized to the end iterator,
2896 * the iterator one past the last valid character in the buffer.
2899 gtk_text_buffer_get_iter_at_offset (GtkTextBuffer *buffer,
2903 g_return_if_fail (iter != NULL);
2904 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2906 _gtk_text_btree_get_iter_at_char (get_btree (buffer), iter, char_offset);
2910 * gtk_text_buffer_get_start_iter:
2911 * @buffer: a #GtkTextBuffer
2912 * @iter: iterator to initialize
2914 * Initialized @iter with the first position in the text buffer. This
2915 * is the same as using gtk_text_buffer_get_iter_at_offset() to get
2916 * the iter at character offset 0.
2919 gtk_text_buffer_get_start_iter (GtkTextBuffer *buffer,
2922 g_return_if_fail (iter != NULL);
2923 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2925 _gtk_text_btree_get_iter_at_char (get_btree (buffer), iter, 0);
2929 * gtk_text_buffer_get_end_iter:
2930 * @buffer: a #GtkTextBuffer
2931 * @iter: iterator to initialize
2933 * Initializes @iter with the "end iterator," one past the last valid
2934 * character in the text buffer. If dereferenced with
2935 * gtk_text_iter_get_char(), the end iterator has a character value of
2936 * 0. The entire buffer lies in the range from the first position in
2937 * the buffer (call gtk_text_buffer_get_start_iter() to get
2938 * character position 0) to the end iterator.
2941 gtk_text_buffer_get_end_iter (GtkTextBuffer *buffer,
2944 g_return_if_fail (iter != NULL);
2945 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2947 _gtk_text_btree_get_end_iter (get_btree (buffer), iter);
2951 * gtk_text_buffer_get_bounds:
2952 * @buffer: a #GtkTextBuffer
2953 * @start: iterator to initialize with first position in the buffer
2954 * @end: iterator to initialize with the end iterator
2956 * Retrieves the first and last iterators in the buffer, i.e. the
2957 * entire buffer lies within the range [@start,@end).
2960 gtk_text_buffer_get_bounds (GtkTextBuffer *buffer,
2964 g_return_if_fail (start != NULL);
2965 g_return_if_fail (end != NULL);
2966 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
2968 _gtk_text_btree_get_iter_at_char (get_btree (buffer), start, 0);
2969 _gtk_text_btree_get_end_iter (get_btree (buffer), end);
2977 * gtk_text_buffer_get_modified:
2978 * @buffer: a #GtkTextBuffer
2980 * Indicates whether the buffer has been modified since the last call
2981 * to gtk_text_buffer_set_modified() set the modification flag to
2982 * %FALSE. Used for example to enable a "save" function in a text
2985 * Return value: %TRUE if the buffer has been modified
2988 gtk_text_buffer_get_modified (GtkTextBuffer *buffer)
2990 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
2992 return buffer->modified;
2996 * gtk_text_buffer_set_modified:
2997 * @buffer: a #GtkTextBuffer
2998 * @setting: modification flag setting
3000 * Used to keep track of whether the buffer has been modified since the
3001 * last time it was saved. Whenever the buffer is saved to disk, call
3002 * gtk_text_buffer_set_modified (@buffer, FALSE). When the buffer is modified,
3003 * it will automatically toggled on the modified bit again. When the modified
3004 * bit flips, the buffer emits a "modified_changed" signal.
3007 gtk_text_buffer_set_modified (GtkTextBuffer *buffer,
3010 gboolean fixed_setting;
3012 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
3014 fixed_setting = setting != FALSE;
3016 if (buffer->modified == fixed_setting)
3020 buffer->modified = fixed_setting;
3021 g_signal_emit (buffer, signals[MODIFIED_CHANGED], 0);
3026 * gtk_text_buffer_get_has_selection:
3027 * @buffer: a #GtkTextBuffer
3029 * Indicates whether the buffer has some text currently selected.
3031 * Return value: %TRUE if the there is text selected
3036 gtk_text_buffer_get_has_selection (GtkTextBuffer *buffer)
3038 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
3040 return buffer->has_selection;
3045 * Assorted other stuff
3049 * gtk_text_buffer_get_line_count:
3050 * @buffer: a #GtkTextBuffer
3052 * Obtains the number of lines in the buffer. This value is cached, so
3053 * the function is very fast.
3055 * Return value: number of lines in the buffer
3058 gtk_text_buffer_get_line_count (GtkTextBuffer *buffer)
3060 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), 0);
3062 return _gtk_text_btree_line_count (get_btree (buffer));
3066 * gtk_text_buffer_get_char_count:
3067 * @buffer: a #GtkTextBuffer
3069 * Gets the number of characters in the buffer; note that characters
3070 * and bytes are not the same, you can't e.g. expect the contents of
3071 * the buffer in string form to be this many bytes long. The character
3072 * count is cached, so this function is very fast.
3074 * Return value: number of characters in the buffer
3077 gtk_text_buffer_get_char_count (GtkTextBuffer *buffer)
3079 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), 0);
3081 return _gtk_text_btree_char_count (get_btree (buffer));
3084 /* Called when we lose the primary selection.
3087 clipboard_clear_selection_cb (GtkClipboard *clipboard,
3090 /* Move selection_bound to the insertion point */
3092 GtkTextIter selection_bound;
3093 GtkTextBuffer *buffer = GTK_TEXT_BUFFER (data);
3095 gtk_text_buffer_get_iter_at_mark (buffer, &insert,
3096 gtk_text_buffer_get_mark (buffer, "insert"));
3097 gtk_text_buffer_get_iter_at_mark (buffer, &selection_bound,
3098 gtk_text_buffer_get_mark (buffer, "selection_bound"));
3100 if (!gtk_text_iter_equal (&insert, &selection_bound))
3101 gtk_text_buffer_move_mark (buffer,
3102 gtk_text_buffer_get_mark (buffer, "selection_bound"),
3106 /* Called when we have the primary selection and someone else wants our
3107 * data in order to paste it.
3110 clipboard_get_selection_cb (GtkClipboard *clipboard,
3111 GtkSelectionData *selection_data,
3115 GtkTextBuffer *buffer = GTK_TEXT_BUFFER (data);
3116 GtkTextIter start, end;
3118 if (gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3120 if (info == GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS)
3122 /* Provide the address of the buffer; this will only be
3123 * used within-process
3125 gtk_selection_data_set (selection_data,
3126 selection_data->target,
3131 else if (info == GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT)
3136 str = gtk_text_buffer_serialize (buffer, buffer,
3137 selection_data->target,
3138 &start, &end, &len);
3140 gtk_selection_data_set (selection_data,
3141 selection_data->target,
3150 str = gtk_text_iter_get_visible_text (&start, &end);
3151 gtk_selection_data_set_text (selection_data, str, -1);
3157 static GtkTextBuffer *
3158 create_clipboard_contents_buffer (GtkTextBuffer *buffer)
3160 GtkTextBuffer *contents;
3162 contents = gtk_text_buffer_new (gtk_text_buffer_get_tag_table (buffer));
3164 g_object_set_data (G_OBJECT (contents), I_("gtk-text-buffer-clipboard-source"),
3166 g_object_set_data (G_OBJECT (contents), I_("gtk-text-buffer-clipboard"),
3167 GINT_TO_POINTER (1));
3169 /* Ref the source buffer as long as the clipboard contents buffer
3170 * exists, because it's needed for serializing the contents buffer.
3171 * See http://bugzilla.gnome.org/show_bug.cgi?id=339195
3173 g_object_ref (buffer);
3174 g_object_weak_ref (G_OBJECT (contents), (GWeakNotify) g_object_unref, buffer);
3179 /* Provide cut/copied data */
3181 clipboard_get_contents_cb (GtkClipboard *clipboard,
3182 GtkSelectionData *selection_data,
3186 GtkTextBuffer *contents = GTK_TEXT_BUFFER (data);
3188 g_assert (contents); /* This should never be called unless we own the clipboard */
3190 if (info == GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS)
3192 /* Provide the address of the clipboard buffer; this will only
3193 * be used within-process. OK to supply a NULL value for contents.
3195 gtk_selection_data_set (selection_data,
3196 selection_data->target,
3201 else if (info == GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT)
3203 GtkTextBuffer *clipboard_source_buffer;
3204 GtkTextIter start, end;
3208 clipboard_source_buffer = g_object_get_data (G_OBJECT (contents),
3209 "gtk-text-buffer-clipboard-source");
3211 gtk_text_buffer_get_bounds (contents, &start, &end);
3213 str = gtk_text_buffer_serialize (clipboard_source_buffer, contents,
3214 selection_data->target,
3215 &start, &end, &len);
3217 gtk_selection_data_set (selection_data,
3218 selection_data->target,
3226 GtkTextIter start, end;
3228 gtk_text_buffer_get_bounds (contents, &start, &end);
3230 str = gtk_text_iter_get_visible_text (&start, &end);
3231 gtk_selection_data_set_text (selection_data, str, -1);
3237 clipboard_clear_contents_cb (GtkClipboard *clipboard,
3240 GtkTextBuffer *contents = GTK_TEXT_BUFFER (data);
3242 g_object_unref (contents);
3246 get_paste_point (GtkTextBuffer *buffer,
3248 gboolean clear_afterward)
3250 GtkTextIter insert_point;
3251 GtkTextMark *paste_point_override;
3253 paste_point_override = gtk_text_buffer_get_mark (buffer,
3254 "gtk_paste_point_override");
3256 if (paste_point_override != NULL)
3258 gtk_text_buffer_get_iter_at_mark (buffer, &insert_point,
3259 paste_point_override);
3260 if (clear_afterward)
3261 gtk_text_buffer_delete_mark (buffer,
3262 gtk_text_buffer_get_mark (buffer,
3263 "gtk_paste_point_override"));
3267 gtk_text_buffer_get_iter_at_mark (buffer, &insert_point,
3268 gtk_text_buffer_get_mark (buffer,
3272 *iter = insert_point;
3276 pre_paste_prep (ClipboardRequest *request_data,
3277 GtkTextIter *insert_point)
3279 GtkTextBuffer *buffer = request_data->buffer;
3281 get_paste_point (buffer, insert_point, TRUE);
3283 /* If we're going to replace the selection, we insert before it to
3284 * avoid messing it up, then we delete the selection after inserting.
3286 if (request_data->replace_selection)
3288 GtkTextIter start, end;
3290 if (gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3291 *insert_point = start;
3296 post_paste_cleanup (ClipboardRequest *request_data)
3298 if (request_data->replace_selection)
3300 GtkTextIter start, end;
3302 if (gtk_text_buffer_get_selection_bounds (request_data->buffer,
3305 if (request_data->interactive)
3306 gtk_text_buffer_delete_interactive (request_data->buffer,
3309 request_data->default_editable);
3311 gtk_text_buffer_delete (request_data->buffer, &start, &end);
3317 free_clipboard_request (ClipboardRequest *request_data)
3319 g_object_unref (request_data->buffer);
3320 g_free (request_data);
3323 /* Called when we request a paste and receive the text data
3326 clipboard_text_received (GtkClipboard *clipboard,
3330 ClipboardRequest *request_data = data;
3331 GtkTextBuffer *buffer = request_data->buffer;
3335 GtkTextIter insert_point;
3337 if (request_data->interactive)
3338 gtk_text_buffer_begin_user_action (buffer);
3340 pre_paste_prep (request_data, &insert_point);
3342 if (request_data->interactive)
3343 gtk_text_buffer_insert_interactive (buffer, &insert_point,
3344 str, -1, request_data->default_editable);
3346 gtk_text_buffer_insert (buffer, &insert_point,
3349 post_paste_cleanup (request_data);
3351 if (request_data->interactive)
3352 gtk_text_buffer_end_user_action (buffer);
3355 free_clipboard_request (request_data);
3358 static GtkTextBuffer*
3359 selection_data_get_buffer (GtkSelectionData *selection_data,
3360 ClipboardRequest *request_data)
3363 GtkTextBuffer *src_buffer = NULL;
3365 /* If we can get the owner, the selection is in-process */
3366 owner = gdk_selection_owner_get_for_display (selection_data->display,
3367 selection_data->selection);
3372 if (gdk_window_get_window_type (owner) == GDK_WINDOW_FOREIGN)
3375 if (selection_data->type !=
3376 gdk_atom_intern_static_string ("GTK_TEXT_BUFFER_CONTENTS"))
3379 if (selection_data->length != sizeof (src_buffer))
3382 memcpy (&src_buffer, selection_data->data, sizeof (src_buffer));
3384 if (src_buffer == NULL)
3387 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (src_buffer), NULL);
3389 if (gtk_text_buffer_get_tag_table (src_buffer) !=
3390 gtk_text_buffer_get_tag_table (request_data->buffer))
3397 /* These are pretty handy functions; maybe something like them
3398 * should be in the public API. Also, there are other places in this
3399 * file where they could be used.
3402 save_iter (const GtkTextIter *iter,
3403 gboolean left_gravity)
3405 return gtk_text_buffer_create_mark (gtk_text_iter_get_buffer (iter),
3412 restore_iter (const GtkTextIter *iter,
3415 gtk_text_buffer_get_iter_at_mark (gtk_text_mark_get_buffer (save_id),
3416 (GtkTextIter*) iter,
3418 gtk_text_buffer_delete_mark (gtk_text_mark_get_buffer (save_id),
3424 clipboard_rich_text_received (GtkClipboard *clipboard,
3430 ClipboardRequest *request_data = data;
3431 GtkTextIter insert_point;
3432 gboolean retval = TRUE;
3433 GError *error = NULL;
3435 if (text != NULL && length > 0)
3437 pre_paste_prep (request_data, &insert_point);
3439 if (request_data->interactive)
3440 gtk_text_buffer_begin_user_action (request_data->buffer);
3442 if (!request_data->interactive ||
3443 gtk_text_iter_can_insert (&insert_point,
3444 request_data->default_editable))
3446 retval = gtk_text_buffer_deserialize (request_data->buffer,
3447 request_data->buffer,
3456 g_warning ("error pasting: %s\n", error->message);
3457 g_clear_error (&error);
3460 if (request_data->interactive)
3461 gtk_text_buffer_end_user_action (request_data->buffer);
3465 post_paste_cleanup (request_data);
3470 /* Request the text selection instead */
3471 gtk_clipboard_request_text (clipboard,
3472 clipboard_text_received,
3477 paste_from_buffer (ClipboardRequest *request_data,
3478 GtkTextBuffer *src_buffer,
3479 const GtkTextIter *start,
3480 const GtkTextIter *end)
3482 GtkTextIter insert_point;
3483 GtkTextBuffer *buffer = request_data->buffer;
3485 /* We're about to emit a bunch of signals, so be safe */
3486 g_object_ref (src_buffer);
3488 pre_paste_prep (request_data, &insert_point);
3490 if (request_data->interactive)
3491 gtk_text_buffer_begin_user_action (buffer);
3493 if (!gtk_text_iter_equal (start, end))
3495 if (!request_data->interactive ||
3496 (gtk_text_iter_can_insert (&insert_point,
3497 request_data->default_editable)))
3498 gtk_text_buffer_real_insert_range (buffer,
3502 request_data->interactive);
3505 post_paste_cleanup (request_data);
3507 if (request_data->interactive)
3508 gtk_text_buffer_end_user_action (buffer);
3510 g_object_unref (src_buffer);
3512 free_clipboard_request (request_data);
3516 clipboard_clipboard_buffer_received (GtkClipboard *clipboard,
3517 GtkSelectionData *selection_data,
3520 ClipboardRequest *request_data = data;
3521 GtkTextBuffer *src_buffer;
3523 src_buffer = selection_data_get_buffer (selection_data, request_data);
3527 GtkTextIter start, end;
3529 if (g_object_get_data (G_OBJECT (src_buffer), "gtk-text-buffer-clipboard"))
3531 gtk_text_buffer_get_bounds (src_buffer, &start, &end);
3533 paste_from_buffer (request_data, src_buffer,
3538 if (gtk_text_buffer_get_selection_bounds (src_buffer, &start, &end))
3539 paste_from_buffer (request_data, src_buffer,
3545 if (gtk_clipboard_wait_is_rich_text_available (clipboard,
3546 request_data->buffer))
3548 /* Request rich text */
3549 gtk_clipboard_request_rich_text (clipboard,
3550 request_data->buffer,
3551 clipboard_rich_text_received,
3556 /* Request the text selection instead */
3557 gtk_clipboard_request_text (clipboard,
3558 clipboard_text_received,
3566 GtkClipboard *clipboard;
3568 } SelectionClipboard;
3571 update_selection_clipboards (GtkTextBuffer *buffer)
3573 GtkTextBufferPrivate *priv;
3574 GSList *tmp_list = buffer->selection_clipboards;
3576 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
3578 gtk_text_buffer_get_copy_target_list (buffer);
3585 SelectionClipboard *selection_clipboard = tmp_list->data;
3586 GtkClipboard *clipboard = selection_clipboard->clipboard;
3588 /* Determine whether we have a selection and adjust X selection
3591 if (!gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3593 if (gtk_clipboard_get_owner (clipboard) == G_OBJECT (buffer))
3594 gtk_clipboard_clear (clipboard);
3598 /* Even if we already have the selection, we need to update our
3601 if (!gtk_clipboard_set_with_owner (clipboard,
3602 priv->copy_target_entries,
3603 priv->n_copy_target_entries,
3604 clipboard_get_selection_cb,
3605 clipboard_clear_selection_cb,
3607 clipboard_clear_selection_cb (clipboard, buffer);
3610 tmp_list = tmp_list->next;
3614 static SelectionClipboard *
3615 find_selection_clipboard (GtkTextBuffer *buffer,
3616 GtkClipboard *clipboard)
3618 GSList *tmp_list = buffer->selection_clipboards;
3621 SelectionClipboard *selection_clipboard = tmp_list->data;
3622 if (selection_clipboard->clipboard == clipboard)
3623 return selection_clipboard;
3625 tmp_list = tmp_list->next;
3632 * gtk_text_buffer_add_selection_clipboard:
3633 * @buffer: a #GtkTextBuffer
3634 * @clipboard: a #GtkClipboard
3636 * Adds @clipboard to the list of clipboards in which the selection
3637 * contents of @buffer are available. In most cases, @clipboard will be
3638 * the #GtkClipboard of type %GDK_SELECTION_PRIMARY for a view of @buffer.
3641 gtk_text_buffer_add_selection_clipboard (GtkTextBuffer *buffer,
3642 GtkClipboard *clipboard)
3644 SelectionClipboard *selection_clipboard;
3646 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
3647 g_return_if_fail (clipboard != NULL);
3649 selection_clipboard = find_selection_clipboard (buffer, clipboard);
3650 if (selection_clipboard)
3652 selection_clipboard->ref_count++;
3656 selection_clipboard = g_new (SelectionClipboard, 1);
3658 selection_clipboard->clipboard = clipboard;
3659 selection_clipboard->ref_count = 1;
3661 buffer->selection_clipboards = g_slist_prepend (buffer->selection_clipboards, selection_clipboard);
3666 * gtk_text_buffer_remove_selection_clipboard:
3667 * @buffer: a #GtkTextBuffer
3668 * @clipboard: a #GtkClipboard added to @buffer by
3669 * gtk_text_buffer_add_selection_clipboard()
3671 * Removes a #GtkClipboard added with
3672 * gtk_text_buffer_add_selection_clipboard().
3675 gtk_text_buffer_remove_selection_clipboard (GtkTextBuffer *buffer,
3676 GtkClipboard *clipboard)
3678 SelectionClipboard *selection_clipboard;
3680 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
3681 g_return_if_fail (clipboard != NULL);
3683 selection_clipboard = find_selection_clipboard (buffer, clipboard);
3684 g_return_if_fail (selection_clipboard != NULL);
3686 selection_clipboard->ref_count--;
3687 if (selection_clipboard->ref_count == 0)
3689 if (gtk_clipboard_get_owner (selection_clipboard->clipboard) == G_OBJECT (buffer))
3690 gtk_clipboard_clear (selection_clipboard->clipboard);
3692 buffer->selection_clipboards = g_slist_remove (buffer->selection_clipboards,
3693 selection_clipboard);
3695 g_free (selection_clipboard);
3700 remove_all_selection_clipboards (GtkTextBuffer *buffer)
3702 g_slist_foreach (buffer->selection_clipboards, (GFunc)g_free, NULL);
3703 g_slist_free (buffer->selection_clipboards);
3704 buffer->selection_clipboards = NULL;
3708 * gtk_text_buffer_paste_clipboard:
3709 * @buffer: a #GtkTextBuffer
3710 * @clipboard: the #GtkClipboard to paste from
3711 * @override_location: location to insert pasted text, or %NULL for
3713 * @default_editable: whether the buffer is editable by default
3715 * Pastes the contents of a clipboard at the insertion point, or at
3716 * @override_location. (Note: pasting is asynchronous, that is, we'll
3717 * ask for the paste data and return, and at some point later after
3718 * the main loop runs, the paste data will be inserted.)
3721 gtk_text_buffer_paste_clipboard (GtkTextBuffer *buffer,
3722 GtkClipboard *clipboard,
3723 GtkTextIter *override_location,
3724 gboolean default_editable)
3726 ClipboardRequest *data = g_new (ClipboardRequest, 1);
3727 GtkTextIter paste_point;
3728 GtkTextIter start, end;
3730 if (override_location != NULL)
3731 gtk_text_buffer_create_mark (buffer,
3732 "gtk_paste_point_override",
3733 override_location, FALSE);
3735 data->buffer = g_object_ref (buffer);
3736 data->interactive = TRUE;
3737 data->default_editable = default_editable;
3739 /* When pasting with the cursor inside the selection area, you
3740 * replace the selection with the new text, otherwise, you
3741 * simply insert the new text at the point where the click
3742 * occured, unselecting any selected text. The replace_selection
3743 * flag toggles this behavior.
3745 data->replace_selection = FALSE;
3747 get_paste_point (buffer, &paste_point, FALSE);
3748 if (gtk_text_buffer_get_selection_bounds (buffer, &start, &end) &&
3749 (gtk_text_iter_in_range (&paste_point, &start, &end) ||
3750 gtk_text_iter_equal (&paste_point, &end)))
3751 data->replace_selection = TRUE;
3753 gtk_clipboard_request_contents (clipboard,
3754 gdk_atom_intern_static_string ("GTK_TEXT_BUFFER_CONTENTS"),
3755 clipboard_clipboard_buffer_received, data);
3759 * gtk_text_buffer_delete_selection:
3760 * @buffer: a #GtkTextBuffer
3761 * @interactive: whether the deletion is caused by user interaction
3762 * @default_editable: whether the buffer is editable by default
3764 * Deletes the range between the "insert" and "selection_bound" marks,
3765 * that is, the currently-selected text. If @interactive is %TRUE,
3766 * the editability of the selection will be considered (users can't delete
3769 * Return value: whether there was a non-empty selection to delete
3772 gtk_text_buffer_delete_selection (GtkTextBuffer *buffer,
3773 gboolean interactive,
3774 gboolean default_editable)
3779 if (!gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3781 return FALSE; /* No selection */
3787 gtk_text_buffer_begin_user_action (buffer);
3788 gtk_text_buffer_delete_interactive (buffer, &start, &end, default_editable);
3789 gtk_text_buffer_end_user_action (buffer);
3792 gtk_text_buffer_delete (buffer, &start, &end);
3794 return TRUE; /* We deleted stuff */
3799 * gtk_text_buffer_backspace:
3800 * @buffer: a #GtkTextBuffer
3801 * @iter: a position in @buffer
3802 * @interactive: whether the deletion is caused by user interaction
3803 * @default_editable: whether the buffer is editable by default
3805 * Performs the appropriate action as if the user hit the delete
3806 * key with the cursor at the position specified by @iter. In the
3807 * normal case a single character will be deleted, but when
3808 * combining accents are involved, more than one character can
3809 * be deleted, and when precomposed character and accent combinations
3810 * are involved, less than one character will be deleted.
3812 * Because the buffer is modified, all outstanding iterators become
3813 * invalid after calling this function; however, the @iter will be
3814 * re-initialized to point to the location where text was deleted.
3816 * Return value: %TRUE if the buffer was modified
3821 gtk_text_buffer_backspace (GtkTextBuffer *buffer,
3823 gboolean interactive,
3824 gboolean default_editable)
3826 gchar *cluster_text;
3829 gboolean retval = FALSE;
3830 const PangoLogAttr *attrs;
3832 gboolean backspace_deletes_character;
3834 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
3835 g_return_val_if_fail (iter != NULL, FALSE);
3840 attrs = _gtk_text_buffer_get_line_log_attrs (buffer, &start, NULL);
3842 /* For no good reason, attrs is NULL for the empty last line in
3843 * a buffer. Special case that here. (#156164)
3847 offset = gtk_text_iter_get_line_offset (&start);
3848 backspace_deletes_character = attrs[offset].backspace_deletes_character;
3851 backspace_deletes_character = FALSE;
3853 gtk_text_iter_backward_cursor_position (&start);
3855 if (gtk_text_iter_equal (&start, &end))
3858 cluster_text = gtk_text_iter_get_text (&start, &end);
3861 gtk_text_buffer_begin_user_action (buffer);
3863 if (gtk_text_buffer_delete_interactive (buffer, &start, &end,
3866 if (backspace_deletes_character)
3868 gchar *normalized_text = g_utf8_normalize (cluster_text,
3869 strlen (cluster_text),
3871 glong len = g_utf8_strlen (normalized_text, -1);
3874 gtk_text_buffer_insert_interactive (buffer,
3877 g_utf8_offset_to_pointer (normalized_text, len - 1) - normalized_text,
3880 g_free (normalized_text);
3887 gtk_text_buffer_end_user_action (buffer);
3889 g_free (cluster_text);
3891 /* Revalidate the users iter */
3898 cut_or_copy (GtkTextBuffer *buffer,
3899 GtkClipboard *clipboard,
3900 gboolean delete_region_after,
3901 gboolean interactive,
3902 gboolean default_editable)
3904 GtkTextBufferPrivate *priv;
3906 /* We prefer to cut the selected region between selection_bound and
3907 * insertion point. If that region is empty, then we cut the region
3908 * between the "anchor" and the insertion point (this is for
3909 * C-space and M-w and other Emacs-style copy/yank keys). Note that
3910 * insert and selection_bound are guaranteed to exist, but the
3911 * anchor only exists sometimes.
3916 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
3918 gtk_text_buffer_get_copy_target_list (buffer);
3920 if (!gtk_text_buffer_get_selection_bounds (buffer, &start, &end))
3922 /* Let's try the anchor thing */
3923 GtkTextMark * anchor = gtk_text_buffer_get_mark (buffer, "anchor");
3929 gtk_text_buffer_get_iter_at_mark (buffer, &end, anchor);
3930 gtk_text_iter_order (&start, &end);
3934 if (!gtk_text_iter_equal (&start, &end))
3937 GtkTextBuffer *contents;
3939 contents = create_clipboard_contents_buffer (buffer);
3941 gtk_text_buffer_get_iter_at_offset (contents, &ins, 0);
3943 gtk_text_buffer_insert_range (contents, &ins, &start, &end);
3945 if (!gtk_clipboard_set_with_data (clipboard,
3946 priv->copy_target_entries,
3947 priv->n_copy_target_entries,
3948 clipboard_get_contents_cb,
3949 clipboard_clear_contents_cb,
3951 g_object_unref (contents);
3953 gtk_clipboard_set_can_store (clipboard,
3954 priv->copy_target_entries + 1,
3955 priv->n_copy_target_entries - 1);
3957 if (delete_region_after)
3960 gtk_text_buffer_delete_interactive (buffer, &start, &end,
3963 gtk_text_buffer_delete (buffer, &start, &end);
3969 * gtk_text_buffer_cut_clipboard:
3970 * @buffer: a #GtkTextBuffer
3971 * @clipboard: the #GtkClipboard object to cut to
3972 * @default_editable: default editability of the buffer
3974 * Copies the currently-selected text to a clipboard, then deletes
3975 * said text if it's editable.
3978 gtk_text_buffer_cut_clipboard (GtkTextBuffer *buffer,
3979 GtkClipboard *clipboard,
3980 gboolean default_editable)
3982 gtk_text_buffer_begin_user_action (buffer);
3983 cut_or_copy (buffer, clipboard, TRUE, TRUE, default_editable);
3984 gtk_text_buffer_end_user_action (buffer);
3988 * gtk_text_buffer_copy_clipboard:
3989 * @buffer: a #GtkTextBuffer
3990 * @clipboard: the #GtkClipboard object to copy to
3992 * Copies the currently-selected text to a clipboard.
3995 gtk_text_buffer_copy_clipboard (GtkTextBuffer *buffer,
3996 GtkClipboard *clipboard)
3998 gtk_text_buffer_begin_user_action (buffer);
3999 cut_or_copy (buffer, clipboard, FALSE, TRUE, TRUE);
4000 gtk_text_buffer_end_user_action (buffer);
4005 * gtk_text_buffer_get_selection_bounds:
4006 * @buffer: a #GtkTextBuffer a #GtkTextBuffer
4007 * @start: iterator to initialize with selection start
4008 * @end: iterator to initialize with selection end
4010 * Returns %TRUE if some text is selected; places the bounds
4011 * of the selection in @start and @end (if the selection has length 0,
4012 * then @start and @end are filled in with the same value).
4013 * @start and @end will be in ascending order. If @start and @end are
4014 * NULL, then they are not filled in, but the return value still indicates
4015 * whether text is selected.
4017 * Return value: whether the selection has nonzero length
4020 gtk_text_buffer_get_selection_bounds (GtkTextBuffer *buffer,
4024 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
4026 return _gtk_text_btree_get_selection_bounds (get_btree (buffer), start, end);
4030 * gtk_text_buffer_begin_user_action:
4031 * @buffer: a #GtkTextBuffer
4033 * Called to indicate that the buffer operations between here and a
4034 * call to gtk_text_buffer_end_user_action() are part of a single
4035 * user-visible operation. The operations between
4036 * gtk_text_buffer_begin_user_action() and
4037 * gtk_text_buffer_end_user_action() can then be grouped when creating
4038 * an undo stack. #GtkTextBuffer maintains a count of calls to
4039 * gtk_text_buffer_begin_user_action() that have not been closed with
4040 * a call to gtk_text_buffer_end_user_action(), and emits the
4041 * "begin_user_action" and "end_user_action" signals only for the
4042 * outermost pair of calls. This allows you to build user actions
4043 * from other user actions.
4045 * The "interactive" buffer mutation functions, such as
4046 * gtk_text_buffer_insert_interactive(), automatically call begin/end
4047 * user action around the buffer operations they perform, so there's
4048 * no need to add extra calls if you user action consists solely of a
4049 * single call to one of those functions.
4052 gtk_text_buffer_begin_user_action (GtkTextBuffer *buffer)
4054 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
4056 buffer->user_action_count += 1;
4058 if (buffer->user_action_count == 1)
4060 /* Outermost nested user action begin emits the signal */
4061 g_signal_emit (buffer, signals[BEGIN_USER_ACTION], 0);
4066 * gtk_text_buffer_end_user_action:
4067 * @buffer: a #GtkTextBuffer
4069 * Should be paired with a call to gtk_text_buffer_begin_user_action().
4070 * See that function for a full explanation.
4073 gtk_text_buffer_end_user_action (GtkTextBuffer *buffer)
4075 g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
4076 g_return_if_fail (buffer->user_action_count > 0);
4078 buffer->user_action_count -= 1;
4080 if (buffer->user_action_count == 0)
4082 /* Ended the outermost-nested user action end, so emit the signal */
4083 g_signal_emit (buffer, signals[END_USER_ACTION], 0);
4088 gtk_text_buffer_free_target_lists (GtkTextBuffer *buffer)
4090 GtkTextBufferPrivate *priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
4092 if (priv->copy_target_list)
4094 gtk_target_list_unref (priv->copy_target_list);
4095 priv->copy_target_list = NULL;
4097 gtk_target_table_free (priv->copy_target_entries,
4098 priv->n_copy_target_entries);
4099 priv->copy_target_entries = NULL;
4100 priv->n_copy_target_entries = 0;
4103 if (priv->paste_target_list)
4105 gtk_target_list_unref (priv->paste_target_list);
4106 priv->paste_target_list = NULL;
4108 gtk_target_table_free (priv->paste_target_entries,
4109 priv->n_paste_target_entries);
4110 priv->paste_target_entries = NULL;
4111 priv->n_paste_target_entries = 0;
4115 static GtkTargetList *
4116 gtk_text_buffer_get_target_list (GtkTextBuffer *buffer,
4117 gboolean deserializable,
4118 GtkTargetEntry **entries,
4121 GtkTargetList *target_list;
4123 target_list = gtk_target_list_new (NULL, 0);
4125 gtk_target_list_add (target_list,
4126 gdk_atom_intern_static_string ("GTK_TEXT_BUFFER_CONTENTS"),
4127 GTK_TARGET_SAME_APP,
4128 GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS);
4130 gtk_target_list_add_rich_text_targets (target_list,
4131 GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT,
4135 gtk_target_list_add_text_targets (target_list,
4136 GTK_TEXT_BUFFER_TARGET_INFO_TEXT);
4138 *entries = gtk_target_table_new_from_list (target_list, n_entries);
4144 * gtk_text_buffer_get_copy_target_list:
4145 * @buffer: a #GtkTextBuffer
4147 * This function returns the list of targets this text buffer can
4148 * provide for copying and as DND source. The targets in the list are
4149 * added with %info values from the #GtkTextBufferTargetInfo enum,
4150 * using gtk_target_list_add_rich_text_targets() and
4151 * gtk_target_list_add_text_targets().
4153 * Return value: the #GtkTargetList
4158 gtk_text_buffer_get_copy_target_list (GtkTextBuffer *buffer)
4160 GtkTextBufferPrivate *priv;
4162 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
4164 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
4166 if (! priv->copy_target_list)
4167 priv->copy_target_list =
4168 gtk_text_buffer_get_target_list (buffer, FALSE,
4169 &priv->copy_target_entries,
4170 &priv->n_copy_target_entries);
4172 return priv->copy_target_list;
4176 * gtk_text_buffer_get_paste_target_list:
4177 * @buffer: a #GtkTextBuffer
4179 * This function returns the list of targets this text buffer supports
4180 * for pasting and as DND destination. The targets in the list are
4181 * added with %info values from the #GtkTextBufferTargetInfo enum,
4182 * using gtk_target_list_add_rich_text_targets() and
4183 * gtk_target_list_add_text_targets().
4185 * Return value: the #GtkTargetList
4190 gtk_text_buffer_get_paste_target_list (GtkTextBuffer *buffer)
4192 GtkTextBufferPrivate *priv;
4194 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
4196 priv = GTK_TEXT_BUFFER_GET_PRIVATE (buffer);
4198 if (! priv->paste_target_list)
4199 priv->paste_target_list =
4200 gtk_text_buffer_get_target_list (buffer, TRUE,
4201 &priv->paste_target_entries,
4202 &priv->n_paste_target_entries);
4204 return priv->paste_target_list;
4208 * Logical attribute cache
4211 #define ATTR_CACHE_SIZE 2
4213 typedef struct _CacheEntry CacheEntry;
4218 PangoLogAttr *attrs;
4222 struct _GtkTextLogAttrCache
4224 gint chars_changed_stamp;
4225 CacheEntry entries[ATTR_CACHE_SIZE];
4229 free_log_attr_cache (GtkTextLogAttrCache *cache)
4232 while (i < ATTR_CACHE_SIZE)
4234 g_free (cache->entries[i].attrs);
4241 clear_log_attr_cache (GtkTextLogAttrCache *cache)
4244 while (i < ATTR_CACHE_SIZE)
4246 g_free (cache->entries[i].attrs);
4247 cache->entries[i].attrs = NULL;
4252 static PangoLogAttr*
4253 compute_log_attrs (const GtkTextIter *iter,
4259 gint char_len, byte_len;
4260 PangoLogAttr *attrs = NULL;
4265 gtk_text_iter_set_line_offset (&start, 0);
4266 gtk_text_iter_forward_line (&end);
4268 paragraph = gtk_text_iter_get_slice (&start, &end);
4269 char_len = g_utf8_strlen (paragraph, -1);
4270 byte_len = strlen (paragraph);
4272 g_assert (char_len > 0);
4275 *char_lenp = char_len;
4277 attrs = g_new (PangoLogAttr, char_len + 1);
4279 /* FIXME we need to follow PangoLayout and allow different language
4280 * tags within the paragraph
4282 pango_get_log_attrs (paragraph, byte_len, -1,
4283 gtk_text_iter_get_language (&start),
4292 /* The return value from this is valid until you call this a second time.
4295 _gtk_text_buffer_get_line_log_attrs (GtkTextBuffer *buffer,
4296 const GtkTextIter *anywhere_in_line,
4300 GtkTextLogAttrCache *cache;
4303 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
4304 g_return_val_if_fail (anywhere_in_line != NULL, NULL);
4306 /* special-case for empty last line in buffer */
4307 if (gtk_text_iter_is_end (anywhere_in_line) &&
4308 gtk_text_iter_get_line_offset (anywhere_in_line) == 0)
4315 /* FIXME we also need to recompute log attrs if the language tag at
4316 * the start of a paragraph changes
4319 if (buffer->log_attr_cache == NULL)
4321 buffer->log_attr_cache = g_new0 (GtkTextLogAttrCache, 1);
4322 buffer->log_attr_cache->chars_changed_stamp =
4323 _gtk_text_btree_get_chars_changed_stamp (get_btree (buffer));
4325 else if (buffer->log_attr_cache->chars_changed_stamp !=
4326 _gtk_text_btree_get_chars_changed_stamp (get_btree (buffer)))
4328 clear_log_attr_cache (buffer->log_attr_cache);
4331 cache = buffer->log_attr_cache;
4332 line = gtk_text_iter_get_line (anywhere_in_line);
4335 while (i < ATTR_CACHE_SIZE)
4337 if (cache->entries[i].attrs &&
4338 cache->entries[i].line == line)
4341 *char_len = cache->entries[i].char_len;
4342 return cache->entries[i].attrs;
4347 /* Not in cache; open up the first cache entry */
4348 g_free (cache->entries[ATTR_CACHE_SIZE-1].attrs);
4350 g_memmove (cache->entries + 1, cache->entries,
4351 sizeof (CacheEntry) * (ATTR_CACHE_SIZE - 1));
4353 cache->entries[0].line = line;
4354 cache->entries[0].attrs = compute_log_attrs (anywhere_in_line,
4355 &cache->entries[0].char_len);
4358 *char_len = cache->entries[0].char_len;
4360 return cache->entries[0].attrs;
4364 _gtk_text_buffer_notify_will_remove_tag (GtkTextBuffer *buffer,
4367 /* This removes tag from the buffer, but DOESN'T emit the
4368 * remove_tag signal, because we can't afford to have user
4369 * code messing things up at this point; the tag MUST be removed
4373 _gtk_text_btree_notify_will_remove_tag (buffer->btree, tag);
4381 _gtk_text_buffer_spew (GtkTextBuffer *buffer)
4383 _gtk_text_btree_spew (get_btree (buffer));
4386 #define __GTK_TEXT_BUFFER_C__
4387 #include "gtkaliasdef.c"