Trait gtk::prelude::TextBufferExt [−][src]
pub trait TextBufferExt: 'static {}Show methods
fn add_mark<P: IsA<TextMark>>(&self, mark: &P, where_: &TextIter); fn add_selection_clipboard(&self, clipboard: &Clipboard); fn apply_tag<P: IsA<TextTag>>(
&self,
tag: &P,
start: &TextIter,
end: &TextIter
); fn apply_tag_by_name(&self, name: &str, start: &TextIter, end: &TextIter); fn backspace(
&self,
iter: &mut TextIter,
interactive: bool,
default_editable: bool
) -> bool; fn begin_user_action(&self); fn copy_clipboard(&self, clipboard: &Clipboard); fn create_child_anchor(
&self,
iter: &mut TextIter
) -> Option<TextChildAnchor>; fn create_mark(
&self,
mark_name: Option<&str>,
where_: &TextIter,
left_gravity: bool
) -> Option<TextMark>; fn cut_clipboard(&self, clipboard: &Clipboard, default_editable: bool); fn delete(&self, start: &mut TextIter, end: &mut TextIter); fn delete_interactive(
&self,
start_iter: &mut TextIter,
end_iter: &mut TextIter,
default_editable: bool
) -> bool; fn delete_mark<P: IsA<TextMark>>(&self, mark: &P); fn delete_mark_by_name(&self, name: &str); fn delete_selection(
&self,
interactive: bool,
default_editable: bool
) -> bool; fn deserialize<P: IsA<TextBuffer>>(
&self,
content_buffer: &P,
format: &Atom,
iter: &mut TextIter,
data: &[u8]
) -> Result<(), Error>; fn deserialize_get_can_create_tags(&self, format: &Atom) -> bool; fn deserialize_set_can_create_tags(
&self,
format: &Atom,
can_create_tags: bool
); fn end_user_action(&self); fn bounds(&self) -> (TextIter, TextIter); fn char_count(&self) -> i32; fn copy_target_list(&self) -> Option<TargetList>; fn deserialize_formats(&self) -> Vec<Atom>; fn end_iter(&self) -> TextIter; fn has_selection(&self) -> bool; fn get_insert(&self) -> Option<TextMark>; fn iter_at_child_anchor<P: IsA<TextChildAnchor>>(
&self,
anchor: &P
) -> TextIter; fn iter_at_line(&self, line_number: i32) -> TextIter; fn iter_at_line_index(&self, line_number: i32, byte_index: i32) -> TextIter; fn iter_at_line_offset(
&self,
line_number: i32,
char_offset: i32
) -> TextIter; fn iter_at_mark<P: IsA<TextMark>>(&self, mark: &P) -> TextIter; fn iter_at_offset(&self, char_offset: i32) -> TextIter; fn line_count(&self) -> i32; fn mark(&self, name: &str) -> Option<TextMark>; fn is_modified(&self) -> bool; fn paste_target_list(&self) -> Option<TargetList>; fn selection_bound(&self) -> Option<TextMark>; fn selection_bounds(&self) -> Option<(TextIter, TextIter)>; fn serialize_formats(&self) -> Vec<Atom>; fn slice(
&self,
start: &TextIter,
end: &TextIter,
include_hidden_chars: bool
) -> Option<GString>; fn start_iter(&self) -> TextIter; fn tag_table(&self) -> Option<TextTagTable>; fn text(
&self,
start: &TextIter,
end: &TextIter,
include_hidden_chars: bool
) -> Option<GString>; fn insert(&self, iter: &mut TextIter, text: &str); fn insert_at_cursor(&self, text: &str); fn insert_child_anchor<P: IsA<TextChildAnchor>>(
&self,
iter: &mut TextIter,
anchor: &P
); fn insert_interactive(
&self,
iter: &mut TextIter,
text: &str,
default_editable: bool
) -> bool; fn insert_interactive_at_cursor(
&self,
text: &str,
default_editable: bool
) -> bool; fn insert_markup(&self, iter: &mut TextIter, markup: &str); fn insert_pixbuf(&self, iter: &mut TextIter, pixbuf: &Pixbuf); fn insert_range(
&self,
iter: &mut TextIter,
start: &TextIter,
end: &TextIter
); fn insert_range_interactive(
&self,
iter: &mut TextIter,
start: &TextIter,
end: &TextIter,
default_editable: bool
) -> bool; fn move_mark<P: IsA<TextMark>>(&self, mark: &P, where_: &TextIter); fn move_mark_by_name(&self, name: &str, where_: &TextIter); fn paste_clipboard(
&self,
clipboard: &Clipboard,
override_location: Option<&TextIter>,
default_editable: bool
); fn place_cursor(&self, where_: &TextIter); fn register_deserialize_tagset(&self, tagset_name: Option<&str>) -> Atom; fn register_serialize_tagset(&self, tagset_name: Option<&str>) -> Atom; fn remove_all_tags(&self, start: &TextIter, end: &TextIter); fn remove_selection_clipboard(&self, clipboard: &Clipboard); fn remove_tag<P: IsA<TextTag>>(
&self,
tag: &P,
start: &TextIter,
end: &TextIter
); fn remove_tag_by_name(&self, name: &str, start: &TextIter, end: &TextIter); fn select_range(&self, ins: &TextIter, bound: &TextIter); fn serialize<P: IsA<TextBuffer>>(
&self,
content_buffer: &P,
format: &Atom,
start: &TextIter,
end: &TextIter
) -> Vec<u8>; fn set_modified(&self, setting: bool); fn set_text(&self, text: &str); fn unregister_deserialize_format(&self, format: &Atom); fn unregister_serialize_format(&self, format: &Atom); fn cursor_position(&self) -> i32; fn connect_begin_user_action<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId; fn connect_end_user_action<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_mark_deleted<F: Fn(&Self, &TextMark) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_mark_set<F: Fn(&Self, &TextIter, &TextMark) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_modified_changed<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_paste_done<F: Fn(&Self, &Clipboard) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_copy_target_list_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_cursor_position_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_has_selection_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_paste_target_list_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_text_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId;
Expand description
Required methods
Adds the mark at position where_
. The mark must not be added to
another buffer, and if its name is not None
then there must not
be another mark in the buffer with the same name.
Emits the signal::TextBuffer::mark-set
signal as notification of the mark’s
initial placement.
mark
the mark to add
where_
location to place mark
fn add_selection_clipboard(&self, clipboard: &Clipboard)
fn add_selection_clipboard(&self, clipboard: &Clipboard)
fn apply_tag_by_name(&self, name: &str, start: &TextIter, end: &TextIter)
fn apply_tag_by_name(&self, name: &str, start: &TextIter, end: &TextIter)
Calls TextTagTableExt::lookup()
on the buffer’s tag table to
get a TextTag
, then calls apply_tag()
.
name
name of a named TextTag
start
one bound of range to be tagged
end
other bound of range to be tagged
Performs the appropriate action as if the user hit the delete
key with the cursor at the position specified by iter
. In the
normal case a single character will be deleted, but when
combining accents are involved, more than one character can
be deleted, and when precomposed character and accent combinations
are involved, less than one character will be deleted.
Because the buffer is modified, all outstanding iterators become
invalid after calling this function; however, the iter
will be
re-initialized to point to the location where text was deleted.
iter
a position in self
interactive
whether the deletion is caused by user interaction
default_editable
whether the buffer is editable by default
Returns
true
if the buffer was modified
fn begin_user_action(&self)
fn begin_user_action(&self)
Called to indicate that the buffer operations between here and a
call to end_user_action()
are part of a single
user-visible operation. The operations between
begin_user_action()
and
end_user_action()
can then be grouped when creating
an undo stack. TextBuffer
maintains a count of calls to
begin_user_action()
that have not been closed with
a call to end_user_action()
, and emits the
“begin-user-action” and “end-user-action” signals only for the
outermost pair of calls. This allows you to build user actions
from other user actions.
The “interactive” buffer mutation functions, such as
insert_interactive()
, automatically call begin/end
user action around the buffer operations they perform, so there’s
no need to add extra calls if you user action consists solely of a
single call to one of those functions.
fn copy_clipboard(&self, clipboard: &Clipboard)
fn copy_clipboard(&self, clipboard: &Clipboard)
fn create_child_anchor(&self, iter: &mut TextIter) -> Option<TextChildAnchor>
fn create_child_anchor(&self, iter: &mut TextIter) -> Option<TextChildAnchor>
This is a convenience function which simply creates a child anchor
with TextChildAnchor::new()
and inserts it into the buffer
with insert_child_anchor()
. The new anchor is
owned by the buffer; no reference count is returned to
the caller of create_child_anchor()
.
iter
location in the buffer
Returns
the created child anchor
Creates a mark at position where_
. If mark_name
is None
, the mark
is anonymous; otherwise, the mark can be retrieved by name using
mark()
. If a mark has left gravity, and text is
inserted at the mark’s current location, the mark will be moved to
the left of the newly-inserted text. If the mark has right gravity
(left_gravity
= false
), the mark will end up on the right of
newly-inserted text. The standard left-to-right cursor is a mark
with right gravity (when you type, the cursor stays on the right
side of the text you’re typing).
The caller of this function does not own a
reference to the returned TextMark
, so you can ignore the
return value if you like. Marks are owned by the buffer and go
away when the buffer does.
Emits the signal::TextBuffer::mark-set
signal as notification of the mark’s
initial placement.
mark_name
name for mark, or None
where_
location to place mark
left_gravity
whether the mark has left gravity
Returns
the new TextMark
object
fn cut_clipboard(&self, clipboard: &Clipboard, default_editable: bool)
fn cut_clipboard(&self, clipboard: &Clipboard, default_editable: bool)
Copies the currently-selected text to a clipboard, then deletes said text if it’s editable.
clipboard
the Clipboard
object to cut to
default_editable
default editability of the buffer
Deletes text between start
and end
. The order of start
and end
is not actually relevant; delete()
will reorder
them. This function actually emits the “delete-range” signal, and
the default handler of that signal deletes the text. Because the
buffer is modified, all outstanding iterators become invalid after
calling this function; however, the start
and end
will be
re-initialized to point to the location where text was deleted.
start
a position in self
end
another position in self
Deletes all editable text in the given range.
Calls delete()
for each editable sub-range of
[start
,end
). start
and end
are revalidated to point to
the location of the last deleted range, or left untouched if
no text was deleted.
start_iter
start of range to delete
end_iter
end of range
default_editable
whether the buffer is editable by default
Returns
whether some text was actually deleted
fn delete_mark<P: IsA<TextMark>>(&self, mark: &P)
fn delete_mark<P: IsA<TextMark>>(&self, mark: &P)
Deletes mark
, so that it’s no longer located anywhere in the
buffer. Removes the reference the buffer holds to the mark, so if
you haven’t called g_object_ref()
on the mark, it will be freed. Even
if the mark isn’t freed, most operations on mark
become
invalid, until it gets added to a buffer again with
add_mark()
. Use TextMarkExt::is_deleted()
to
find out if a mark has been removed from its buffer.
The signal::TextBuffer::mark-deleted
signal will be emitted as notification after
the mark is deleted.
mark
a TextMark
in self
fn delete_mark_by_name(&self, name: &str)
fn delete_mark_by_name(&self, name: &str)
Deletes the mark named name
; the mark must exist. See
delete_mark()
for details.
name
name of a mark in self
fn delete_selection(&self, interactive: bool, default_editable: bool) -> bool
fn delete_selection(&self, interactive: bool, default_editable: bool) -> bool
Deletes the range between the “insert” and “selection_bound” marks,
that is, the currently-selected text. If interactive
is true
,
the editability of the selection will be considered (users can’t delete
uneditable text).
interactive
whether the deletion is caused by user interaction
default_editable
whether the buffer is editable by default
Returns
whether there was a non-empty selection to delete
This function deserializes rich text in format format
and inserts
it at iter
.
formats
to be used must be registered using
gtk_text_buffer_register_deserialize_format()
or
register_deserialize_tagset()
beforehand.
content_buffer
the TextBuffer
to deserialize into
format
the rich text format to use for deserializing
iter
insertion point for the deserialized text
data
data to deserialize
Returns
This functions returns the value set with
deserialize_set_can_create_tags()
format
a gdk::Atom
representing a registered rich text format
Returns
whether deserializing this format may create tags
Use this function to allow a rich text deserialization function to create new tags in the receiving buffer. Note that using this function is almost always a bad idea, because the rich text functions you register should know how to map the rich text format they handler to your text buffers set of tags.
The ability of creating new (arbitrary!) tags in the receiving buffer
is meant for special rich text formats like the internal one that
is registered using register_deserialize_tagset()
,
because that format is essentially a dump of the internal structure
of the source buffer, including its tag names.
You should allow creation of tags only if you know what you are doing, e.g. if you defined a tagset name for your application suite’s text buffers and you know that it’s fine to receive new tags from these buffers, because you know that your application can handle the newly created tags.
format
a gdk::Atom
representing a registered rich text format
can_create_tags
whether deserializing this format may create tags
fn end_user_action(&self)
fn end_user_action(&self)
Should be paired with a call to begin_user_action()
.
See that function for a full explanation.
fn char_count(&self) -> i32
fn char_count(&self) -> i32
Gets the number of characters in the buffer; note that characters and bytes are not the same, you can’t e.g. expect the contents of the buffer in string form to be this many bytes long. The character count is cached, so this function is very fast.
Returns
number of characters in the buffer
fn copy_target_list(&self) -> Option<TargetList>
fn copy_target_list(&self) -> Option<TargetList>
This function returns the list of targets this text buffer can
provide for copying and as DND source. The targets in the list are
added with info
values from the GtkTextBufferTargetInfo
enum,
using TargetList::add_rich_text_targets()
and
TargetList::add_text_targets()
.
Returns
the TargetList
fn deserialize_formats(&self) -> Vec<Atom>
fn deserialize_formats(&self) -> Vec<Atom>
This function returns the rich text deserialize formats registered
with self
using gtk_text_buffer_register_deserialize_format()
or
register_deserialize_tagset()
Returns
an array of
GdkAtoms
representing the registered formats.
Initializes iter
with the “end iterator,” one past the last valid
character in the text buffer. If dereferenced with
TextIter::char()
, the end iterator has a character value of 0.
The entire buffer lies in the range from the first position in
the buffer (call start_iter()
to get
character position 0) to the end iterator.
Returns
iter
iterator to initialize
fn has_selection(&self) -> bool
fn has_selection(&self) -> bool
fn get_insert(&self) -> Option<TextMark>
fn get_insert(&self) -> Option<TextMark>
fn iter_at_child_anchor<P: IsA<TextChildAnchor>>(&self, anchor: &P) -> TextIter
fn iter_at_child_anchor<P: IsA<TextChildAnchor>>(&self, anchor: &P) -> TextIter
fn iter_at_line(&self, line_number: i32) -> TextIter
fn iter_at_line(&self, line_number: i32) -> TextIter
Initializes iter
to the start of the given line. If line_number
is greater
than the number of lines in the self
, the end iterator is returned.
line_number
line number counting from 0
Returns
iter
iterator to initialize
fn iter_at_line_index(&self, line_number: i32, byte_index: i32) -> TextIter
fn iter_at_line_index(&self, line_number: i32, byte_index: i32) -> TextIter
Obtains an iterator pointing to byte_index
within the given line.
byte_index
must be the start of a UTF-8 character. Note bytes, not
characters; UTF-8 may encode one character as multiple bytes.
Before the 3.20 version, it was not allowed to pass an invalid location.
Since the 3.20 version, if line_number
is greater than the number of lines
in the self
, the end iterator is returned. And if byte_index
is off the
end of the line, the iterator at the end of the line is returned.
line_number
line number counting from 0
byte_index
byte index from start of line
Returns
iter
iterator to initialize
fn iter_at_line_offset(&self, line_number: i32, char_offset: i32) -> TextIter
fn iter_at_line_offset(&self, line_number: i32, char_offset: i32) -> TextIter
Obtains an iterator pointing to char_offset
within the given line. Note
characters, not bytes; UTF-8 may encode one character as multiple bytes.
Before the 3.20 version, it was not allowed to pass an invalid location.
Since the 3.20 version, if line_number
is greater than the number of lines
in the self
, the end iterator is returned. And if char_offset
is off the
end of the line, the iterator at the end of the line is returned.
line_number
line number counting from 0
char_offset
char offset from start of line
Returns
iter
iterator to initialize
fn iter_at_offset(&self, char_offset: i32) -> TextIter
fn iter_at_offset(&self, char_offset: i32) -> TextIter
Initializes iter
to a position char_offset
chars from the start
of the entire buffer. If char_offset
is -1 or greater than the number
of characters in the buffer, iter
is initialized to the end iterator,
the iterator one past the last valid character in the buffer.
char_offset
char offset from start of buffer, counting from 0, or -1
Returns
iter
iterator to initialize
fn line_count(&self) -> i32
fn line_count(&self) -> i32
Obtains the number of lines in the buffer. This value is cached, so the function is very fast.
Returns
number of lines in the buffer
fn is_modified(&self) -> bool
fn is_modified(&self) -> bool
Indicates whether the buffer has been modified since the last call
to set_modified()
set the modification flag to
false
. Used for example to enable a “save” function in a text
editor.
Returns
true
if the buffer has been modified
fn paste_target_list(&self) -> Option<TargetList>
fn paste_target_list(&self) -> Option<TargetList>
This function returns the list of targets this text buffer supports
for pasting and as DND destination. The targets in the list are
added with info
values from the GtkTextBufferTargetInfo
enum,
using TargetList::add_rich_text_targets()
and
TargetList::add_text_targets()
.
Returns
the TargetList
fn selection_bound(&self) -> Option<TextMark>
fn selection_bound(&self) -> Option<TextMark>
Returns the mark that represents the selection bound. Equivalent
to calling mark()
to get the mark named
“selection_bound”, but very slightly more efficient, and involves
less typing.
The currently-selected text in self
is the region between the
“selection_bound” and “insert” marks. If “selection_bound” and
“insert” are in the same place, then there is no current selection.
selection_bounds()
is another convenient function
for handling the selection, if you just want to know whether there’s a
selection and what its bounds are.
Returns
selection bound mark
Returns true
if some text is selected; places the bounds
of the selection in start
and end
(if the selection has length 0,
then start
and end
are filled in with the same value).
start
and end
will be in ascending order. If start
and end
are
NULL, then they are not filled in, but the return value still indicates
whether text is selected.
Returns
whether the selection has nonzero length
start
iterator to initialize with selection start
end
iterator to initialize with selection end
fn serialize_formats(&self) -> Vec<Atom>
fn serialize_formats(&self) -> Vec<Atom>
This function returns the rich text serialize formats registered
with self
using gtk_text_buffer_register_serialize_format()
or
register_serialize_tagset()
Returns
an array of
GdkAtoms
representing the registered formats.
Returns the text in the range [start
,end
). Excludes undisplayed
text (text marked with tags that set the invisibility attribute) if
include_hidden_chars
is false
. The returned string includes a
0xFFFC character whenever the buffer contains
embedded images, so byte and character indexes into
the returned string do correspond to byte
and character indexes into the buffer. Contrast with
text()
. Note that 0xFFFC can occur in normal
text as well, so it is not a reliable indicator that a pixbuf or
widget is in the buffer.
start
start of a range
end
end of a range
include_hidden_chars
whether to include invisible text
Returns
an allocated UTF-8 string
fn start_iter(&self) -> TextIter
fn start_iter(&self) -> TextIter
Initialized iter
with the first position in the text buffer. This
is the same as using iter_at_offset()
to get
the iter at character offset 0.
Returns
iter
iterator to initialize
fn tag_table(&self) -> Option<TextTagTable>
fn tag_table(&self) -> Option<TextTagTable>
Returns the text in the range [start
,end
). Excludes undisplayed
text (text marked with tags that set the invisibility attribute) if
include_hidden_chars
is false
. Does not include characters
representing embedded images, so byte and character indexes into
the returned string do not correspond to byte
and character indexes into the buffer. Contrast with
slice()
.
start
start of a range
end
end of a range
include_hidden_chars
whether to include invisible text
Returns
an allocated UTF-8 string
Inserts len
bytes of text
at position iter
. If len
is -1,
text
must be nul-terminated and will be inserted in its
entirety. Emits the “insert-text” signal; insertion actually occurs
in the default handler for the signal. iter
is invalidated when
insertion occurs (because the buffer contents change), but the
default signal handler revalidates it to point to the end of the
inserted text.
iter
a position in the buffer
text
text in UTF-8 format
len
length of text in bytes, or -1
fn insert_at_cursor(&self, text: &str)
fn insert_at_cursor(&self, text: &str)
fn insert_child_anchor<P: IsA<TextChildAnchor>>(
&self,
iter: &mut TextIter,
anchor: &P
)
fn insert_child_anchor<P: IsA<TextChildAnchor>>(
&self,
iter: &mut TextIter,
anchor: &P
)
Inserts a child widget anchor into the text buffer at iter
. The
anchor will be counted as one character in character counts, and
when obtaining the buffer contents as a string, will be represented
by the Unicode “object replacement character” 0xFFFC. Note that the
“slice” variants for obtaining portions of the buffer as a string
include this character for child anchors, but the “text” variants do
not. E.g. see slice()
and
text()
. Consider
create_child_anchor()
as a more convenient
alternative to this function. The buffer will add a reference to
the anchor, so you can unref it after insertion.
iter
location to insert the anchor
anchor
Like insert()
, but the insertion will not occur if
iter
is at a non-editable location in the buffer. Usually you
want to prevent insertions at ineditable locations if the insertion
results from a user action (is interactive).
default_editable
indicates the editability of text that doesn’t
have a tag affecting editability applied to it. Typically the
result of TextViewExt::is_editable()
is appropriate here.
iter
a position in self
text
some UTF-8 text
len
length of text in bytes, or -1
default_editable
default editability of buffer
Returns
whether text was actually inserted
fn insert_interactive_at_cursor(
&self,
text: &str,
default_editable: bool
) -> bool
fn insert_interactive_at_cursor(
&self,
text: &str,
default_editable: bool
) -> bool
Calls insert_interactive()
at the cursor
position.
default_editable
indicates the editability of text that doesn’t
have a tag affecting editability applied to it. Typically the
result of TextViewExt::is_editable()
is appropriate here.
text
text in UTF-8 format
len
length of text in bytes, or -1
default_editable
default editability of buffer
Returns
whether text was actually inserted
fn insert_markup(&self, iter: &mut TextIter, markup: &str)
fn insert_markup(&self, iter: &mut TextIter, markup: &str)
Inserts the text in markup
at position iter
. markup
will be inserted
in its entirety and must be nul-terminated and valid UTF-8. Emits the
signal::TextBuffer::insert-text
signal, possibly multiple times; insertion
actually occurs in the default handler for the signal. iter
will point
to the end of the inserted text on return.
iter
location to insert the markup
markup
a nul-terminated UTF-8 string containing [Pango markup][PangoMarkupFormat]
len
length of markup
in bytes, or -1
fn insert_pixbuf(&self, iter: &mut TextIter, pixbuf: &Pixbuf)
fn insert_pixbuf(&self, iter: &mut TextIter, pixbuf: &Pixbuf)
Inserts an image into the text buffer at iter
. The image will be
counted as one character in character counts, and when obtaining
the buffer contents as a string, will be represented by the Unicode
“object replacement character” 0xFFFC. Note that the “slice”
variants for obtaining portions of the buffer as a string include
this character for pixbufs, but the “text” variants do
not. e.g. see slice()
and
text()
.
iter
location to insert the pixbuf
pixbuf
fn insert_range(&self, iter: &mut TextIter, start: &TextIter, end: &TextIter)
fn insert_range(&self, iter: &mut TextIter, start: &TextIter, end: &TextIter)
Copies text, tags, and pixbufs between start
and end
(the order
of start
and end
doesn’t matter) and inserts the copy at iter
.
Used instead of simply getting/inserting text because it preserves
images and tags. If start
and end
are in a different buffer from
self
, the two buffers must share the same tag table.
Implemented via emissions of the insert_text and apply_tag signals, so expect those.
iter
a position in self
start
a position in a TextBuffer
end
another position in the same buffer as start
Same as insert_range()
, but does nothing if the
insertion point isn’t editable. The default_editable
parameter
indicates whether the text is editable at iter
if no tags
enclosing iter
affect editability. Typically the result of
TextViewExt::is_editable()
is appropriate here.
iter
a position in self
start
a position in a TextBuffer
end
another position in the same buffer as start
default_editable
default editability of the buffer
Returns
whether an insertion was possible at iter
fn move_mark_by_name(&self, name: &str, where_: &TextIter)
fn move_mark_by_name(&self, name: &str, where_: &TextIter)
Moves the mark named name
(which must exist) to location where_
.
See move_mark()
for details.
name
name of a mark
where_
new location for mark
Pastes the contents of a clipboard. If override_location
is None
, the
pasted text will be inserted at the cursor position, or the buffer selection
will be replaced if the selection is non-empty.
Note: pasting is asynchronous, that is, we’ll ask for the paste data and return, and at some point later after the main loop runs, the paste data will be inserted.
clipboard
the Clipboard
to paste from
override_location
location to insert pasted text, or None
default_editable
whether the buffer is editable by default
fn place_cursor(&self, where_: &TextIter)
fn place_cursor(&self, where_: &TextIter)
This function moves the “insert” and “selection_bound” marks
simultaneously. If you move them to the same place in two steps
with move_mark()
, you will temporarily select a
region in between their old and new locations, which can be pretty
inefficient since the temporarily-selected region will force stuff
to be recalculated. This function moves them as a unit, which can
be optimized.
where_
where to put the cursor
This function registers GTK+’s internal rich text serialization
format with the passed self
. See
register_serialize_tagset()
for details.
tagset_name
an optional tagset name, on None
Returns
the gdk::Atom
that corresponds to the
newly registered format’s mime-type.
This function registers GTK+’s internal rich text serialization
format with the passed self
. The internal format does not comply
to any standard rich text format and only works between TextBuffer
instances. It is capable of serializing all of a text buffer’s tags
and embedded pixbufs.
This function is just a wrapper around
gtk_text_buffer_register_serialize_format()
. The mime type used
for registering is “application/x-gtk-text-buffer-rich-text”, or
“application/x-gtk-text-buffer-rich-text;format=tagset_name
” if a
tagset_name
was passed.
The tagset_name
can be used to restrict the transfer of rich text
to buffers with compatible sets of tags, in order to avoid unknown
tags from being pasted. It is probably the common case to pass an
identifier != None
here, since the None
tagset requires the
receiving buffer to deal with with pasting of arbitrary tags.
tagset_name
an optional tagset name, on None
Returns
the gdk::Atom
that corresponds to the
newly registered format’s mime-type.
Removes all tags in the range between start
and end
. Be careful
with this function; it could remove tags added in code unrelated to
the code you’re currently writing. That is, using this function is
probably a bad idea if you have two or more unrelated code sections
that add tags.
start
one bound of range to be untagged
end
other bound of range to be untagged
fn remove_selection_clipboard(&self, clipboard: &Clipboard)
fn remove_selection_clipboard(&self, clipboard: &Clipboard)
Removes a Clipboard
added with
add_selection_clipboard()
.
clipboard
a Clipboard
added to self
by
add_selection_clipboard()
fn remove_tag_by_name(&self, name: &str, start: &TextIter, end: &TextIter)
fn remove_tag_by_name(&self, name: &str, start: &TextIter, end: &TextIter)
Calls TextTagTableExt::lookup()
on the buffer’s tag table to
get a TextTag
, then calls remove_tag()
.
name
name of a TextTag
start
one bound of range to be untagged
end
other bound of range to be untagged
fn select_range(&self, ins: &TextIter, bound: &TextIter)
fn select_range(&self, ins: &TextIter, bound: &TextIter)
This function moves the “insert” and “selection_bound” marks
simultaneously. If you move them in two steps
with move_mark()
, you will temporarily select a
region in between their old and new locations, which can be pretty
inefficient since the temporarily-selected region will force stuff
to be recalculated. This function moves them as a unit, which can
be optimized.
ins
where to put the “insert” mark
bound
where to put the “selection_bound” mark
This function serializes the portion of text between start
and end
in the rich text format represented by format
.
formats
to be used must be registered using
gtk_text_buffer_register_serialize_format()
or
register_serialize_tagset()
beforehand.
content_buffer
the TextBuffer
to serialize
format
the rich text format to use for serializing
start
start of block of text to serialize
end
end of block of test to serialize
Returns
the serialized
data, encoded as format
fn set_modified(&self, setting: bool)
fn set_modified(&self, setting: bool)
Used to keep track of whether the buffer has been modified since the
last time it was saved. Whenever the buffer is saved to disk, call
gtk_text_buffer_set_modified (self
, FALSE). When the buffer is modified,
it will automatically toggled on the modified bit again. When the modified
bit flips, the buffer emits the signal::TextBuffer::modified-changed
signal.
setting
modification flag setting
fn unregister_deserialize_format(&self, format: &Atom)
fn unregister_deserialize_format(&self, format: &Atom)
This function unregisters a rich text format that was previously
registered using gtk_text_buffer_register_deserialize_format()
or
register_deserialize_tagset()
.
format
a gdk::Atom
representing a registered rich text format.
fn unregister_serialize_format(&self, format: &Atom)
fn unregister_serialize_format(&self, format: &Atom)
This function unregisters a rich text format that was previously
registered using gtk_text_buffer_register_serialize_format()
or
register_serialize_tagset()
format
a gdk::Atom
representing a registered rich text format.
fn cursor_position(&self) -> i32
fn cursor_position(&self) -> i32
The position of the insert mark (as offset from the beginning of the buffer). It is useful for getting notified when the cursor moves.
fn connect_begin_user_action<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_begin_user_action<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
The ::begin-user-action signal is emitted at the beginning of a single
user-visible operation on a TextBuffer
.
See also:
begin_user_action()
,
insert_interactive()
,
insert_range_interactive()
,
delete_interactive()
,
backspace()
,
delete_selection()
.
fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId
The ::changed signal is emitted when the content of a TextBuffer
has changed.
fn connect_end_user_action<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_end_user_action<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
The ::end-user-action signal is emitted at the end of a single
user-visible operation on the TextBuffer
.
See also:
end_user_action()
,
insert_interactive()
,
insert_range_interactive()
,
delete_interactive()
,
backspace()
,
delete_selection()
,
backspace()
.
fn connect_mark_deleted<F: Fn(&Self, &TextMark) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_mark_deleted<F: Fn(&Self, &TextMark) + 'static>(
&self,
f: F
) -> SignalHandlerId
The ::mark-deleted signal is emitted as notification
after a TextMark
is deleted.
See also:
delete_mark()
.
mark
The mark that was deleted
fn connect_mark_set<F: Fn(&Self, &TextIter, &TextMark) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_mark_set<F: Fn(&Self, &TextIter, &TextMark) + 'static>(
&self,
f: F
) -> SignalHandlerId
The ::mark-set signal is emitted as notification
after a TextMark
is set.
See also:
create_mark()
,
move_mark()
.
location
The location of mark
in textbuffer
mark
The mark that is set
fn connect_modified_changed<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_modified_changed<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
The ::modified-changed signal is emitted when the modified bit of a
TextBuffer
flips.
See also:
set_modified()
.
fn connect_paste_done<F: Fn(&Self, &Clipboard) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_paste_done<F: Fn(&Self, &Clipboard) + 'static>(
&self,
f: F
) -> SignalHandlerId
The paste-done signal is emitted after paste operation has been completed.
This is useful to properly scroll the view to the end of the pasted text.
See paste_clipboard()
for more details.
clipboard
the Clipboard
pasted from
fn connect_copy_target_list_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_cursor_position_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_has_selection_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_paste_target_list_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_text_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId