#[repr(transparent)]pub struct Text { /* private fields */ }
Expand description
The Text
widget is a single-line text entry widget.
Text
is the common implementation of single-line text editing
that is shared between Entry
, PasswordEntry
, SpinButton
and other widgets. In all of these, Text
is used as the delegate
for the Editable
implementation.
A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.
When using an entry for passwords and other sensitive information,
it can be put into “password mode” using set_visibility()
.
In this mode, entered text is displayed using a “invisible” character.
By default, GTK picks the best invisible character that is available
in the current font, but it can be changed with
set_invisible_char()
.
If you are looking to add icons or progress display in an entry, look
at Entry
. There other alternatives for more specialized use cases,
such as SearchEntry
.
If you need multi-line editable text, look at TextView
.
CSS nodes
text[.read-only]
├── placeholder
├── undershoot.left
├── undershoot.right
├── [selection]
├── [block-cursor]
╰── [window.popup]
Text
has a main node with the name text. Depending on the properties
of the widget, the .read-only style class may appear.
When the entry has a selection, it adds a subnode with the name selection.
When the entry is in overwrite mode, it adds a subnode with the name block-cursor that determines how the block cursor is drawn.
The CSS node for a context menu is added as a subnode below text as well.
The undershoot nodes are used to draw the underflow indication when content is scrolled out of view. These nodes get the .left and .right style classes added depending on where the indication is drawn.
When touch is used and touch selection handles are shown, they are using CSS nodes with name cursor-handle. They get the .top or .bottom style class depending on where they are shown in relation to the selection. If there is just a single handle for the text cursor, it gets the style class .insertion-cursor.
Accessibility
Text
uses the AccessibleRole::None
role, which causes it to be
skipped for accessibility. This is because Text
is expected to be used
as a delegate for a Editable
implementation that will be represented
to accessibility.
Implements
WidgetExt
, glib::ObjectExt
, AccessibleExt
, BuildableExt
, ConstraintTargetExt
, EditableExt
, WidgetExtManual
, AccessibleExtManual
, EditableExtManual
Implementations
sourceimpl Text
impl Text
sourcepub fn with_buffer(buffer: &impl IsA<EntryBuffer>) -> Text
pub fn with_buffer(buffer: &impl IsA<EntryBuffer>) -> Text
sourcepub fn builder() -> TextBuilder
pub fn builder() -> TextBuilder
Creates a new builder-pattern struct instance to construct Text
objects.
This method returns an instance of TextBuilder
which can be used to create Text
objects.
sourcepub fn compute_cursor_extents(&self, position: usize) -> (Rect, Rect)
Available on crate feature v4_4
only.
pub fn compute_cursor_extents(&self, position: usize) -> (Rect, Rect)
v4_4
only.Determine the positions of the strong and weak cursors if the insertion point in the layout is at @position.
The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction are inserted.
The rectangle positions are in widget coordinates.
position
the character position
Returns
strong
location to store the strong cursor position
weak
location to store the weak cursor position
sourcepub fn activates_default(&self) -> bool
pub fn activates_default(&self) -> bool
Returns whether pressing Enter will activate the default widget for the window containing @self.
Returns
sourcepub fn attributes(&self) -> Option<AttrList>
pub fn attributes(&self) -> Option<AttrList>
sourcepub fn buffer(&self) -> EntryBuffer
pub fn buffer(&self) -> EntryBuffer
sourcepub fn enables_emoji_completion(&self) -> bool
pub fn enables_emoji_completion(&self) -> bool
Gets the menu model for extra items in the context menu.
See set_extra_menu()
.
Returns
the menu model
sourcepub fn input_hints(&self) -> InputHints
pub fn input_hints(&self) -> InputHints
Gets the input hints of the Text
.
sourcepub fn input_purpose(&self) -> InputPurpose
pub fn input_purpose(&self) -> InputPurpose
Gets the input purpose of the Text
.
sourcepub fn invisible_char(&self) -> char
pub fn invisible_char(&self) -> char
Retrieves the character displayed when visibility is set to false.
Note that GTK does not compute this value unless it needs it,
so the value returned by this function is not very useful unless
it has been explicitly set with set_invisible_char()
.
Returns
the current invisible char, or 0, if @text does not show invisible text at all.
sourcepub fn max_length(&self) -> i32
pub fn max_length(&self) -> i32
Retrieves the maximum allowed length of the text in @self.
See set_max_length()
.
This is equivalent to getting @self’s EntryBuffer
and
calling EntryBufferExtManual::max_length()
on it.
Returns
the maximum allowed number of characters
in Text
, or 0 if there is no maximum.
sourcepub fn is_overwrite_mode(&self) -> bool
pub fn is_overwrite_mode(&self) -> bool
Gets whether text is overwritten when typing in the Text
.
See set_overwrite_mode()
.
Returns
whether the text is overwritten when typing
sourcepub fn placeholder_text(&self) -> Option<GString>
pub fn placeholder_text(&self) -> Option<GString>
sourcepub fn propagates_text_width(&self) -> bool
pub fn propagates_text_width(&self) -> bool
sourcepub fn text_length(&self) -> u16
pub fn text_length(&self) -> u16
Retrieves the current length of the text in @self.
This is equivalent to getting @self’s EntryBuffer
and calling EntryBufferExtManual::length()
on it.
Returns
the current number of characters
in Text
, or 0 if there are none.
sourcepub fn must_truncate_multiline(&self) -> bool
pub fn must_truncate_multiline(&self) -> bool
sourcepub fn is_visible(&self) -> bool
pub fn is_visible(&self) -> bool
sourcepub fn grab_focus_without_selecting(&self) -> bool
pub fn grab_focus_without_selecting(&self) -> bool
Causes @self to have keyboard focus.
It behaves like WidgetExt::grab_focus()
,
except that it doesn’t select the contents of @self.
You only want to call this on some special entries
which the user usually doesn’t want to replace all text in,
such as search-as-you-type entries.
Returns
true
if focus is now inside @self
sourcepub fn set_activates_default(&self, activates: bool)
pub fn set_activates_default(&self, activates: bool)
If @activates is true
, pressing Enter will activate
the default widget for the window containing @self.
This usually means that the dialog containing the Text
will be closed, since the default widget is usually one of
the dialog buttons.
activates
true
to activate window’s default widget on Enter keypress
sourcepub fn set_attributes(&self, attrs: Option<&AttrList>)
pub fn set_attributes(&self, attrs: Option<&AttrList>)
sourcepub fn set_buffer(&self, buffer: &impl IsA<EntryBuffer>)
pub fn set_buffer(&self, buffer: &impl IsA<EntryBuffer>)
sourcepub fn set_enable_emoji_completion(&self, enable_emoji_completion: bool)
pub fn set_enable_emoji_completion(&self, enable_emoji_completion: bool)
Sets whether Emoji completion is enabled.
If it is, typing ‘:’, followed by a recognized keyword, will pop up a window with suggested Emojis matching the keyword.
enable_emoji_completion
true
to enable Emoji completion
sourcepub fn set_input_hints(&self, hints: InputHints)
pub fn set_input_hints(&self, hints: InputHints)
sourcepub fn set_input_purpose(&self, purpose: InputPurpose)
pub fn set_input_purpose(&self, purpose: InputPurpose)
sourcepub fn set_invisible_char(&self, ch: char)
pub fn set_invisible_char(&self, ch: char)
Sets the character to use when in “password mode”.
By default, GTK picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.
ch
a Unicode character
sourcepub fn set_max_length(&self, length: i32)
pub fn set_max_length(&self, length: i32)
Sets the maximum allowed length of the contents of the widget.
If the current contents are longer than the given length, then they will be truncated to fit.
This is equivalent to getting @self’s EntryBuffer
and
calling EntryBufferExtManual::set_max_length()
on it.
length
the maximum length of the Text
, or 0 for no maximum.
(other than the maximum length of entries.) The value passed
in will be clamped to the range 0-65536.
sourcepub fn set_overwrite_mode(&self, overwrite: bool)
pub fn set_overwrite_mode(&self, overwrite: bool)
sourcepub fn set_placeholder_text(&self, text: Option<&str>)
pub fn set_placeholder_text(&self, text: Option<&str>)
sourcepub fn set_propagate_text_width(&self, propagate_text_width: bool)
pub fn set_propagate_text_width(&self, propagate_text_width: bool)
Sets whether the Text
should grow and shrink with the content.
propagate_text_width
true
to propagate the text width
sourcepub fn set_truncate_multiline(&self, truncate_multiline: bool)
pub fn set_truncate_multiline(&self, truncate_multiline: bool)
Sets whether the Text
should truncate multi-line text
that is pasted into the widget.
truncate_multiline
true
to truncate multi-line text
sourcepub fn set_visibility(&self, visible: bool)
pub fn set_visibility(&self, visible: bool)
Sets whether the contents of the Text
are visible or not.
When visibility is set to false
, characters are displayed
as the invisible char, and will also appear that way when
the text in the widget is copied to the clipboard.
By default, GTK picks the best invisible character available
in the current font, but it can be changed with
set_invisible_char()
.
Note that you probably want to set property::Text::input-purpose
to InputPurpose::Password
or InputPurpose::Pin
to
inform input methods about the purpose of this self,
in addition to setting visibility to false
.
visible
sourcepub fn unset_invisible_char(&self)
pub fn unset_invisible_char(&self)
Unsets the invisible char.
After calling this, the default invisible char is used again.
sourcepub fn im_module(&self) -> Option<GString>
pub fn im_module(&self) -> Option<GString>
Which IM (input method) module should be used for this self.
See IMMulticontext
.
Setting this to a non-None
value overrides the system-wide
IM module setting. See the property::Settings::gtk-im-module
property.
sourcepub fn set_im_module(&self, im_module: Option<&str>)
pub fn set_im_module(&self, im_module: Option<&str>)
Which IM (input method) module should be used for this self.
See IMMulticontext
.
Setting this to a non-None
value overrides the system-wide
IM module setting. See the property::Settings::gtk-im-module
property.
sourcepub fn is_invisible_char_set(&self) -> bool
pub fn is_invisible_char_set(&self) -> bool
Whether the invisible char has been set for the Text
.
sourcepub fn scroll_offset(&self) -> i32
pub fn scroll_offset(&self) -> i32
Number of pixels scrolled of the screen to the left.
pub fn connect_activates_default_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_attributes_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_buffer_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_enable_emoji_completion_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_im_module_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_input_hints_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_input_purpose_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_invisible_char_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_invisible_char_set_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_max_length_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_overwrite_mode_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_placeholder_text_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_propagate_text_width_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_scroll_offset_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_tabs_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_truncate_multiline_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_visibility_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId
sourceimpl Text
impl Text
sourcepub fn connect_activate<F: Fn(&Text) + 'static>(&self, f: F) -> SignalHandlerId
pub fn connect_activate<F: Fn(&Text) + 'static>(&self, f: F) -> SignalHandlerId
Emitted when the user hits the Enter key.
The default bindings for this signal are all forms of the Enter key.
sourcepub fn connect_backspace<F: Fn(&Text) + 'static>(&self, f: F) -> SignalHandlerId
pub fn connect_backspace<F: Fn(&Text) + 'static>(&self, f: F) -> SignalHandlerId
Emitted when the user asks for it.
This is a keybinding signal.
The default bindings for this signal are Backspace and Shift-Backspace.
sourcepub fn connect_copy_clipboard<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_copy_clipboard<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted to copy the selection to the clipboard.
This is a keybinding signal.
The default bindings for this signal are Ctrl-c and Ctrl-Insert.
sourcepub fn connect_cut_clipboard<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_cut_clipboard<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted to cut the selection to the clipboard.
This is a keybinding signal.
The default bindings for this signal are Ctrl-x and Shift-Delete.
sourcepub fn connect_delete_from_cursor<F: Fn(&Text, DeleteType, i32) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_delete_from_cursor<F: Fn(&Text, DeleteType, i32) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted when the user initiates a text deletion.
This is a keybinding signal.
If the @type_ is DeleteType::Chars
, GTK deletes the selection
if there is one, otherwise it deletes the requested number
of characters.
The default bindings for this signal are Delete for deleting a character and Ctrl-Delete for deleting a word.
type_
the granularity of the deletion, as a DeleteType
count
the number of @type_ units to delete
sourcepub fn connect_insert_at_cursor<F: Fn(&Text, &str) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_insert_at_cursor<F: Fn(&Text, &str) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted when the user initiates the insertion of a fixed string at the cursor.
This is a keybinding signal.
This signal has no default bindings.
string
the string to insert
sourcepub fn connect_insert_emoji<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_insert_emoji<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted to present the Emoji chooser for the widget.
This is a keybinding signal.
The default bindings for this signal are Ctrl-. and Ctrl-;
sourcepub fn connect_move_cursor<F: Fn(&Text, MovementStep, i32, bool) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_move_cursor<F: Fn(&Text, MovementStep, i32, bool) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted when the user initiates a cursor movement.
If the cursor is not visible in @self_, this signal causes the viewport to be moved instead.
This is a keybinding signal.
Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.
The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without it does not. There are too many key combinations to list them all here.
- ←, →, ↑, ↓ move by individual characters/lines
- Ctrl-→, etc. move by words/paragraphs
- Home, End move to the ends of the buffer
step
the granularity of the move, as a MovementStep
count
the number of @step units to move
extend
true
if the move should extend the selection
sourcepub fn connect_paste_clipboard<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_paste_clipboard<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted to paste the contents of the clipboard.
This is a keybinding signal.
The default bindings for this signal are Ctrl-v and Shift-Insert.
pub fn connect_populate_popup<F: Fn(&Text, &Widget) + 'static>(
&self,
f: F
) -> SignalHandlerId
sourcepub fn connect_preedit_changed<F: Fn(&Text, &str) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_preedit_changed<F: Fn(&Text, &str) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted when the preedit text changes.
If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.
preedit
the current preedit string
sourcepub fn connect_toggle_overwrite<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
pub fn connect_toggle_overwrite<F: Fn(&Text) + 'static>(
&self,
f: F
) -> SignalHandlerId
Emitted to toggle the overwrite mode of the Text
.
This is a keybinding signal.
The default bindings for this signal is Insert.
pub fn emit_activate(&self)
pub fn emit_backspace(&self)
pub fn emit_copy_clipboard(&self)
pub fn emit_cut_clipboard(&self)
pub fn emit_delete_from_cursor(&self, type_: DeleteType, count: i32)
pub fn emit_insert_at_cursor(&self, string: &str)
pub fn emit_insert_emoji(&self)
pub fn emit_move_cursor(&self, step: MovementStep, count: i32, extend: bool)
pub fn emit_paste_clipboard(&self)
pub fn emit_preedit_changed(&self, preedit: &str)
pub fn emit_toggle_overwrite(&self)
Trait Implementations
sourceimpl Ord for Text
impl Ord for Text
sourceimpl ParentClassIs for Text
impl ParentClassIs for Text
sourceimpl<OT: ObjectType> PartialEq<OT> for Text
impl<OT: ObjectType> PartialEq<OT> for Text
sourceimpl<OT: ObjectType> PartialOrd<OT> for Text
impl<OT: ObjectType> PartialOrd<OT> for Text
sourcefn partial_cmp(&self, other: &OT) -> Option<Ordering>
fn partial_cmp(&self, other: &OT) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl StaticType for Text
impl StaticType for Text
sourcefn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
impl Eq for Text
impl IsA<Accessible> for Text
impl IsA<Buildable> for Text
impl IsA<ConstraintTarget> for Text
impl IsA<Editable> for Text
impl IsA<Widget> for Text
Auto Trait Implementations
impl RefUnwindSafe for Text
impl !Send for Text
impl !Sync for Text
impl Unpin for Text
impl UnwindSafe for Text
Blanket Implementations
sourceimpl<O> AccessibleExtManual for O where
O: IsA<Accessible>,
impl<O> AccessibleExtManual for O where
O: IsA<Accessible>,
sourcefn update_property(&self, properties: &[Property<'_>])
fn update_property(&self, properties: &[Property<'_>])
Updates an array of accessible properties. Read more
sourcefn update_relation(&self, relations: &[Relation<'_>])
fn update_relation(&self, relations: &[Relation<'_>])
Updates an array of accessible relations. Read more
sourcefn update_state(&self, states: &[State])
fn update_state(&self, states: &[State])
Updates an array of accessible states. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Cast for T where
T: ObjectType,
impl<T> Cast for T where
T: ObjectType,
sourcefn upcast<T>(self) -> T where
T: ObjectType,
Self: IsA<T>,
fn upcast<T>(self) -> T where
T: ObjectType,
Self: IsA<T>,
Upcasts an object to a superclass or interface T
. Read more
sourcefn upcast_ref<T>(&self) -> &T where
T: ObjectType,
Self: IsA<T>,
fn upcast_ref<T>(&self) -> &T where
T: ObjectType,
Self: IsA<T>,
Upcasts an object to a reference of its superclass or interface T
. Read more
sourcefn downcast<T>(self) -> Result<T, Self> where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast<T>(self) -> Result<T, Self> where
T: ObjectType,
Self: CanDowncast<T>,
Tries to downcast to a subclass or interface implementor T
. Read more
sourcefn downcast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
Self: CanDowncast<T>,
Tries to downcast to a reference of its subclass or interface implementor T
. Read more
sourcefn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,
Tries to cast to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
sourcefn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
Tries to cast to reference to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
sourceunsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,
Casts to T
unconditionally. Read more
sourceunsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,
Casts to &T
unconditionally. Read more
sourceimpl<U> IsSubclassableExt for U where
U: IsClass + ParentClassIs,
impl<U> IsSubclassableExt for U where
U: IsClass + ParentClassIs,
fn parent_class_init<T>(class: &mut Class<U>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
sourceimpl<T> ObjectExt for T where
T: ObjectType,
impl<T> ObjectExt for T where
T: ObjectType,
sourcefn is<U>(&self) -> bool where
U: StaticType,
fn is<U>(&self) -> bool where
U: StaticType,
Returns true
if the object is an instance of (can be cast to) T
.
sourcefn object_class(&self) -> &Class<Object>
fn object_class(&self) -> &Class<Object>
Returns the ObjectClass
of the object. Read more
sourcefn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass,
fn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass,
Returns the class of the object in the given type T
. Read more
sourcefn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface,
fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface,
Returns the interface T
of the object. Read more
sourcefn try_set_property<V>(
&self,
property_name: &str,
value: V
) -> Result<(), BoolError> where
V: ToValue,
fn try_set_property<V>(
&self,
property_name: &str,
value: V
) -> Result<(), BoolError> where
V: ToValue,
Similar to Self::set_property
but fails instead of panicking.
sourcefn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,
fn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,
Sets the property property_name
of the object to value value
. Read more
sourcefn try_set_property_from_value(
&self,
property_name: &str,
value: &Value
) -> Result<(), BoolError>
fn try_set_property_from_value(
&self,
property_name: &str,
value: &Value
) -> Result<(), BoolError>
Similar to Self::set_property
but fails instead of panicking.
sourcefn set_property_from_value(&self, property_name: &str, value: &Value)
fn set_property_from_value(&self, property_name: &str, value: &Value)
Sets the property property_name
of the object to value value
. Read more
sourcefn try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
fn try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
Similar to Self::set_properties
but fails instead of panicking.
sourcefn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
Sets multiple properties of the object at once. Read more
sourcefn try_set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
fn try_set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
Similar to Self::set_properties_from_value
but fails instead of panicking.
sourcefn set_properties_from_value(&self, property_values: &[(&str, Value)])
fn set_properties_from_value(&self, property_values: &[(&str, Value)])
Sets multiple properties of the object at once. Read more
sourcefn try_property<V>(&self, property_name: &str) -> Result<V, BoolError> where
V: 'static + for<'b> FromValue<'b>,
fn try_property<V>(&self, property_name: &str) -> Result<V, BoolError> where
V: 'static + for<'b> FromValue<'b>,
Similar to Self::property
but fails instead of panicking.
sourcefn property<V>(&self, property_name: &str) -> V where
V: 'static + for<'b> FromValue<'b>,
fn property<V>(&self, property_name: &str) -> V where
V: 'static + for<'b> FromValue<'b>,
Gets the property property_name
of the object and cast it to the type V. Read more
sourcefn try_property_value(&self, property_name: &str) -> Result<Value, BoolError>
fn try_property_value(&self, property_name: &str) -> Result<Value, BoolError>
Similar to Self::property_value
but fails instead of panicking.
sourcefn property_value(&self, property_name: &str) -> Value
fn property_value(&self, property_name: &str) -> Value
Gets the property property_name
of the object. Read more
sourcefn has_property(&self, property_name: &str, type_: Option<Type>) -> bool
fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool
Check if the object has a property property_name
of the given type_
. Read more
sourcefn property_type(&self, property_name: &str) -> Option<Type>
fn property_type(&self, property_name: &str) -> Option<Type>
Get the type of the property property_name
of this object. Read more
sourcefn find_property(&self, property_name: &str) -> Option<ParamSpec>
fn find_property(&self, property_name: &str) -> Option<ParamSpec>
Get the ParamSpec
of the property property_name
of this object.
sourcefn list_properties(&self) -> PtrSlice<ParamSpec>
fn list_properties(&self) -> PtrSlice<ParamSpec>
Return all ParamSpec
of the properties of this object.
sourcefn freeze_notify(&self) -> PropertyNotificationFreezeGuard
fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
Freeze all property notifications until the return guard object is dropped. Read more
sourceunsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,
unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,
Set arbitrary data on this object with the given key
. Read more
sourceunsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static,
unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static,
Return previously set arbitrary data of this object with the given key
. Read more
sourceunsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,
unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,
Retrieve previously set arbitrary data of this object with the given key
. Read more
sourceunsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,
unsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,
Set arbitrary data on this object with the given key
. Read more
sourceunsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static,
unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static,
Return previously set arbitrary data of this object with the given key
. Read more
sourceunsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,
unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,
Retrieve previously set arbitrary data of this object with the given key
. Read more
sourcefn block_signal(&self, handler_id: &SignalHandlerId)
fn block_signal(&self, handler_id: &SignalHandlerId)
Block a given signal handler. Read more
sourcefn unblock_signal(&self, handler_id: &SignalHandlerId)
fn unblock_signal(&self, handler_id: &SignalHandlerId)
Unblock a given signal handler.
sourcefn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
Stop emission of the currently emitted signal.
sourcefn stop_signal_emission_by_name(&self, signal_name: &str)
fn stop_signal_emission_by_name(&self, signal_name: &str)
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
sourcefn try_connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
fn try_connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
Similar to Self::connect
but fails instead of panicking.
sourcefn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
Connect to the signal signal_name
on this object. Read more
sourcefn try_connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
fn try_connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
Similar to Self::connect_id
but fails instead of panicking.
sourcefn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value> + Send + Sync,
Connect to the signal signal_id
on this object. Read more
sourcefn try_connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
fn try_connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
Similar to Self::connect_local
but fails instead of panicking.
sourcefn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
Connect to the signal signal_name
on this object. Read more
sourcefn try_connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
fn try_connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
Similar to Self::connect_local_id
but fails instead of panicking.
sourcefn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + for<'_> Fn(&[Value]) -> Option<Value>,
Connect to the signal signal_id
on this object. Read more
sourceunsafe fn try_connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: for<'_> Fn(&[Value]) -> Option<Value>,
unsafe fn try_connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: for<'_> Fn(&[Value]) -> Option<Value>,
Similar to Self::connect_unsafe
but fails instead of panicking.
sourceunsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: for<'_> Fn(&[Value]) -> Option<Value>,
unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: for<'_> Fn(&[Value]) -> Option<Value>,
Connect to the signal signal_name
on this object. Read more
sourceunsafe fn try_connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: for<'_> Fn(&[Value]) -> Option<Value>,
unsafe fn try_connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: for<'_> Fn(&[Value]) -> Option<Value>,
Similar to Self::connect_unsafe_id
but fails instead of panicking.
sourcefn try_connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
fn try_connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
Similar to Self::connect_closure
but fails instead of panicking.
sourcefn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal signal_name
on this object. Read more
sourcefn try_connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
fn try_connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
Similar to Self::connect_closure_id
but fails instead of panicking.
sourcefn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal signal_id
on this object. Read more
sourcefn watch_closure(&self, closure: &impl AsRef<Closure>)
fn watch_closure(&self, closure: &impl AsRef<Closure>)
Limits the lifetime of closure
to the lifetime of the object. When
the object’s reference count drops to zero, the closure will be
invalidated. An invalidated closure will ignore any calls to
invoke_with_values
, or
invoke
when using Rust closures. Read more
sourceunsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: for<'_> Fn(&[Value]) -> Option<Value>,
unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: for<'_> Fn(&[Value]) -> Option<Value>,
Connect to the signal signal_id
on this object. Read more
sourcefn try_emit<R>(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
fn try_emit<R>(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit
but fails instead of panicking.
sourcefn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
Emit signal by signal id. Read more
sourcefn try_emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>
fn try_emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>
Similar to Self::emit_with_values
but fails instead of panicking.
sourcefn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
Same as Self::emit
but takes Value
for the arguments.
sourcefn try_emit_by_name<R>(
&self,
signal_name: &str,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
fn try_emit_by_name<R>(
&self,
signal_name: &str,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit_by_name
but fails instead of panicking.
sourcefn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
Emit signal by its name. Read more
sourcefn try_emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Result<Option<Value>, BoolError>
fn try_emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Result<Option<Value>, BoolError>
Similar to Self::emit_by_name_with_values
but fails instead of panicking.
sourcefn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>
fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>
Emit signal by its name. Read more
sourcefn try_emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
fn try_emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit_by_name_with_details
but fails instead of panicking.
sourcefn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
Emit signal by its name with details. Read more
sourcefn try_emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Result<Option<Value>, BoolError>
fn try_emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Result<Option<Value>, BoolError>
Similar to Self::emit_by_name_with_details_and_values
but fails instead of panicking.
sourcefn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>
fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>
Emit signal by its name with details. Read more
sourcefn try_emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
fn try_emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit_with_details
but fails instead of panicking.
sourcefn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
Emit signal by signal id with details. Read more
sourcefn try_emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Result<Option<Value>, BoolError>
fn try_emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Result<Option<Value>, BoolError>
Similar to Self::emit_with_details_and_values
but fails instead of panicking.
sourcefn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>
fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>
Emit signal by signal id with details. Read more
sourcefn disconnect(&self, handler_id: SignalHandlerId)
fn disconnect(&self, handler_id: SignalHandlerId)
Disconnect a previously connected signal handler.
sourcefn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + for<'_, '_> Fn(&T, &ParamSpec) + Send + Sync,
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + for<'_, '_> Fn(&T, &ParamSpec) + Send + Sync,
Connect to the notify
signal of the object. Read more
sourcefn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + for<'_, '_> Fn(&T, &ParamSpec),
fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + for<'_, '_> Fn(&T, &ParamSpec),
Connect to the notify
signal of the object. Read more
sourceunsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: for<'_, '_> Fn(&T, &ParamSpec),
unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: for<'_, '_> Fn(&T, &ParamSpec),
Connect to the notify
signal of the object. Read more
sourcefn notify(&self, property_name: &str)
fn notify(&self, property_name: &str)
Notify that the given property has changed its value. Read more
sourcefn notify_by_pspec(&self, pspec: &ParamSpec)
fn notify_by_pspec(&self, pspec: &ParamSpec)
Notify that the given property has changed its value. Read more
sourcefn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T> where
F: 'static + FnOnce() + Send,
fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T> where
F: 'static + FnOnce() + Send,
Add a callback to be notified when the Object is disposed.
sourcefn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T> where
F: 'static + FnOnce(),
fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T> where
F: 'static + FnOnce(),
Add a callback to be notified when the Object is disposed. Read more
sourcefn bind_property<O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a> where
O: ObjectType,
fn bind_property<O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a> where
O: ObjectType,
Bind property source_property
on this object to the target_property
on the target
object. Read more
sourceimpl<T> StaticTypeExt for T where
T: StaticType,
impl<T> StaticTypeExt for T where
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.