Skip to main content

EntryCompletion

gtk4

Struct EntryCompletion 

Source 
pub struct EntryCompletion { /* private fields */ }
👎Deprecated:

Since 4.10

Expand description

EntryCompletion is an auxiliary object to provide completion functionality for Entry.

It implements the CellLayout interface, to allow the user to add extra cells to the TreeView with completion matches.

“Completion functionality” means that when the user modifies the text in the entry, EntryCompletion checks which rows in the model match the current content of the entry, and displays a list of matches. By default, the matching is done by comparing the entry text case-insensitively against the text column of the model (see set_text_column()), but this can be overridden with a custom match function (see set_match_func()).

When the user selects a completion, the content of the entry is updated. By default, the content of the entry is replaced by the text column of the model, but this can be overridden by connecting to the match-selected signal and updating the entry in the signal handler. Note that you should return true from the signal handler to suppress the default behaviour.

To add completion functionality to an entry, use EntryExt::set_completion().

EntryCompletion uses a TreeModelFilter model to represent the subset of the entire model that is currently matching. While the EntryCompletion signals match-selected and cursor-on-match take the original model and an iter pointing to that model as arguments, other callbacks and signals (such as GtkCellLayoutDataFunc or apply-attributes)] will generally take the filter model as argument. As long as you are only calling TreeModelExtManual::get(), this will make no difference to you. If for some reason, you need the original model, use TreeModelFilterExt::model(). Don’t forget to use TreeModelFilterExt::convert_iter_to_child_iter() to obtain a matching iter.

§Properties

§cell-area

The CellArea used to layout cell renderers in the treeview column.

If no area is specified when creating the entry completion with EntryCompletion::with_area(), a horizontally oriented CellAreaBox will be used.

Readable | Writable | Construct Only

§inline-completion

Determines whether the common prefix of the possible completions should be inserted automatically in the entry.

Note that this requires text-column to be set, even if you are using a custom match function.

Readable | Writable

§inline-selection

Determines whether the possible completions on the popup will appear in the entry as you navigate through them.

Readable | Writable

§minimum-key-length

The minimum key length as set for completion.

Readable | Writable

§model

The model used as data source.

Readable | Writable

Determines whether the possible completions should be shown in a popup window.

Readable | Writable

Determines whether the completions popup window will be resized to the width of the entry.

Readable | Writable

Determines whether the completions popup window will shown for a single possible completion.

You probably want to set this to false if you are using inline-completion.

Readable | Writable

§text-column

The column of the model containing the strings.

Note that the strings must be UTF-8.

Readable | Writable

§Signals

§cursor-on-match

Emitted when a match from the cursor is on a match of the list.

The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by @iter.

Note that @model is the model that was passed to EntryCompletion::set_model().

§insert-prefix

Emitted when the inline autocompletion is triggered.

The default behaviour is to make the entry display the whole prefix and select the newly inserted part.

Applications may connect to this signal in order to insert only a smaller part of the @prefix into the entry - e.g. the entry used in the FileChooser inserts only the part of the prefix up to the next ‘/’.

§match-selected

Emitted when a match from the list is selected.

The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by @iter.

Note that @model is the model that was passed to EntryCompletion::set_model().

§no-matches

Emitted when the filter model has zero number of rows in completion_complete method.

In other words when EntryCompletion is out of suggestions.

§Implements

[trait@glib::ObjectExt], BuildableExt, CellLayoutExt, CellLayoutExtManual

GLib type: GObject with reference counted clone semantics.

Implementations§

Source§

impl EntryCompletion

Source

pub fn new() -> EntryCompletion

👎Deprecated:

Since 4.10

Creates a new EntryCompletion object.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

A newly created EntryCompletion object

Source

pub fn with_area(area: &impl IsA<CellArea>) -> EntryCompletion

👎Deprecated:

Since 4.10

Creates a new EntryCompletion object using the specified @area.

The CellArea is used to layout cells in the underlying TreeViewColumn for the drop-down menu.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§area

the CellArea used to layout cells

§Returns

A newly created EntryCompletion object

Source

pub fn builder() -> EntryCompletionBuilder

👎Deprecated:

Since 4.10

Creates a new builder-pattern struct instance to construct EntryCompletion objects.

This method returns an instance of EntryCompletionBuilder which can be used to create EntryCompletion objects.

Source

pub fn complete(&self)

👎Deprecated:

Since 4.10

Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key.

The completion list view will be updated accordingly.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Source

pub fn compute_prefix(&self, key: &str) -> Option<GString>

👎Deprecated:

Since 4.10

Computes the common prefix that is shared by all rows in @self that start with @key.

If no row matches @key, None will be returned. Note that a text column must have been set for this function to work, see set_text_column() for details.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§key

The text to complete for

§Returns

The common prefix all rows starting with @key

Source

pub fn completion_prefix(&self) -> Option<GString>

👎Deprecated:

Since 4.10

Get the original text entered by the user that triggered the completion or None if there’s no completion ongoing.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

the prefix for the current completion

Source

pub fn is_inline_completion(&self) -> bool

👎Deprecated:

Since 4.10

Returns whether the common prefix of the possible completions should be automatically inserted in the entry.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

true if inline completion is turned on

Source

pub fn is_inline_selection(&self) -> bool

👎Deprecated:

Since 4.10

Returns true if inline-selection mode is turned on.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

true if inline-selection mode is on

Source

pub fn minimum_key_length(&self) -> i32

👎Deprecated:

Since 4.10

Returns the minimum key length as set for @self.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

The currently used minimum key length

Source

pub fn model(&self) -> Option<TreeModel>

👎Deprecated:

Since 4.10

Returns the model the EntryCompletion is using as data source.

Returns None if the model is unset.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

A TreeModel

Source

pub fn is_popup_completion(&self) -> bool

👎Deprecated:

Since 4.10

Returns whether the completions should be presented in a popup window.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

true if popup completion is turned on

Source

pub fn is_popup_set_width(&self) -> bool

👎Deprecated:

Since 4.10

Returns whether the completion popup window will be resized to the width of the entry.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

true if the popup window will be resized to the width of the entry

Source

pub fn is_popup_single_match(&self) -> bool

👎Deprecated:

Since 4.10

Returns whether the completion popup window will appear even if there is only a single match.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

true if the popup window will appear regardless of the number of matches

Source

pub fn text_column(&self) -> i32

👎Deprecated:

Since 4.10

Returns the column in the model of @self to get strings from.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

the column containing the strings

Source

pub fn insert_prefix(&self)

👎Deprecated:

Since 4.10

Requests a prefix insertion.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Source

pub fn set_inline_completion(&self, inline_completion: bool)

👎Deprecated:

Since 4.10

Sets whether the common prefix of the possible completions should be automatically inserted in the entry.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§inline_completion

true to do inline completion

Source

pub fn set_inline_selection(&self, inline_selection: bool)

👎Deprecated:

Since 4.10

Sets whether it is possible to cycle through the possible completions inside the entry.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§inline_selection

true to do inline selection

Source

pub fn set_match_func<P: Fn(&EntryCompletion, &str, &TreeIter) -> bool + 'static>( &self, func: P, )

👎Deprecated:

Since 4.10

Sets the match function for @self to be @func.

The match function is used to determine if a row should or should not be in the completion list.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§func

the EntryCompletionMatchFunc to use

§func_data

user data for @func

§func_notify

destroy notify for @func_data.

Source

pub fn set_minimum_key_length(&self, length: i32)

👎Deprecated:

Since 4.10

Requires the length of the search key for @self to be at least @length.

This is useful for long lists, where completing using a small key takes a lot of time and will come up with meaningless results anyway (ie, a too large dataset).

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§length

the minimum length of the key in order to start completing

Source

pub fn set_model(&self, model: Option<&impl IsA<TreeModel>>)

👎Deprecated:

Since 4.10

Sets the model for a EntryCompletion.

If @self already has a model set, it will remove it before setting the new model. If model is None, then it will unset the model.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§model

the TreeModel

Source

pub fn set_popup_completion(&self, popup_completion: bool)

👎Deprecated:

Since 4.10

Sets whether the completions should be presented in a popup window.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

true to do popup completion

Source

pub fn set_popup_set_width(&self, popup_set_width: bool)

👎Deprecated:

Since 4.10

Sets whether the completion popup window will be resized to be the same width as the entry.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

true to make the width of the popup the same as the entry

Source

pub fn set_popup_single_match(&self, popup_single_match: bool)

👎Deprecated:

Since 4.10

Sets whether the completion popup window will appear even if there is only a single match.

You may want to set this to false if you are using inline-completion.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

true if the popup should appear even for a single match

Source

pub fn set_text_column(&self, column: i32)

👎Deprecated:

Since 4.10

Convenience function for setting up the most used case of this code: a completion list with just strings.

This function will set up @self to have a list displaying all (and just) strings in the completion list, and to get those strings from @column in the model of @self.

This functions creates and adds a CellRendererText for the selected column. If you need to set the text column, but don’t want the cell renderer, use g_object_set() to set the text-column property directly.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§column

the column in the model of @self to get strings from

Source

pub fn cell_area(&self) -> Option<CellArea>

👎Deprecated:

Since 4.10

The CellArea used to layout cell renderers in the treeview column.

If no area is specified when creating the entry completion with with_area(), a horizontally oriented CellAreaBox will be used.

Source

pub fn connect_cursor_on_match<F: Fn(&Self, &TreeModel, &TreeIter) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Emitted when a match from the cursor is on a match of the list.

The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by @iter.

Note that @model is the model that was passed to set_model().

§model

the TreeModel containing the matches

§iter

a TreeIter positioned at the selected match

§Returns

true if the signal has been handled

Source

pub fn connect_insert_prefix<F: Fn(&Self, &str) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Emitted when the inline autocompletion is triggered.

The default behaviour is to make the entry display the whole prefix and select the newly inserted part.

Applications may connect to this signal in order to insert only a smaller part of the @prefix into the entry - e.g. the entry used in the FileChooser inserts only the part of the prefix up to the next ‘/’.

§prefix

the common prefix of all possible completions

§Returns

true if the signal has been handled

Source

pub fn connect_match_selected<F: Fn(&Self, &TreeModel, &TreeIter) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Emitted when a match from the list is selected.

The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by @iter.

Note that @model is the model that was passed to set_model().

§model

the TreeModel containing the matches

§iter

a TreeIter positioned at the selected match

§Returns

true if the signal has been handled

Source

pub fn connect_no_matches<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Emitted when the filter model has zero number of rows in completion_complete method.

In other words when EntryCompletion is out of suggestions.

Source

pub fn connect_inline_completion_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source

pub fn connect_inline_selection_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source

pub fn connect_minimum_key_length_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source

pub fn connect_model_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source

pub fn connect_popup_completion_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source

pub fn connect_popup_set_width_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source

pub fn connect_popup_single_match_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source

pub fn connect_text_column_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated:

Since 4.10

Source§

impl EntryCompletion

Source

pub fn entry(&self) -> Option<Entry>

👎Deprecated:

Since 4.10

Gets the entry @self has been attached to.

§Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

§Returns

The entry @self has been attached to

Trait Implementations§

Source§

impl Clone for EntryCompletion

Source§

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for EntryCompletion

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for EntryCompletion

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for EntryCompletion

Source§

impl HasParamSpec for EntryCompletion

Source§

type ParamSpec = ParamSpecObject

Source§

type SetValue = EntryCompletion

Preferred value to be used as setter for the associated ParamSpec.
Source§

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, EntryCompletion>

Source§

fn param_spec_builder() -> Self::BuilderFn

Source§

impl Hash for EntryCompletion

Source§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Hashes the memory address of this object.

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IsA<Buildable> for EntryCompletion

Source§

impl IsA<CellLayout> for EntryCompletion

Source§

impl Ord for EntryCompletion

Source§

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl ParentClassIs for EntryCompletion

Source§

type Parent = Object

Source§

impl<OT: ObjectType> PartialEq<OT> for EntryCompletion

Source§

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<OT: ObjectType> PartialOrd<OT> for EntryCompletion

Source§

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StaticType for EntryCompletion

Source§

fn static_type() -> Type

Returns the type identifier of Self.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<O> BuildableExt for O
where O: IsA<Buildable>,

Source§

fn buildable_id(&self) -> Option<GString>

Gets the ID of the @self object. Read more
§

impl<T> Cast for T
where T: ObjectType,

§

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more
§

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
§

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more
§

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more
§

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 upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
§

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
§

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more
§

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more
Source§

impl<O> CellLayoutExt for O
where O: IsA<CellLayout>,

Source§

fn add_attribute( &self, cell: &impl IsA<CellRenderer>, attribute: &str, column: i32, )

👎Deprecated:

Since 4.10

Adds an attribute mapping to the list in @self. Read more
Source§

fn clear(&self)

👎Deprecated:

Since 4.10

Unsets all the mappings on all renderers on @self and removes all renderers from @self. Read more
Source§

fn clear_attributes(&self, cell: &impl IsA<CellRenderer>)

👎Deprecated:

Since 4.10

Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). Read more
Source§

fn area(&self) -> Option<CellArea>

👎Deprecated:

Since 4.10

Returns the underlying CellArea which might be @self if called on a CellArea or might be None if no CellArea is used by @self. Read more
Source§

fn cells(&self) -> Vec<CellRenderer>

👎Deprecated:

Since 4.10

Returns the cell renderers which have been added to @self. Read more
Source§

fn pack_end(&self, cell: &impl IsA<CellRenderer>, expand: bool)

👎Deprecated:

Since 4.10

Adds the @cell to the end of @self. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true. Read more
Source§

fn pack_start(&self, cell: &impl IsA<CellRenderer>, expand: bool)

👎Deprecated:

Since 4.10

Packs the @cell into the beginning of @self. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true. Read more
Source§

fn reorder(&self, cell: &impl IsA<CellRenderer>, position: i32)

👎Deprecated:

Since 4.10

Re-inserts @cell at @position. Read more
Source§

fn set_cell_data_func<P: Fn(&CellLayout, &CellRenderer, &TreeModel, &TreeIter) + 'static>( &self, cell: &impl IsA<CellRenderer>, func: P, )

👎Deprecated:

Since 4.10

Sets the CellLayoutDataFunc to use for @self. Read more
Source§

impl<O> CellLayoutExtManual for O
where O: IsA<CellLayout>,

Source§

fn set_attributes( &self, cell: &impl IsA<CellRenderer>, attributes: &[(&str, i32)], )

👎Deprecated:

Since 4.10

Sets the attributes in the parameter list as the attributes of @self. Read more
Source§

fn unset_cell_data_func(&self, cell: &impl IsA<CellRenderer>)

👎Deprecated:

Since 4.10

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize, ) -> Vec<T>

§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize, ) -> Vec<T>

§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

Source§

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

Source§

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.
Source§

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.
Source§

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

§

fn into_closure_return_value(self) -> Option<Value>

§

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>,

§

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,

§

impl<T> ObjectExt for T
where T: ObjectType,

§

fn is<U>(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.
§

fn type_(&self) -> Type

Returns the type of the object.
§

fn object_class(&self) -> &Class<Object>

Returns the [ObjectClass] of the object. Read more
§

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.
§

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more
§

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more
§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
§

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
§

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
§

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
§

fn has_property(&self, property_name: &str) -> bool

Check if the object has a property property_name.
§

fn has_property_with_type(&self, property_name: &str, type_: Type) -> bool

Check if the object has a property property_name of the given type_.
§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
§

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
§

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
§

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
§

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
§

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
§

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
§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
§

fn connect<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more
§

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
§

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more
§

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
§

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
§

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
§

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
§

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
§

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.
§

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R
where R: TryFromClosureReturnValue,

Emit signal by signal id. Read more
§

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as [Self::emit] but takes Value for the arguments.
§

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R
where R: TryFromClosureReturnValue,

Emit signal by its name. Read more
§

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value], ) -> Option<Value>

Emit signal by its name. Read more
§

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
§

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
§

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
§

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
§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
§

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more
§

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more
§

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F, ) -> SignalHandlerId
where F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more
§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
§

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
§

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
§

fn bind_property<'a, 'f, 't, O>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str, ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

§

impl<T> StaticTypeExt for T
where T: StaticType,

§

fn ensure_type()

Ensures that the type has been registered with the type system.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TransparentType for T
where T: TransparentPtrType,

§

type GlibType = <T as GlibPtrDefault>::GlibType

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

§

fn try_from_closure_return_value(v: Option<Value>) -> Result<T, BoolError>

Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.