Package: gtk

Function gtk:text-buffer-delete

Lambda List

gtk:text-buffer-delete (buffer start end &key interactive editable)

Syntax

(gtk:text-buffer-delete buffer start end) => t
(gtk:text-buffer-delete buffer start end :interactive t) => t
(gtk:text-buffer-delete buffer start end :interactive t :editable t) => t

Arguments

buffer -- a gtk:text-buffer object
start -- a gtk:text-iter start position in the text buffer
end -- a gtk:text-iter end position in the text buffer
interactive -- a boolean whether the deletion is caused by user interaction, the default value is nil
editable -- a boolean whether the text buffer is editable by default, the default value is nil

Return Value

True if some text was actually deleted.

Details

Deletes text between the start and end iterators. The order of the start and end iterators is not actually relevant. The gtk:text-buffer-delete function will reorder them. This function actually emits the "delete-range" signal, and the default handler of that signal deletes the text. Because the text buffer is modified, all outstanding iterators become invalid after calling this function. However, the start and end interators will be re-initialized to point to the location where text was deleted.

If the interactive keyword argument is true deletes all editable text for each editable sub range of [start, end). The start and end iterators are revalidated to point to the location of the last deleted range, or left untouched if no text was deleted. If the editable keyword argument is true deletes in addition the not editable text. This case is equivalent to calling the gtk:text-buffer-delete function with the nil value for the interactive keyword argument.

Notes

The gtk_text_buffer_delete_interactive() function is included in this function and not implemented in the Lisp libraray.
 

See also

2024-7-26