GI.Clutter.Objects.ModelIter

Base class for list models iters. The ModelIter structure contains only private data and should be manipulated using the provided API.

Since: 0.6

Exported types

newtype ModelIter

Memory-managed wrapper type.

Constructors

ModelIter (ManagedPtr ModelIter)

Instances

Eq ModelIter

Defined in GI.Clutter.Objects.ModelIter

Methods

(==) :: ModelIter -> ModelIter -> Bool

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

GObject ModelIter

Defined in GI.Clutter.Objects.ModelIter

ManagedPtrNewtype ModelIter

Defined in GI.Clutter.Objects.ModelIter

Methods

toManagedPtr :: ModelIter -> ManagedPtr ModelIter

TypedObject ModelIter

Defined in GI.Clutter.Objects.ModelIter

Methods

glibType :: IO GType

HasParentTypes ModelIter

Defined in GI.Clutter.Objects.ModelIter

IsGValue (Maybe ModelIter)

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

Defined in GI.Clutter.Objects.ModelIter

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ModelIter

Defined in GI.Clutter.Objects.ModelIter

type ParentTypes ModelIter = '[Object]

class (GObject o, IsDescendantOf ModelIter o) => IsModelIter o

Type class for types which can be safely cast to ModelIter, for instance with toModelIter.

Instances

(GObject o, IsDescendantOf ModelIter o) => IsModelIter o

Defined in GI.Clutter.Objects.ModelIter

toModelIter :: (MonadIO m, IsModelIter o) => o -> m ModelIter

Cast to ModelIter, 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, copy, forceFloating, freezeNotify, getv, isFirst, isFloating, isLast, next, notify, notifyByPspec, prev, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getModel, getProperty, getQdata, getRow, getValue.

Setters

setData, setDataFull, setProperty, setValue.

copy

modelIterCopy

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> m ModelIter

Returns: a copy of the iterator, or Nothing

Deprecated: (Since version 1.24)Use ListModel instead

Copies the passed iterator.

Since: 0.8

getModel

modelIterGetModel

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> m Model

Returns: a pointer to a Model.

Deprecated: (Since version 1.24)Use ListModel instead

Retrieves a pointer to the Model that this iter is part of.

Since: 0.6

getRow

modelIterGetRow

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> m Word32

Returns: the position of the iter in the model

Deprecated: (Since version 1.24)Use ListModel instead

Retrieves the position of the row that the iter points to.

Since: 0.6

getValue

modelIterGetValue

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> Word32

column: column number to retrieve the value from

-> m GValue

Deprecated: (Since version 1.24)Use ListModel instead

Sets an initializes value to that at column. When done with value, valueUnset needs to be called to free any allocated memory.

Since: 0.6

isFirst

modelIterIsFirst

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> m Bool

Returns: TRUE if iter is the first iter in the filtered model

Deprecated: (Since version 1.24)Use ListModel instead

Gets whether the current iterator is at the beginning of the model to which it belongs.

Since: 0.6

isLast

modelIterIsLast

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> m Bool

Returns: TRUE if iter is the last iter in the filtered model.

Deprecated: (Since version 1.24)Use ListModel instead

Gets whether the iterator is at the end of the model to which it belongs.

Since: 0.6

next

modelIterNext

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> m ModelIter

Returns: The passed iterator, updated to point at the next row in the model.

Deprecated: (Since version 1.24)Use ListModel instead

Updates the iter to point at the next position in the model. The model implementation should take into account the presence of a filter function.

Since: 0.6

prev

modelIterPrev

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> m ModelIter

Returns: The passed iterator, updated to point at the previous row in the model.

Deprecated: (Since version 1.24)Use ListModel instead

Sets the iter to point at the previous position in the model. The model implementation should take into account the presence of a filter function.

Since: 0.6

setValue

modelIterSetValue

Arguments

:: (HasCallStack, MonadIO m, IsModelIter a)

=> a

iter: a ModelIter

-> Word32

column: column number to retrieve the value from

-> GValue

value: new value for the cell

-> m ()

Deprecated: (Since version 1.24)Use ListModel instead

Sets the data in the cell specified by iter and column. The type of value must be convertable to the type of the column.

Since: 0.6

Properties

model

A reference to the Model that this iter belongs to.

Since: 0.6

clearModelIterModel :: (MonadIO m, IsModelIter o) => o -> m ()

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

clear #model

constructModelIterModel :: (IsModelIter o, MonadIO m, IsModel 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.

getModelIterModel :: (MonadIO m, IsModelIter o) => o -> m Model

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

get modelIter #model

setModelIterModel :: (MonadIO m, IsModelIter o, IsModel a) => o -> a -> m ()

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

set modelIter [ #model := value ]

row

The row number to which this iter points to.

Since: 0.6

constructModelIterRow :: (IsModelIter o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getModelIterRow :: (MonadIO m, IsModelIter o) => o -> m Word32

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

get modelIter #row

setModelIterRow :: (MonadIO m, IsModelIter o) => o -> Word32 -> m ()

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

set modelIter [ #row := value ]