Struct gtk4::ListStore

source ·
pub struct ListStore { /* private fields */ }
👎Deprecated: Since 4.10
Expand description

Use Gio::ListStore instead A list-like data structure that can be used with the TreeView.

The ListStore object is a list model for use with a TreeView widget. It implements the TreeModel interface, and consequentialy, can use all of the methods available there. It also implements the TreeSortable interface so it can be sorted by the view. Finally, it also implements the tree drag and drop interfaces.

The ListStore can accept most GTypes as a column type, though it can’t accept all custom types. Internally, it will keep a copy of data passed in (such as a string or a boxed pointer). Columns that accept GObjects are handled a little differently. The ListStore will keep a reference to the object instead of copying the value. As a result, if the object is modified, it is up to the application writer to call TreeModelExt::row_changed() to emit the row_changed signal. This most commonly affects lists with gdk::Textures stored.

An example for creating a simple list store:

⚠️ The following code is in c ⚠️

enum {
  COLUMN_STRING,
  COLUMN_INT,
  COLUMN_BOOLEAN,
  N_COLUMNS
};

{
  GtkListStore *list_store;
  GtkTreePath *path;
  GtkTreeIter iter;
  int i;

  list_store = gtk_list_store_new (N_COLUMNS,
                                   G_TYPE_STRING,
                                   G_TYPE_INT,
                                   G_TYPE_BOOLEAN);

  for (i = 0; i < 10; i++)
    {
      char *some_data;

      some_data = get_some_data (i);

      // Add a new row to the model
      gtk_list_store_append (list_store, &iter);
      gtk_list_store_set (list_store, &iter,
                          COLUMN_STRING, some_data,
                          COLUMN_INT, i,
                          COLUMN_BOOLEAN,  FALSE,
                          -1);

      // As the store will keep a copy of the string internally,
      // we free some_data.
      g_free (some_data);
    }

  // Modify a particular row
  path = gtk_tree_path_new_from_string ("4");
  gtk_tree_model_get_iter (GTK_TREE_MODEL (list_store),
                           &iter,
                           path);
  gtk_tree_path_free (path);
  gtk_list_store_set (list_store, &iter,
                      COLUMN_BOOLEAN, TRUE,
                      -1);
}

ListStore is deprecated since GTK 4.10, and should not be used in newly written code. You should use Gio::ListStore instead, and the various list models provided by GTK.

§Performance Considerations

Internally, the ListStore was originally implemented with a linked list with a tail pointer. As a result, it was fast at data insertion and deletion, and not fast at random data access. The ListStore sets the GTK_TREE_MODEL_ITERS_PERSIST flag, which means that TreeIters can be cached while the row exists. Thus, if access to a particular row is needed often and your code is expected to run on older versions of GTK, it is worth keeping the iter around.

§Atomic Operations

It is important to note that only the methods gtk_list_store_insert_with_values() and gtk_list_store_insert_with_valuesv() are atomic, in the sense that the row is being appended to the store and the values filled in in a single operation with regard to TreeModel signaling. In contrast, using e.g. gtk_list_store_append() and then gtk_list_store_set() will first create a row, which triggers the GtkTreeModel::row-inserted signal on ListStore. The row, however, is still empty, and any signal handler connecting to GtkTreeModel::row-inserted on this particular store should be prepared for the situation that the row might be empty. This is especially important if you are wrapping the ListStore inside a TreeModelFilter and are using a TreeModelFilterVisibleFunc. Using any of the non-atomic operations to append rows to the ListStore will cause the TreeModelFilterVisibleFunc to be visited with an empty row first; the function must be prepared for that.

§GtkListStore as GtkBuildable

The GtkListStore implementation of the Buildable interface allows to specify the model columns with a <columns> element that may contain multiple <column> elements, each specifying one model column. The “type” attribute specifies the data type for the column.

Additionally, it is possible to specify content for the list store in the UI definition, with the <data> element. It can contain multiple <row> elements, each specifying to content for one row of the list model. Inside a <row>, the <col> elements specify the content for individual cells.

Note that it is probably more common to define your models in the code, and one might consider it a layering violation to specify the content of a list store in a UI definition, data, not presentation, and common wisdom is to separate the two, as far as possible.

An example of a UI Definition fragment for a list store:

<object class="GtkListStore">
  <columns>
    <column type="gchararray"/>
    <column type="gchararray"/>
    <column type="gint"/>
  </columns>
  <data>
    <row>
      <col id="0">John</col>
      <col id="1">Doe</col>
      <col id="2">25</col>
    </row>
    <row>
      <col id="0">Johan</col>
      <col id="1">Dahlin</col>
      <col id="2">50</col>
    </row>
  </data>
</object>

§Implements

[trait@glib::ObjectExt], BuildableExt, TreeDragDestExt, TreeDragSourceExt, TreeModelExt, TreeSortableExt, TreeModelExtManual, TreeSortableExtManual

Implementations§

source§

impl ListStore

source

pub fn append(&self) -> TreeIter

👎Deprecated: Since 4.10

Appends a new row to @self. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

§Deprecated since 4.10

Use list models

§Returns
§iter

An unset TreeIter to set to the appended row

source

pub fn clear(&self)

👎Deprecated: Since 4.10

Removes all rows from the list store.

§Deprecated since 4.10

Use list models

source

pub fn insert(&self, position: i32) -> TreeIter

👎Deprecated: Since 4.10

Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1 or is larger than the number of rows on the list, then the new row will be appended to the list. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

§Deprecated since 4.10

Use list models

§position

position to insert the new row, or -1 for last

§Returns
§iter

An unset TreeIter to set to the new row

source

pub fn insert_after(&self, sibling: Option<&TreeIter>) -> TreeIter

👎Deprecated: Since 4.10

Inserts a new row after @sibling. If @sibling is None, then the row will be prepended to the beginning of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

§Deprecated since 4.10

Use list models

§sibling

A valid TreeIter

§Returns
§iter

An unset TreeIter to set to the new row

source

pub fn insert_before(&self, sibling: Option<&TreeIter>) -> TreeIter

👎Deprecated: Since 4.10

Inserts a new row before @sibling. If @sibling is None, then the row will be appended to the end of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

§Deprecated since 4.10

Use list models

§sibling

A valid TreeIter

§Returns
§iter

An unset TreeIter to set to the new row

source

pub fn iter_is_valid(&self, iter: &TreeIter) -> bool

👎Deprecated: Since 4.10

Checks if the given iter is a valid iter for this ListStore.

This function is slow. Only use it for debugging and/or testing purposes.

§Deprecated since 4.10

Use list models

§iter

the iterator to check

§Returns

true if the iter is valid, false if the iter is invalid.

source

pub fn move_after(&self, iter: &TreeIter, position: Option<&TreeIter>)

👎Deprecated: Since 4.10

Moves @iter in @self to the position after @position. Note that this function only works with unsorted stores. If @position is None, @iter will be moved to the start of the list.

§Deprecated since 4.10

Use list models

§iter

A TreeIter

§position

A TreeIter

source

pub fn move_before(&self, iter: &TreeIter, position: Option<&TreeIter>)

👎Deprecated: Since 4.10

Moves @iter in @self to the position before @position. Note that this function only works with unsorted stores. If @position is None, @iter will be moved to the end of the list.

§Deprecated since 4.10

Use list models

§iter

A TreeIter

§position

A TreeIter

source

pub fn prepend(&self) -> TreeIter

👎Deprecated: Since 4.10

Prepends a new row to @self. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

§Deprecated since 4.10

Use list models

§Returns
§iter

An unset TreeIter to set to the prepend row

source

pub fn remove(&self, iter: &TreeIter) -> bool

👎Deprecated: Since 4.10

Removes the given row from the list store. After being removed, @iter is set to be the next valid row, or invalidated if it pointed to the last row in @self.

§Deprecated since 4.10

Use list models

§iter

A valid TreeIter

§Returns

true if @iter is valid, false if not.

source

pub fn swap(&self, a: &TreeIter, b: &TreeIter)

👎Deprecated: Since 4.10

Swaps @a and @b in @self. Note that this function only works with unsorted stores.

§Deprecated since 4.10

Use list models

§a

A TreeIter

§b

Another TreeIter

source§

impl ListStore

source

pub fn new(column_types: &[Type]) -> Self

👎Deprecated: Since 4.10

Creates a new list store.

The list store will have @n_columns columns, with each column using the given type passed to this function.

Note that only types derived from standard GObject fundamental types are supported.

As an example:

⚠️ The following code is in c ⚠️

gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING, GDK_TYPE_TEXTURE);

will create a new ListStore with three columns, of type int, gchararray and gdk::Texture, respectively.

§Deprecated since 4.10

Use Gio::ListStore instead

§Returns

a new ListStore

source

pub fn insert_with_values( &self, position: Option<u32>, columns_and_values: &[(u32, &dyn ToValue)] ) -> TreeIter

👎Deprecated: Since 4.10

A variant of gtk_list_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs.

This function is mainly intended for language-bindings.

§Deprecated since 4.10

Use list models

§position

position to insert the new row, or -1 for last

§columns

an array of column numbers

§values

an array of GValues

§Returns
§iter

An unset TreeIter to set to the new row

source

pub fn reorder(&self, new_order: &[u32])

👎Deprecated: Since 4.10

Reorders @self to follow the order indicated by @new_order. Note that this function only works with unsorted stores.

§Deprecated since 4.10

Use list models

§new_order

an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. @new_order[newpos] = oldpos. It must have exactly as many items as the list store’s length.

source

pub fn set(&self, iter: &TreeIter, columns_and_values: &[(u32, &dyn ToValue)])

👎Deprecated: Since 4.10

Sets the value of one or more cells in the row referenced by @iter. The variable argument list should contain integer column numbers, each column number followed by the value to be set. The list is terminated by a -1. For example, to set column 0 with type G_TYPE_STRING to “Foo”, you would write gtk_list_store_set (store, iter, 0, "Foo", -1).

The value will be referenced by the store if it is a G_TYPE_OBJECT, and it will be copied if it is a G_TYPE_STRING or G_TYPE_BOXED.

§Deprecated since 4.10

Use list models

§iter

row iterator

source

pub fn set_column_types(&self, types: &[Type])

👎Deprecated: Since 4.10

Sets the types of the columns of a list store.

This function is meant primarily for objects that inherit from ListStore, and should only be used when constructing a new instance.

This function cannot be called after a row has been added, or a method on the TreeModel interface is called.

§Deprecated since 4.10

Use list models

§types

An array length n of GTypes

source

pub fn set_value(&self, iter: &TreeIter, column: u32, value: &Value)

👎Deprecated: Since 4.10

Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column.

§Deprecated since 4.10

Use list models

§iter

A valid TreeIter for the row being modified

§column

column number to modify

§value

new value for the cell

Trait Implementations§

source§

impl Clone for ListStore

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ListStore

source§

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

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

impl HasParamSpec for ListStore

§

type ParamSpec = ParamSpecObject

§

type SetValue = ListStore

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

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

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for ListStore

source§

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

Feeds this value into the given Hasher. Read more
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 Ord for ListStore

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

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

impl ParentClassIs for ListStore

source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method 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 ListStore

source§

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 · source§

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 · source§

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
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl StaticType for ListStore

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for ListStore

source§

impl IsA<Buildable> for ListStore

source§

impl IsA<TreeDragDest> for ListStore

source§

impl IsA<TreeDragSource> for ListStore

source§

impl IsA<TreeModel> for ListStore

source§

impl IsA<TreeSortable> for ListStore

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

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

source§

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

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

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

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

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

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

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

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

Casts to T unconditionally. Read more
source§

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

Casts to &T unconditionally. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

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

source§

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

source§

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

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

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

source§

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

source§

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

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.

source§

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

source§

impl<U> IsSubclassableExt for U

source§

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

source§

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

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

fn type_(&self) -> Type

Returns the type of the object.
source§

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

Returns the ObjectClass of the object. Read more
source§

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

Returns the class of the object.
source§

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

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

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

Returns the interface T of the object. Read more
source§

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

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

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

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

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

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

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

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

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

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

Gets the property property_name of the object. Read more
source§

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

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

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

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

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

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

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

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

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

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

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

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

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

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

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

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

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

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

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

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

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

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

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

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

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

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

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

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

Emit signal by signal id. Read more
source§

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

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

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

Emit signal by its name. Read more
source§

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

Emit signal by its name. Read more
source§

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by its name with details. Read more
source§

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

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by signal id with details. Read more
source§

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

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

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

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

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

fn notify(&self, property_name: &str)

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

fn notify_by_pspec(&self, pspec: &ParamSpec)

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

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

Downgrade this object to a weak reference.
source§

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

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

fn bind_property<'f, 't, O, 'a>( &'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
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

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

§

type Value = T

source§

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

§

type Value = T

source§

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

source§

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

source§

fn ensure_type()

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

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

§

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

impl<T> TransparentType for T

source§

impl<O> TreeDragDestExt for O
where O: IsA<TreeDragDest>,

source§

fn drag_data_received(&self, dest: &TreePath, value: &Value) -> bool

👎Deprecated: Since 4.10
Asks the TreeDragDest to insert a row before the path @dest, deriving the contents of the row from @value. If @dest is outside the tree so that inserting before it is impossible, false will be returned. Also, false may be returned if the new row is not created for some model-specific reason. Should robustly handle a @dest no longer found in the model! Read more
source§

fn row_drop_possible(&self, dest_path: &TreePath, value: &Value) -> bool

👎Deprecated: Since 4.10
Determines whether a drop is possible before the given @dest_path, at the same depth as @dest_path. i.e., can we drop the data in @value at that location. @dest_path does not have to exist; the return value will almost certainly be false if the parent of @dest_path doesn’t exist, though. Read more
source§

impl<O> TreeDragSourceExt for O
where O: IsA<TreeDragSource>,

source§

fn drag_data_delete(&self, path: &TreePath) -> bool

👎Deprecated: Since 4.10
Asks the TreeDragSource to delete the row at @path, because it was moved somewhere else via drag-and-drop. Returns false if the deletion fails because @path no longer exists, or for some model-specific reason. Should robustly handle a @path no longer found in the model! Read more
source§

fn drag_data_get(&self, path: &TreePath) -> Option<ContentProvider>

👎Deprecated: Since 4.10
Asks the TreeDragSource to return a gdk::ContentProvider representing the row at @path. Should robustly handle a @path no longer found in the model! Read more
source§

fn row_draggable(&self, path: &TreePath) -> bool

👎Deprecated: Since 4.10
Asks the TreeDragSource whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable. Read more
source§

impl<O> TreeModelExt for O
where O: IsA<TreeModel>,

source§

fn foreach<P: FnMut(&TreeModel, &TreePath, &TreeIter) -> bool>(&self, func: P)

👎Deprecated: Since 4.10
Calls @func on each node in model in a depth-first fashion. Read more
source§

fn column_type(&self, index_: i32) -> Type

👎Deprecated: Since 4.10
Returns the type of the column. Read more
source§

fn flags(&self) -> TreeModelFlags

👎Deprecated: Since 4.10
Returns a set of flags supported by this interface. Read more
source§

fn iter(&self, path: &TreePath) -> Option<TreeIter>

👎Deprecated: Since 4.10
Sets @iter to a valid iterator pointing to @path. Read more
source§

fn iter_first(&self) -> Option<TreeIter>

👎Deprecated: Since 4.10
Initializes @iter with the first iterator in the tree (the one at the path “0”). Read more
source§

fn iter_from_string(&self, path_string: &str) -> Option<TreeIter>

👎Deprecated: Since 4.10
Sets @iter to a valid iterator pointing to @path_string, if it exists. Read more
source§

fn n_columns(&self) -> i32

👎Deprecated: Since 4.10
Returns the number of columns supported by @self. Read more
source§

fn path(&self, iter: &TreeIter) -> TreePath

👎Deprecated: Since 4.10
Returns a newly-created TreePath referenced by @iter. Read more
source§

fn string_from_iter(&self, iter: &TreeIter) -> Option<GString>

👎Deprecated: Since 4.10
Generates a string representation of the iter. Read more
source§

fn iter_children(&self, parent: Option<&TreeIter>) -> Option<TreeIter>

👎Deprecated: Since 4.10
Sets @iter to point to the first child of @parent. Read more
source§

fn iter_has_child(&self, iter: &TreeIter) -> bool

👎Deprecated: Since 4.10
Returns true if @iter has children, false otherwise. Read more
source§

fn iter_n_children(&self, iter: Option<&TreeIter>) -> i32

👎Deprecated: Since 4.10
Returns the number of children that @iter has. Read more
source§

fn iter_next(&self, iter: &TreeIter) -> bool

👎Deprecated: Since 4.10
Sets @iter to point to the node following it at the current level. Read more
source§

fn iter_nth_child(&self, parent: Option<&TreeIter>, n: i32) -> Option<TreeIter>

👎Deprecated: Since 4.10
Sets @iter to be the child of @parent, using the given index. Read more
source§

fn iter_parent(&self, child: &TreeIter) -> Option<TreeIter>

👎Deprecated: Since 4.10
Sets @iter to be the parent of @child. Read more
source§

fn iter_previous(&self, iter: &TreeIter) -> bool

👎Deprecated: Since 4.10
Sets @iter to point to the previous node at the current level. Read more
source§

fn row_changed(&self, path: &TreePath, iter: &TreeIter)

👎Deprecated: Since 4.10
Emits the ::row-changed signal on @self. Read more
source§

fn row_deleted(&self, path: &TreePath)

👎Deprecated: Since 4.10
Emits the ::row-deleted signal on @self. Read more
source§

fn row_has_child_toggled(&self, path: &TreePath, iter: &TreeIter)

👎Deprecated: Since 4.10
Emits the ::row-has-child-toggled signal on @self. Read more
source§

fn row_inserted(&self, path: &TreePath, iter: &TreeIter)

👎Deprecated: Since 4.10
Emits the ::row-inserted signal on @self. Read more
source§

fn connect_row_changed<F: Fn(&Self, &TreePath, &TreeIter) + 'static>( &self, f: F ) -> SignalHandlerId

👎Deprecated: Since 4.10
This signal is emitted when a row in the model has changed. Read more
source§

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

👎Deprecated: Since 4.10
This signal is emitted when a row has been deleted. Read more
source§

fn connect_row_has_child_toggled<F: Fn(&Self, &TreePath, &TreeIter) + 'static>( &self, f: F ) -> SignalHandlerId

👎Deprecated: Since 4.10
This signal is emitted when a row has gotten the first child row or lost its last child row. Read more
source§

fn connect_row_inserted<F: Fn(&Self, &TreePath, &TreeIter) + 'static>( &self, f: F ) -> SignalHandlerId

👎Deprecated: Since 4.10
This signal is emitted when a new row has been inserted in the model. Read more
source§

impl<O> TreeModelExtManual for O
where O: IsA<TreeModel>,

source§

fn get_value(&self, iter: &TreeIter, column: i32) -> Value

👎Deprecated: Since 4.10
source§

fn get<V: for<'b> FromValue<'b> + 'static>( &self, iter: &TreeIter, column: i32 ) -> V

👎Deprecated: Since 4.10
Similar to Self::get_value but panics if the value is of a different type. Gets the value of one or more cells in the row referenced by @iter. Read more
source§

impl<O> TreeSortableExt for O
where O: IsA<TreeSortable>,

source§

fn has_default_sort_func(&self) -> bool

👎Deprecated: Since 4.10
Returns true if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not. Read more
source§

fn sort_column_changed(&self)

👎Deprecated: Since 4.10
Emits a GtkTreeSortable::sort-column-changed signal on @self. Read more
source§

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

👎Deprecated: Since 4.10
The ::sort-column-changed signal is emitted when the sort column or sort order of @sortable is changed. The signal is emitted before the contents of @sortable are resorted.
source§

impl<O> TreeSortableExtManual for O
where O: IsA<TreeSortable>,

source§

fn set_default_sort_func<F>(&self, sort_func: F)
where F: Fn(&Self, &TreeIter, &TreeIter) -> Ordering + 'static,

👎Deprecated: Since 4.10
Sets the default comparison function used when sorting to be @sort_func. If the current sort column id of @self is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. Read more
source§

fn set_sort_func<F>(&self, sort_column_id: SortColumn, sort_func: F)
where F: Fn(&Self, &TreeIter, &TreeIter) -> Ordering + 'static,

👎Deprecated: Since 4.10
Sets the comparison function used when sorting to be @sort_func. If the current sort column id of @self is the same as @sort_column_id, then the model will sort using this function. Read more
source§

fn sort_column_id(&self) -> Option<(SortColumn, SortType)>

👎Deprecated: Since 4.10
Fills in @sort_column_id and @order with the current sort column and the order. It returns true unless the @sort_column_id is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. Read more
source§

fn set_sort_column_id(&self, sort_column_id: SortColumn, order: SortType)

👎Deprecated: Since 4.10
Sets the current sort column to be @sort_column_id. The @self will resort itself to reflect this change, after emitting a GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be a regular column id, or one of the following special values: Read more
source§

fn set_unsorted(&self)

👎Deprecated: Since 4.10
source§

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

§

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

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

source§

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

§

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

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<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,