gi-gtk-4.0.2: Gtk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.FlattenListModel

Description

FlattenListModel is a list model that takes a list model containing list models and flattens it into a single model.

Another term for this is concatenation: FlattenListModel takes a list of lists and concatenates them into a single list.

Synopsis

Exported types

class (GObject o, IsDescendantOf FlattenListModel o) => IsFlattenListModel o Source #

Type class for types which can be safely cast to FlattenListModel, for instance with toFlattenListModel.

Instances

Instances details
(GObject o, IsDescendantOf FlattenListModel o) => IsFlattenListModel o Source # 
Instance details

Defined in GI.Gtk.Objects.FlattenListModel

toFlattenListModel :: (MonadIO m, IsFlattenListModel o) => o -> m FlattenListModel Source #

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

Methods

Overloaded methods

getModel

flattenListModelGetModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsFlattenListModel a) 
=> a

self: a FlattenListModel

-> m (Maybe ListModel)

Returns: The model flattened by self

Gets the model set via flattenListModelSetModel.

getModelForItem

flattenListModelGetModelForItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsFlattenListModel a) 
=> a

self: a FlattenListModel

-> Word32

position: a position

-> m ListModel

Returns: the model containing the item at position

Returns the model containing the item at the given position.

new

flattenListModelNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsListModel a) 
=> GType

itemType: The type of items in the to-be-flattened models

-> Maybe a

model: the item to be flattened

-> m FlattenListModel

Returns: a new FlattenListModel

Creates a new FlattenListModel that flattens list. The models returned by model must conform to the given itemType, either by having an identical type or a subtype.

setModel

flattenListModelSetModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsFlattenListModel a, IsListModel b) 
=> a

self: a FlattenListModel

-> Maybe b

model: the new model or Nothing

-> m () 

Sets a new model to be flattened. The model must contain items of ListModel that conform to the item type of self.

Properties

itemType

The GType for elements of this object

constructFlattenListModelItemType :: (IsFlattenListModel o, MonadIO m) => GType -> m (GValueConstruct o) Source #

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

getFlattenListModelItemType :: (MonadIO m, IsFlattenListModel o) => o -> m GType Source #

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

get flattenListModel #itemType

model

The model being flattened

clearFlattenListModelModel :: (MonadIO m, IsFlattenListModel o) => o -> m () Source #

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

clear #model

constructFlattenListModelModel :: (IsFlattenListModel o, MonadIO m, IsListModel a) => a -> m (GValueConstruct o) Source #

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

getFlattenListModelModel :: (MonadIO m, IsFlattenListModel o) => o -> m (Maybe ListModel) Source #

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

get flattenListModel #model

setFlattenListModelModel :: (MonadIO m, IsFlattenListModel o, IsListModel a) => o -> a -> m () Source #

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

set flattenListModel [ #model := value ]