Struct gtk4::StringList

pub struct StringList { /* private fields */ }

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

The objects in the model are of type StringObject and have a “string” property that can be used inside expressions.

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>

Properties

item-type

The type of items. See [ListModelExtManual::item_type()][crate::gio::prelude::ListModelExtManual::item_type()].

Readable

n-items

The number of items. See [ListModelExtManual::n_items()][crate::gio::prelude::ListModelExtManual::n_items()].

Readable

strings

Writeable | Construct Only

Implements

[trait@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 Gtk::StringList::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

Trait Implementations

impl Clone for StringList

fn clone(&self) -> Self

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 Default for StringList

fn default() -> Self

Returns the “default value” for a type.

impl Extend<&'static str> for StringList

fn extend<T: IntoIterator<Item = &'static str>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<String> for StringList

fn extend<T: IntoIterator<Item = String>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<&'static str> for StringList

fn from_iter<I: IntoIterator<Item = &'static str>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<String> for StringList

fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self

Creates a value from an iterator.

impl HasParamSpec for StringList

type ParamSpec = ParamSpecObject

type SetValue = StringList

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for StringList

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StringList

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for StringList

type Parent = Object

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

fn eq(&self, other: &OT) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn partial_cmp(&self, other: &OT) -> 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