Trait ux::TextBufferExt [−][src]
pub trait TextBufferExt: 'static {}Show methods
pub fn delete_text(&self, position: u32, n_chars: i32) -> u32; pub fn emit_deleted_text(&self, position: u32, n_chars: u32); pub fn emit_inserted_text(&self, position: u32, chars: &str, n_chars: u32); pub fn get_bytes(&self) -> usize; pub fn get_length(&self) -> u32; pub fn get_max_length(&self) -> i32; pub fn get_text(&self) -> Option<GString>; pub fn insert_text(&self, position: u32, chars: &str, n_chars: i32) -> u32; pub fn set_max_length(&self, max_length: i32); pub fn set_text(&self, chars: &str, n_chars: i32); pub fn connect_deleted_text<F>(&self, f: F) -> SignalHandlerId
where
F: 'static + Fn(&Self, u32, u32); pub fn connect_inserted_text<F>(&self, f: F) -> SignalHandlerId
where
F: 'static + Fn(&Self, u32, &str, u32); pub fn connect_property_length_notify<F>(&self, f: F) -> SignalHandlerId
where
F: 'static + Fn(&Self); pub fn connect_property_max_length_notify<F>(&self, f: F) -> SignalHandlerId
where
F: 'static + Fn(&Self); pub fn connect_property_text_notify<F>(&self, f: F) -> SignalHandlerId
where
F: 'static + Fn(&Self);
Required methods
pub fn delete_text(&self, position: u32, n_chars: i32) -> u32
[src]
Deletes a sequence of characters from the buffer. n_chars
characters are
deleted starting at position
. If n_chars
is negative, then all characters
until the end of the text are deleted.
If position
or n_chars
are out of bounds, then they are coerced to sane
values.
Note that the positions are specified in characters, not bytes.
position
position at which to delete text
n_chars
number of characters to delete
Returns
The number of characters deleted.
pub fn emit_deleted_text(&self, position: u32, n_chars: u32)
[src]
Emits the TextBuffer::deleted-text
signal on self
.
Used when subclassing TextBuffer
position
position at which text was deleted
n_chars
number of characters deleted
pub fn emit_inserted_text(&self, position: u32, chars: &str, n_chars: u32)
[src]
Emits the TextBuffer::inserted-text
signal on self
.
Used when subclassing TextBuffer
position
position at which text was inserted
chars
text that was inserted
n_chars
number of characters inserted
pub fn get_bytes(&self) -> usize
[src]
Retrieves the length in bytes of the buffer.
See TextBufferExt::get_length
.
Returns
The byte length of the buffer.
pub fn get_length(&self) -> u32
[src]
pub fn get_max_length(&self) -> i32
[src]
Retrieves the maximum allowed length of the text in
self
. See TextBufferExt::set_max_length
.
Returns
the maximum allowed number of characters
in TextBuffer
, or 0 if there is no maximum.
pub fn get_text(&self) -> Option<GString>
[src]
Retrieves the contents of the buffer.
The memory pointer returned by this call will not change unless this object emits a signal, or is finalized.
Returns
a pointer to the contents of the widget as a string. This string points to internally allocated storage in the buffer and must not be freed, modified or stored.
pub fn insert_text(&self, position: u32, chars: &str, n_chars: i32) -> u32
[src]
Inserts n_chars
characters of chars
into the contents of the
buffer, at position position
.
If n_chars
is negative, then characters from chars will be inserted
until a null-terminator is found. If position
or n_chars
are out of
bounds, or the maximum buffer text length is exceeded, then they are
coerced to sane values.
Note that the position and length are in characters, not in bytes.
position
the position at which to insert text.
chars
the text to insert into the buffer.
n_chars
the length of the text in characters, or -1
Returns
The number of characters actually inserted.
pub fn set_max_length(&self, max_length: i32)
[src]
Sets the maximum allowed length of the contents of the buffer. If the current contents are longer than the given length, then they will be truncated to fit.
max_length
the maximum length of the entry buffer, or 0 for no maximum.
(other than the maximum length of entries.) The value passed in will
be clamped to the range [ 0, TEXT_BUFFER_MAX_SIZE
].
pub fn set_text(&self, chars: &str, n_chars: i32)
[src]
Sets the text in the buffer.
This is roughly equivalent to calling TextBufferExt::delete_text
and TextBufferExt::insert_text
.
Note that n_chars
is in characters, not in bytes.
chars
the new text
n_chars
the number of characters in text
, or -1
pub fn connect_deleted_text<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&Self, u32, u32),
[src]
F: 'static + Fn(&Self, u32, u32),
This signal is emitted after text is deleted from the buffer.
position
the position the text was deleted at.
n_chars
The number of characters that were deleted.
pub fn connect_inserted_text<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&Self, u32, &str, u32),
[src]
F: 'static + Fn(&Self, u32, &str, u32),
This signal is emitted after text is inserted into the buffer.
position
the position the text was inserted at.
chars
The text that was inserted.
n_chars
The number of characters that were inserted.
pub fn connect_property_length_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&Self),
[src]
F: 'static + Fn(&Self),
pub fn connect_property_max_length_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&Self),
[src]
F: 'static + Fn(&Self),
pub fn connect_property_text_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&Self),
[src]
F: 'static + Fn(&Self),
Implementors
impl<O> TextBufferExt for O where
O: IsA<TextBuffer>,
[src]
impl<O> TextBufferExt for O where
O: IsA<TextBuffer>,
[src]pub fn delete_text(&self, position: u32, n_chars: i32) -> u32
[src]
pub fn emit_deleted_text(&self, position: u32, n_chars: u32)
[src]
pub fn emit_inserted_text(&self, position: u32, chars: &str, n_chars: u32)
[src]
pub fn get_bytes(&self) -> usize
[src]
pub fn get_length(&self) -> u32
[src]
pub fn get_max_length(&self) -> i32
[src]
pub fn get_text(&self) -> Option<GString>
[src]
pub fn insert_text(&self, position: u32, chars: &str, n_chars: i32) -> u32
[src]
pub fn set_max_length(&self, max_length: i32)
[src]
pub fn set_text(&self, chars: &str, n_chars: i32)
[src]
pub fn connect_deleted_text<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, u32, u32),
[src]
F: 'static + Fn(&O, u32, u32),
pub fn connect_inserted_text<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, u32, &str, u32),
[src]
F: 'static + Fn(&O, u32, &str, u32),
pub fn connect_property_length_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O),
[src]
F: 'static + Fn(&O),
pub fn connect_property_max_length_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O),
[src]
F: 'static + Fn(&O),
pub fn connect_property_text_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O),
[src]
F: 'static + Fn(&O),