GI.Gtk.Objects.ColumnViewCell

GtkColumnViewCell is used by ColumnViewColumn to represent items in a cell in ColumnView.

The GtkColumnViewCells are managed by the columnview widget (with its factory) and cannot be created by applications, but they need to be populated by application code. This is done by calling columnViewCellSetChild.

GtkColumnViewCells exist in 2 stages:

1. The unbound stage where the listitem is not currently connected to an item in the list. In that case, the ColumnViewCell:item property is set to Nothing.
2. The bound stage where the listitem references an item from the list. The ColumnViewCell:item property is not Nothing.

Since: 4.12

Exported types

newtype ColumnViewCell

Memory-managed wrapper type.

Constructors

ColumnViewCell (ManagedPtr ColumnViewCell)

Instances

Eq ColumnViewCell

Defined in GI.Gtk.Objects.ColumnViewCell

Methods

(==) :: ColumnViewCell -> ColumnViewCell -> Bool

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

GObject ColumnViewCell

Defined in GI.Gtk.Objects.ColumnViewCell

ManagedPtrNewtype ColumnViewCell

Defined in GI.Gtk.Objects.ColumnViewCell

Methods

toManagedPtr :: ColumnViewCell -> ManagedPtr ColumnViewCell

TypedObject ColumnViewCell

Defined in GI.Gtk.Objects.ColumnViewCell

Methods

glibType :: IO GType

HasParentTypes ColumnViewCell

Defined in GI.Gtk.Objects.ColumnViewCell

IsGValue (Maybe ColumnViewCell)

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

Defined in GI.Gtk.Objects.ColumnViewCell

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ColumnViewCell

Defined in GI.Gtk.Objects.ColumnViewCell

type ParentTypes ColumnViewCell = '[ListItem, Object]

class (GObject o, IsDescendantOf ColumnViewCell o) => IsColumnViewCell o

Type class for types which can be safely cast to ColumnViewCell, for instance with toColumnViewCell.

Instances

(GObject o, IsDescendantOf ColumnViewCell o) => IsColumnViewCell o

Defined in GI.Gtk.Objects.ColumnViewCell

toColumnViewCell :: (MonadIO m, IsColumnViewCell o) => o -> m ColumnViewCell

Cast to ColumnViewCell, 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

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAccessibleDescription, getAccessibleLabel, getActivatable, getChild, getData, getFocusable, getItem, getPosition, getProperty, getQdata, getSelectable, getSelected.

Setters

setAccessibleDescription, setAccessibleLabel, setActivatable, setChild, setData, setDataFull, setFocusable, setProperty, setSelectable.

getChild

columnViewCellGetChild

Arguments

:: (HasCallStack, MonadIO m, IsColumnViewCell a)

=> a

self: a GtkColumnViewCell

-> m (Maybe Widget)

Returns: The child

Gets the child previously set via columnViewCellSetChild or Nothing if none was set.

Since: 4.12

getFocusable

columnViewCellGetFocusable

Arguments

:: (HasCallStack, MonadIO m, IsColumnViewCell a)

=> a

self: a GtkColumnViewCell

-> m Bool

Returns: True if the item is focusable

Checks if a list item has been set to be focusable via columnViewCellSetFocusable.

Since: 4.12

getItem

columnViewCellGetItem

Arguments

:: (HasCallStack, MonadIO m, IsColumnViewCell a)

=> a

self: a GtkColumnViewCell

-> m (Maybe Object)

Returns: The item displayed

Gets the model item that associated with self.

If self is unbound, this function returns Nothing.

Since: 4.12

getPosition

columnViewCellGetPosition

Arguments

:: (HasCallStack, MonadIO m, IsColumnViewCell a)

=> a

self: a GtkColumnViewCell

-> m Word32

Returns: The position of this item

Gets the position in the model that self currently displays.

If self is unbound, INVALID_LIST_POSITION is returned.

Since: 4.12

getSelected

columnViewCellGetSelected

Arguments

:: (HasCallStack, MonadIO m, IsColumnViewCell a)

=> a

self: a GtkColumnViewCell

-> m Bool

Returns: True if the item is selected.

Checks if the item is displayed as selected.

The selected state is maintained by the list widget and its model and cannot be set otherwise.

Since: 4.12

setChild

columnViewCellSetChild

Arguments

:: (HasCallStack, MonadIO m, IsColumnViewCell a, IsWidget b)

=> a

self: a GtkColumnViewCell

-> Maybe b

child: The list item's child or Nothing to unset

-> m ()

Sets the child to be used for this listitem.

This function is typically called by applications when setting up a listitem so that the widget can be reused when binding it multiple times.

Since: 4.12

setFocusable

columnViewCellSetFocusable

Arguments

:: (HasCallStack, MonadIO m, IsColumnViewCell a)

=> a

self: a GtkColumnViewCell

-> Bool

focusable: if the item should be focusable

-> m ()

Sets self to be focusable.

If an item is focusable, it can be focused using the keyboard. This works similar to widgetSetFocusable.

Note that if items are not focusable, the keyboard cannot be used to activate them and selecting only works if one of the listitem's children is focusable.

By default, list items are focusable.

Since: 4.12

Properties

child

Widget used for display.

Since: 4.12

clearColumnViewCellChild :: (MonadIO m, IsColumnViewCell o) => o -> m ()

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

clear #child

constructColumnViewCellChild :: (IsColumnViewCell o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getColumnViewCellChild :: (MonadIO m, IsColumnViewCell o) => o -> m (Maybe Widget)

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

get columnViewCell #child

setColumnViewCellChild :: (MonadIO m, IsColumnViewCell o, IsWidget a) => o -> a -> m ()

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

set columnViewCell [ #child := value ]

focusable

If the item can be focused with the keyboard.

Since: 4.12

constructColumnViewCellFocusable :: (IsColumnViewCell o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getColumnViewCellFocusable :: (MonadIO m, IsColumnViewCell o) => o -> m Bool

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

get columnViewCell #focusable

setColumnViewCellFocusable :: (MonadIO m, IsColumnViewCell o) => o -> Bool -> m ()

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

set columnViewCell [ #focusable := value ]

item

Displayed item.

Since: 4.12

getColumnViewCellItem :: (MonadIO m, IsColumnViewCell o) => o -> m (Maybe Object)

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

get columnViewCell #item

position

Position of the item.

Since: 4.12

getColumnViewCellPosition :: (MonadIO m, IsColumnViewCell o) => o -> m Word32

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

get columnViewCell #position

selected

If the item is currently selected.

Since: 4.12

getColumnViewCellSelected :: (MonadIO m, IsColumnViewCell o) => o -> m Bool

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

get columnViewCell #selected