ComboBoxRef

public struct ComboBoxRef : ComboBoxProtocol, GWeakCapturing

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 GtkCellLayout 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 GtkEntry. This entry can be accessed by calling gtk_bin_get_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, GtkComboBoxText offers a simple alternative. Both GtkComboBox and GtkComboBoxText can contain an entry.

CSS nodes

(plain Language Example):

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.

(plain Language Example):

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.

The ComboBoxRef type acts as a lightweight Swift reference to an underlying GtkComboBox instance. It exposes methods that can operate on this data type through ComboBoxProtocol conformance. Use ComboBoxRef only as an unowned reference to an existing GtkComboBox instance.

Show on GitHub

ptr
```
Untyped pointer to the underlying `GtkComboBox` instance.
```
For type-safe access, use the generated, typed pointer combo_box_ptr property instead.
Declaration
Swift

public let ptr: UnsafeMutableRawPointer!
Show on GitHub

ComboBox Class

init(_:)
Designated initialiser from the underlying C data type
Declaration
Swift

@inlinable init(_ p: UnsafeMutablePointer<GtkComboBox>)
Show on GitHub
init(_:)
Designated initialiser from a constant pointer to the underlying C data type
Declaration
Swift

@inlinable init(_ p: UnsafePointer<GtkComboBox>)
Show on GitHub
init(_:)
Conditional initialiser from an optional pointer to the underlying C data type
Declaration
Swift

@inlinable init!(_ maybePointer: UnsafeMutablePointer<GtkComboBox>?)
Show on GitHub
init(_:)
Conditional initialiser from an optional, non-mutable pointer to the underlying C data type
Declaration
Swift

@inlinable init!(_ maybePointer: UnsafePointer<GtkComboBox>?)
Show on GitHub
init(gpointer:)
Conditional initialiser from an optional gpointer
Declaration
Swift

@inlinable init!(gpointer g: gpointer?)
Show on GitHub
init(gconstpointer:)
Conditional initialiser from an optional, non-mutable gconstpointer
Declaration
Swift

@inlinable init!(gconstpointer g: gconstpointer?)
Show on GitHub
init(_:)
Reference intialiser for a related type that implements ComboBoxProtocol
Declaration
Swift

@inlinable init<T>(_ other: T) where T : ComboBoxProtocol
Show on GitHub
unowned(_:)
This factory is syntactic sugar for setting weak pointers wrapped in GWeak<T>
Declaration
Swift

@inlinable static func unowned<T>(_ other: T) -> ComboBoxRef where T : ComboBoxProtocol
Show on GitHub
init(cPointer:)
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ComboBoxProtocol.
Declaration
Swift

@inlinable init<T>(cPointer: UnsafeMutablePointer<T>)
Show on GitHub
init(constPointer:)
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ComboBoxProtocol.
Declaration
Swift

@inlinable init<T>(constPointer: UnsafePointer<T>)
Show on GitHub
init(mutating:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ComboBoxProtocol.
Declaration
Swift

@inlinable init(mutating raw: UnsafeRawPointer)
Show on GitHub
init(raw:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ComboBoxProtocol.
Declaration
Swift

@inlinable init(raw: UnsafeMutableRawPointer)
Show on GitHub
init(opaquePointer:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ComboBoxProtocol.
Declaration
Swift

@inlinable init(opaquePointer: OpaquePointer)
Show on GitHub
init()
Creates a new empty GtkComboBox.
Declaration
Swift

@available(*, deprecated) @inlinable init()
Show on GitHub
init(area:)
Creates a new empty GtkComboBox using area to layout cells.
Declaration
Swift

@inlinable init<CellAreaT>(area: CellAreaT) where CellAreaT : CellAreaProtocol
Show on GitHub
init(areaAndEntry:)
Creates a new empty GtkComboBox with an entry.

The new combo box will use area to layout cells.
Declaration
Swift

@inlinable init<CellAreaT>(areaAndEntry area: CellAreaT) where CellAreaT : CellAreaProtocol
Show on GitHub
init(model:)
Creates a new GtkComboBox with the model initialized to model.
Declaration
Swift

@inlinable init<TreeModelT>(model: TreeModelT) where TreeModelT : TreeModelProtocol
Show on GitHub
init(modelAndEntry:)
Creates a new empty GtkComboBox with an entry and with the model initialized to model.
Declaration
Swift

@inlinable init<TreeModelT>(modelAndEntry model: TreeModelT) where TreeModelT : TreeModelProtocol
Show on GitHub


                    
                    
                    newWith(area:)

Creates a new empty GtkComboBox using area to layout cells.

Declaration

Swift

@inlinable
static func newWith<CellAreaT>(area: CellAreaT) -> WidgetRef! where CellAreaT : CellAreaProtocol

Show on GitHub

newWith(areaAndEntry:)
Creates a new empty GtkComboBox with an entry.

The new combo box will use area to layout cells.
Declaration
Swift

@inlinable static func newWith<CellAreaT>(areaAndEntry area: CellAreaT) -> WidgetRef! where CellAreaT : CellAreaProtocol
Show on GitHub
newWithEntry()
Creates a new empty GtkComboBox with an entry.
Declaration
Swift

@inlinable static func newWithEntry() -> WidgetRef!
Show on GitHub


                    
                    
                    newWith(model:)

Creates a new GtkComboBox with the model initialized to model.

Declaration

Swift

@inlinable
static func newWith<TreeModelT>(model: TreeModelT) -> WidgetRef! where TreeModelT : TreeModelProtocol

Show on GitHub


                    
                    
                    newWith(modelAndEntry:)

Creates a new empty GtkComboBox with an entry and with the model initialized to model.

Declaration

Swift

@inlinable
static func newWith<TreeModelT>(modelAndEntry model: TreeModelT) -> WidgetRef! where TreeModelT : TreeModelProtocol

Show on GitHub