Struct gtk4::StringList

pub struct StringList(_);

StringList is a list model that wraps an array of strings.

The objects in the model have a “string” property.

StringList is well-suited for any place where you would typically use a char*[], but need a list model.

GtkStringList as GtkBuildable

The StringList implementation of the Buildable interface supports adding items directly using the <items> element and specifying <item> elements for each item. Each <item> element supports the regular translation attributes “translatable”, “context” and “comments”.

Here is a UI definition fragment specifying a StringList

<object class="GtkStringList">
  <items>
    <item translatable="yes">Factory</item>
    <item translatable="yes">Home</item>
    <item translatable="yes">Subway</item>
  </items>
</object>

Implements

glib::ObjectExt, gio::prelude::ListModelExt, BuildableExt

Implementations

impl StringList

pub fn new(strings: &[&str]) -> StringList

Creates a new StringList with the given strings.

strings

The strings to put in the model

Returns

a new StringList

pub fn append(&self, string: &str)

Appends string to self.

The string will be copied. See take() for a way to avoid that.

string

the string to insert

pub fn string(&self, position: u32) -> Option<GString>

Gets the string that is at position in self.

If self does not contain position items, None is returned.

This function returns the const char *. To get the object wrapping it, use g_list_model_get_item().

position

the position to get the string for

Returns

the string at the given position

pub fn remove(&self, position: u32)

Removes the string at position from self.

position must be smaller than the current length of the list.

position

the position of the string that is to be removed

pub fn splice(&self, position: u32, n_removals: u32, additions: &[&str])

Changes self by removing n_removals strings and adding additions to it.

This function is more efficient than append() and remove(), because it only emits the ::items-changed signal once for the change.

This function copies the strings in additions.

The parameters position and n_removals must be correct (ie: position + n_removals must be less than or equal to the length of the list at the time this function is called).

position

the position at which to make the change

n_removals

the number of strings to remove

additions

The strings to add

pub fn take(&self, string: &str)

Adds string to self at the end, and takes ownership of it.

This variant of append() is convenient for formatting strings:

⚠️ The following code is in c ⚠️

gtk_string_list_take (self, g_strdup_print ("%d dollars", lots));

string

the string to insert

Trait Implementations

impl Clone for StringList

fn clone(&self) -> StringList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringList

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

Formats the value using the given formatter.

impl Display for StringList

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

Formats the value using the given formatter.

impl Hash for StringList

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for StringList

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for StringList

type Parent = Object

impl<T: ObjectType> PartialEq<T> for StringList

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

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

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

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for StringList

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for StringList

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StringList

impl IsA<Buildable> for StringList

impl IsA<ListModel> for StringList

impl StructuralEq for StringList