GI.Handy.Objects.ComboRow

No description available in the introspection data.

Exported types

newtype ComboRow

Memory-managed wrapper type.

Constructors

ComboRow (ManagedPtr ComboRow)

Instances

Eq ComboRow

Defined in GI.Handy.Objects.ComboRow

Methods

(==) :: ComboRow -> ComboRow -> Bool

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

GObject ComboRow

Defined in GI.Handy.Objects.ComboRow

ManagedPtrNewtype ComboRow

Defined in GI.Handy.Objects.ComboRow

Methods

toManagedPtr :: ComboRow -> ManagedPtr ComboRow

TypedObject ComboRow

Defined in GI.Handy.Objects.ComboRow

Methods

glibType :: IO GType

IsGValue ComboRow

Convert ComboRow to and from GValue with toGValue and fromGValue.

Defined in GI.Handy.Objects.ComboRow

Methods

toGValue :: ComboRow -> IO GValue

fromGValue :: GValue -> IO ComboRow

HasParentTypes ComboRow

Defined in GI.Handy.Objects.ComboRow

type ParentTypes ComboRow

Defined in GI.Handy.Objects.ComboRow

type ParentTypes ComboRow = '[ActionRow, PreferencesRow, ListBoxRow, Bin, Container, Widget, Object, ImplementorIface, Actionable, Buildable]

class (GObject o, IsDescendantOf ComboRow o) => IsComboRow o

Type class for types which can be safely cast to ComboRow, for instance with toComboRow.

Instances

(GObject o, IsDescendantOf ComboRow o) => IsComboRow o

Defined in GI.Handy.Objects.ComboRow

toComboRow :: (MonadIO m, IsComboRow o) => o -> m ComboRow

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

Methods

Overloaded methods

bindModel

comboRowBindModel

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a, IsListModel b)

=> a

self: a ComboRow

-> Maybe b

model: the ListModel to be bound to self

-> Maybe ListBoxCreateWidgetFunc

createListWidgetFunc: a function that creates widgets for items to display in the list, or Nothing in case you also passed Nothing as model

-> Maybe ListBoxCreateWidgetFunc

createCurrentWidgetFunc: a function that creates widgets for items to display as the seleted item, or Nothing in case you also passed Nothing as model

-> m ()

Binds model to self.

If self was already bound to a model, that previous binding is destroyed.

The contents of self are cleared and then filled with widgets that represent items from model. self is updated whenever model changes. If model is Nothing, self is left empty.

Since: 0.0.6

bindNameModel

comboRowBindNameModel

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a, IsListModel b)

=> a

self: a ComboRow

-> Maybe b

model: the ListModel to be bound to self

-> Maybe ComboRowGetNameFunc

getNameFunc: a function that creates names for items, or Nothing in case you also passed Nothing as model

-> m ()

Binds model to self.

If self was already bound to a model, that previous binding is destroyed.

The contents of self are cleared and then filled with widgets that represent items from model. self is updated whenever model changes. If model is Nothing, self is left empty.

This is more conventient to use than comboRowBindModel if you want to represent items of the model with names.

Since: 0.0.6

getModel

comboRowGetModel

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a)

=> a

self: a ComboRow

-> m (Maybe ListModel)

Returns: the ListModel bound to self or Nothing

Gets the model bound to self, or Nothing if none is bound.

Since: 0.0.6

getSelectedIndex

comboRowGetSelectedIndex

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a)

=> a

self: a ListBoxRow

-> m Int32

Returns: the index of the selected item, or -1 if no item is selected

Gets the index of the selected item in its ListModel.

Since: 0.0.7

getUseSubtitle

comboRowGetUseSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a)

=> a

self: a ListBoxRow

-> m Bool

Returns: whether the current value of self should be displayed as its subtitle

Gets whether the current value of self should be displayed as its subtitle.

Since: 0.0.10

new

comboRowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ComboRow

Returns: a new ComboRow

Creates a new ComboRow.

Since: 0.0.6

setForEnum

comboRowSetForEnum

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a)

=> a

self: a ComboRow

-> GType

enumType: the enumeration GType to be bound to self

-> Maybe ComboRowGetEnumValueNameFunc

getNameFunc: a function that creates names for items, or Nothing in case you also passed Nothing as model

-> m ()

Creates a model for enumType and binds it to self. The items of the model will be EnumValueObject objects.

If self was already bound to a model, that previous binding is destroyed.

The contents of self are cleared and then filled with widgets that represent items from model. self is updated whenever model changes. If model is Nothing, self is left empty.

This is more conventient to use than comboRowBindNameModel if you want to represent values of an enumeration with names.

See enumValueRowName.

Since: 0.0.6

setGetNameFunc

comboRowSetGetNameFunc

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a)

=> a

self: a ComboRow

-> Maybe ComboRowGetNameFunc

getNameFunc: a function that creates names for items, or Nothing in case you also passed Nothing as model

-> m ()

Sets a closure to convert items into names. See HdyComboRow:use-subtitle.

Since: 0.0.10

setSelectedIndex

comboRowSetSelectedIndex

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a)

=> a

self: a ComboRow

-> Int32

selectedIndex: the index of the selected item

-> m ()

Sets the index of the selected item in its ListModel.

Since: 0.0.7

setUseSubtitle

comboRowSetUseSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a)

=> a

self: a ComboRow

-> Bool

useSubtitle: True to set the current value as the subtitle

-> m ()

Sets whether the current value of self should be displayed as its subtitle.

If True, you should not access HdyActionRow:subtitle.

Since: 0.0.10

Properties

selectedIndex

The index of the selected item in its ListModel.

Since: 0.0.7

constructComboRowSelectedIndex :: (IsComboRow o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getComboRowSelectedIndex :: (MonadIO m, IsComboRow o) => o -> m Int32

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

get comboRow #selectedIndex

setComboRowSelectedIndex :: (MonadIO m, IsComboRow o) => o -> Int32 -> m ()

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

set comboRow [ #selectedIndex := value ]

useSubtitle

True to set the current value as the subtitle.

If you use a custom widget creation function, you will need to give self a name conversion closure with comboRowSetGetNameFunc.

If True, you should not access HdyActionRow:subtitle.

Since: 0.0.10

constructComboRowUseSubtitle :: (IsComboRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getComboRowUseSubtitle :: (MonadIO m, IsComboRow o) => o -> m Bool

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

get comboRow #useSubtitle

setComboRowUseSubtitle :: (MonadIO m, IsComboRow o) => o -> Bool -> m ()

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

set comboRow [ #useSubtitle := value ]