GI.Gtk.Objects.CellRendererCombo

Renders a combobox in a cell

GtkCellRendererCombo renders text in a cell like GtkCellRendererText from which it is derived. But while GtkCellRendererText offers a simple entry to edit the text, GtkCellRendererCombo offers a GtkComboBox widget to edit the text. The values to display in the combo box are taken from the tree model specified in the GtkCellRendererCombo:model property.

The combo cell renderer takes care of adding a text cell renderer to the combo box and sets it to display the column specified by its GtkCellRendererCombo:text-column property. Further properties of the combo box can be set in a handler for the GtkCellRenderer::editing-started signal.

Exported types

newtype CellRendererCombo

Memory-managed wrapper type.

Constructors

CellRendererCombo (ManagedPtr CellRendererCombo)

Instances

Eq CellRendererCombo

Defined in GI.Gtk.Objects.CellRendererCombo

Methods

(==) :: CellRendererCombo -> CellRendererCombo -> Bool

(/=) :: CellRendererCombo -> CellRendererCombo -> Bool

GObject CellRendererCombo

Defined in GI.Gtk.Objects.CellRendererCombo

ManagedPtrNewtype CellRendererCombo

Defined in GI.Gtk.Objects.CellRendererCombo

Methods

toManagedPtr :: CellRendererCombo -> ManagedPtr CellRendererCombo

TypedObject CellRendererCombo

Defined in GI.Gtk.Objects.CellRendererCombo

Methods

glibType :: IO GType

HasParentTypes CellRendererCombo

Defined in GI.Gtk.Objects.CellRendererCombo

IsGValue (Maybe CellRendererCombo)

Convert CellRendererCombo to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.CellRendererCombo

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe CellRendererCombo -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe CellRendererCombo)

type ParentTypes CellRendererCombo

Defined in GI.Gtk.Objects.CellRendererCombo

type ParentTypes CellRendererCombo = '[CellRendererText, CellRenderer, Object]

class (GObject o, IsDescendantOf CellRendererCombo o) => IsCellRendererCombo o

Type class for types which can be safely cast to CellRendererCombo, for instance with toCellRendererCombo.

Instances

(GObject o, IsDescendantOf CellRendererCombo o) => IsCellRendererCombo o

Defined in GI.Gtk.Objects.CellRendererCombo

toCellRendererCombo :: (MonadIO m, IsCellRendererCombo o) => o -> m CellRendererCombo

Cast to CellRendererCombo, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

activate, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isActivatable, isFloating, notify, notifyByPspec, ref, refSink, runDispose, snapshot, startEditing, stealData, stealQdata, stopEditing, thawNotify, unref, watchClosure.

Getters

getAlignedArea, getAlignment, getData, getFixedSize, getIsExpanded, getIsExpander, getPadding, getPreferredHeight, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRequestMode, getSensitive, getState, getVisible.

Setters

setAlignment, setData, setDataFull, setFixedHeightFromFont, setFixedSize, setIsExpanded, setIsExpander, setPadding, setProperty, setSensitive, setVisible.

new

cellRendererComboNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CellRendererCombo

Returns: the new cell renderer

Deprecated: (Since version 4.10)

Creates a new GtkCellRendererCombo. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with GtkTreeViewColumn, you can bind a property to a value in a GtkTreeModel. For example, you can bind the “text” property on the cell renderer to a string value in the model, thus rendering a different string in each row of the GtkTreeView.

Properties

hasEntry

If True, the cell renderer will include an entry and allow to enter values other than the ones in the popup list.

constructCellRendererComboHasEntry :: (IsCellRendererCombo o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “has-entry” property. This is rarely needed directly, but it is used by new.

getCellRendererComboHasEntry :: (MonadIO m, IsCellRendererCombo o) => o -> m Bool

Get the value of the “has-entry” property. When overloading is enabled, this is equivalent to

get cellRendererCombo #hasEntry

setCellRendererComboHasEntry :: (MonadIO m, IsCellRendererCombo o) => o -> Bool -> m ()

Set the value of the “has-entry” property. When overloading is enabled, this is equivalent to

set cellRendererCombo [ #hasEntry := value ]

model

Holds a tree model containing the possible values for the combo box. Use the text_column property to specify the column holding the values.

clearCellRendererComboModel :: (MonadIO m, IsCellRendererCombo o) => o -> m ()

Set the value of the “model” property to Nothing. When overloading is enabled, this is equivalent to

clear #model

constructCellRendererComboModel :: (IsCellRendererCombo o, MonadIO m, IsTreeModel a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “model” property. This is rarely needed directly, but it is used by new.

getCellRendererComboModel :: (MonadIO m, IsCellRendererCombo o) => o -> m (Maybe TreeModel)

Get the value of the “model” property. When overloading is enabled, this is equivalent to

get cellRendererCombo #model

setCellRendererComboModel :: (MonadIO m, IsCellRendererCombo o, IsTreeModel a) => o -> a -> m ()

Set the value of the “model” property. When overloading is enabled, this is equivalent to

set cellRendererCombo [ #model := value ]

textColumn

Specifies the model column which holds the possible values for the combo box.

Note that this refers to the model specified in the model property, not the model backing the tree view to which this cell renderer is attached.

GtkCellRendererCombo automatically adds a text cell renderer for this column to its combo box.

constructCellRendererComboTextColumn :: (IsCellRendererCombo o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text-column” property. This is rarely needed directly, but it is used by new.

getCellRendererComboTextColumn :: (MonadIO m, IsCellRendererCombo o) => o -> m Int32

Get the value of the “text-column” property. When overloading is enabled, this is equivalent to

get cellRendererCombo #textColumn

setCellRendererComboTextColumn :: (MonadIO m, IsCellRendererCombo o) => o -> Int32 -> m ()

Set the value of the “text-column” property. When overloading is enabled, this is equivalent to

set cellRendererCombo [ #textColumn := value ]

Signals

changed

type CellRendererComboChangedCallback

Arguments

 = Text

pathString: a string of the path identifying the edited cell (relative to the tree view model)

-> TreeIter

newIter: the new iter selected in the combo box (relative to the combo box model)

-> IO ()

This signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys. Contrary to GtkComboBox, GtkCellRendererCombochanged is not emitted for changes made to a selected item in the entry. The argument newIter corresponds to the newly selected item in the combo box and it is relative to the GtkTreeModel set via the model property on GtkCellRendererCombo.

Note that as soon as you change the model displayed in the tree view, the tree view will immediately cease the editing operating. This means that you most probably want to refrain from changing the model until the combo cell renderer emits the edited or editing_canceled signal.

afterCellRendererComboChanged :: (IsCellRendererCombo a, MonadIO m) => a -> ((?self :: a) => CellRendererComboChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cellRendererCombo #changed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onCellRendererComboChanged :: (IsCellRendererCombo a, MonadIO m) => a -> ((?self :: a) => CellRendererComboChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cellRendererCombo #changed callback