Struct gtk::ComboBoxText

#[repr(transparent)]
pub struct ComboBoxText { /* private fields */ }

A GtkComboBoxText is a simple variant of ComboBox that hides the model-view complexity for simple text-only use cases.

To create a GtkComboBoxText, use new() or with_entry().

You can add items to a GtkComboBoxText with ComboBoxTextExt::append_text(), ComboBoxTextExt::insert_text() or ComboBoxTextExt::prepend_text() and remove options with ComboBoxTextExt::remove().

If the GtkComboBoxText contains an entry (via the “has-entry” property), its contents can be retrieved using ComboBoxTextExt::active_text(). The entry itself can be accessed by calling BinExt::child() on the combo box.

You should not call ComboBoxExt::set_model() or attempt to pack more cells into this combo box via its GtkCellLayout interface.

GtkComboBoxText as GtkBuildable

The GtkComboBoxText implementation of the GtkBuildable interface supports adding items directly using the <items> element and specifying <item> elements for each item. Each <item> element can specify the “id” corresponding to the appended text and also supports the regular translation attributes “translatable”, “context” and “comments”.

Here is a UI definition fragment specifying GtkComboBoxText items:

⚠️ The following code is in xml ⚠️

<object class="GtkComboBoxText">
  <items>
    <item translatable="yes" id="factory">Factory</item>
    <item translatable="yes" id="home">Home</item>
    <item translatable="yes" id="subway">Subway</item>
  </items>
</object>

CSS nodes

⚠️ The following code is in plain ⚠️

combobox
╰── box.linked
    ├── entry.combo
    ├── button.combo
    ╰── window.popup

GtkComboBoxText has a single CSS node with name combobox. It adds the style class .combo to the main CSS nodes of its entry and button children, and the .linked class to the node of its internal box.

Implements

ComboBoxTextExt, ComboBoxExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, CellEditableExt, CellLayoutExt, ComboBoxExtManual, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl ComboBoxText

pub const NONE: Option<&'static ComboBoxText> = None

pub fn new() -> ComboBoxText

Creates a new ComboBoxText, which is a ComboBox just displaying strings.

Returns

A new ComboBoxText

pub fn with_entry() -> ComboBoxText

Creates a new ComboBoxText, which is a ComboBox just displaying strings. The combo box created by this function has an entry.

Returns

a new ComboBoxText

pub fn builder() -> ComboBoxTextBuilder

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

This method returns an instance of ComboBoxTextBuilder which can be used to create ComboBoxText objects.

Trait Implementations

impl Clone for ComboBoxText

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComboBoxText

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

Formats the value using the given formatter.

impl Default for ComboBoxText

fn default() -> Self

Returns the “default value” for a type.

impl Display for ComboBoxText

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

Formats the value using the given formatter.

impl Hash for ComboBoxText

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,

Feeds a slice of this type into the given Hasher.

impl Ord for ComboBoxText

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ComboBoxText

type Parent = ComboBox

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

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

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

const 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 ComboBoxText

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

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

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

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

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

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

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

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

const 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 ComboBoxText

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ComboBoxText

impl IsA<Bin> for ComboBoxText

impl IsA<Buildable> for ComboBoxText

impl IsA<CellEditable> for ComboBoxText

impl IsA<CellLayout> for ComboBoxText

impl IsA<ComboBox> for ComboBoxText

impl IsA<Container> for ComboBoxText

impl IsA<Widget> for ComboBoxText