Struct gtk::ComboBox

source · [−]

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

Expand description

A GtkComboBox is a widget that allows the user to choose from a list of valid choices. The GtkComboBox displays the selected choice. When activated, the GtkComboBox displays a popup which allows the user to make a new choice. The style in which the selected value is displayed, and the style of the popup is determined by the current theme. It may be similar to a Windows-style combo box.

The GtkComboBox uses the model-view pattern; the list of valid choices is specified in the form of a tree model, and the display of the choices can be adapted to the data in the model by using cell renderers, as you would in a tree view. This is possible since GtkComboBox implements the CellLayout interface. The tree model holding the valid choices is not restricted to a flat list, it can be a real tree, and the popup will reflect the tree structure.

To allow the user to enter values not in the model, the “has-entry” property allows the GtkComboBox to contain a Entry. This entry can be accessed by calling BinExt::child() on the combo box.

For a simple list of textual choices, the model-view API of GtkComboBox can be a bit overwhelming. In this case, ComboBoxText offers a simple alternative. Both GtkComboBox and ComboBoxText can contain an entry.

CSS nodes

⚠️ The following code is in plain ⚠️

combobox
├── box.linked
│   ╰── button.combo
│       ╰── box
│           ├── cellview
│           ╰── arrow
╰── window.popup

A normal combobox contains a box with the .linked class, a button with the .combo class and inside those buttons, there are a cellview and an arrow.

⚠️ The following code is in plain ⚠️

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

A GtkComboBox with an entry has a single CSS node with name combobox. It contains a box with the .linked class. That box contains an entry and a button, both with the .combo class added. The button also contains another node with name arrow.

Implements

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

Struct gtk::ComboBox

Implementations

impl ComboBox

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

pub fn new() -> ComboBox

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

pub fn with_area_and_entry(area: &impl IsA<CellArea>) -> ComboBox

pub fn with_entry() -> ComboBox

pub fn with_model(model: &impl IsA<TreeModel>) -> ComboBox

pub fn with_model_and_entry(model: &impl IsA<TreeModel>) -> ComboBox

pub fn builder() -> ComboBoxBuilder

Trait Implementations

impl Clone for ComboBox

fn clone(&self) -> Self

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

impl Debug for ComboBox

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

impl Default for ComboBox

fn default() -> Self

impl Display for ComboBox

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

impl Hash for ComboBox

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

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

impl Ord for ComboBox

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

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

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

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

impl ParentClassIs for ComboBox

type Parent = Bin

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

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

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

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

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

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

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

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

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

impl StaticType for ComboBox

fn static_type() -> Type

impl Eq for ComboBox

impl IsA<Bin> for ComboBox

impl IsA<Buildable> for ComboBox

impl IsA<CellEditable> for ComboBox

impl IsA<CellLayout> for ComboBox

impl IsA<ComboBox> for AppChooserButton

impl IsA<ComboBox> for ComboBoxText

impl IsA<Container> for ComboBox

impl IsA<Widget> for ComboBox

Auto Trait Implementations

impl RefUnwindSafe for ComboBox

impl !Send for ComboBox

impl !Sync for ComboBox

impl Unpin for ComboBox

impl UnwindSafe for ComboBox

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Cast for Twhere T: ObjectType,

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

fn upcast_ref<T>(&self) -> &Twhere T: ObjectType, Self: IsA<T>,

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

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

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

fn dynamic_cast_ref<T>(&self) -> Option<&T>where T: ObjectType,

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<U> IsSubclassableExt for Uwhere 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>,

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

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

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

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

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

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

impl<T> Cast for Twhere
T: ObjectType,

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

fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,

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

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

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

fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,

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

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

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

impl<U> IsSubclassableExt for Uwhere
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<T> ObjectExt for Twhere
T: ObjectType,

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

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

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

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

fn set_property<V>(&self, property_name: &str, value: V)where
V: ToValue,

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

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,

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

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

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

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

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

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

fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId

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

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

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

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

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

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

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

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

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

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