Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Handy.Objects.ComboRow

Contents

Exported types
Methods
Properties
- selectedIndex
- useSubtitle

Description

No description available in the introspection data.

Synopsis

newtype ComboRow = ComboRow (ManagedPtr ComboRow)
class (GObject o, IsDescendantOf ComboRow o) => IsComboRow o
toComboRow :: (MonadIO m, IsComboRow o) => o -> m ComboRow
comboRowBindModel :: (HasCallStack, MonadIO m, IsComboRow a, IsListModel b) => a -> Maybe b -> Maybe ListBoxCreateWidgetFunc -> Maybe ListBoxCreateWidgetFunc -> m ()
comboRowBindNameModel :: (HasCallStack, MonadIO m, IsComboRow a, IsListModel b) => a -> Maybe b -> Maybe ComboRowGetNameFunc -> m ()
comboRowGetModel :: (HasCallStack, MonadIO m, IsComboRow a) => a -> m (Maybe ListModel)
comboRowGetSelectedIndex :: (HasCallStack, MonadIO m, IsComboRow a) => a -> m Int32
comboRowGetUseSubtitle :: (HasCallStack, MonadIO m, IsComboRow a) => a -> m Bool
comboRowNew :: (HasCallStack, MonadIO m) => m ComboRow
comboRowSetForEnum :: (HasCallStack, MonadIO m, IsComboRow a) => a -> GType -> Maybe ComboRowGetEnumValueNameFunc -> m ()
comboRowSetGetNameFunc :: (HasCallStack, MonadIO m, IsComboRow a) => a -> Maybe ComboRowGetNameFunc -> m ()
comboRowSetSelectedIndex :: (HasCallStack, MonadIO m, IsComboRow a) => a -> Int32 -> m ()
comboRowSetUseSubtitle :: (HasCallStack, MonadIO m, IsComboRow a) => a -> Bool -> m ()
constructComboRowSelectedIndex :: (IsComboRow o, MonadIO m) => Int32 -> m (GValueConstruct o)
getComboRowSelectedIndex :: (MonadIO m, IsComboRow o) => o -> m Int32
setComboRowSelectedIndex :: (MonadIO m, IsComboRow o) => o -> Int32 -> m ()
constructComboRowUseSubtitle :: (IsComboRow o, MonadIO m) => Bool -> m (GValueConstruct o)
getComboRowUseSubtitle :: (MonadIO m, IsComboRow o) => o -> m Bool
setComboRowUseSubtitle :: (MonadIO m, IsComboRow o) => o -> Bool -> m ()

Exported types

newtype ComboRow Source #

Memory-managed wrapper type.

Constructors

ComboRow (ManagedPtr ComboRow)

Instances

Instances details

Eq ComboRow Source #
Instance details Defined in GI.Handy.Objects.ComboRow Methods (==) :: ComboRow -> ComboRow -> Bool (/=) :: ComboRow -> ComboRow -> Bool
GObject ComboRow Source #
Instance details Defined in GI.Handy.Objects.ComboRow
ManagedPtrNewtype ComboRow Source #
Instance details Defined in GI.Handy.Objects.ComboRow Methods toManagedPtr :: ComboRow -> ManagedPtr ComboRow
TypedObject ComboRow Source #
Instance details Defined in GI.Handy.Objects.ComboRow Methods glibType :: IO GType
IsGValue ComboRow Source #	Convert `ComboRow` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Handy.Objects.ComboRow Methods toGValue :: ComboRow -> IO GValue fromGValue :: GValue -> IO ComboRow
HasParentTypes ComboRow Source #
Instance details Defined in GI.Handy.Objects.ComboRow
type ParentTypes ComboRow Source #
Instance details 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 Source #

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

Instances

Instances details

(GObject o, IsDescendantOf ComboRow o) => IsComboRow o Source #
Instance details Defined in GI.Handy.Objects.ComboRow

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

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

Methods

bindModel

comboRowBindModel Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m ComboRow	Returns: a new `ComboRow`

Creates a new ComboRow.

Since: 0.0.6

setForEnum

comboRowSetForEnum Source #

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 Source #

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 Source #

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 Source #

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) Source #

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 Source #

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 () Source #

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) Source #

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 Source #

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 () Source #

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

set comboRow [ #useSubtitle := value ]

Exported types

Instances

Instances

Methods

Overloaded methods

bindModel

bindNameModel

getModel

getSelectedIndex

getUseSubtitle

new

setForEnum

setGetNameFunc

setSelectedIndex

setUseSubtitle

Properties

selectedIndex

useSubtitle