Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Base class for list models. The Model
structure contains
only private data and should be manipulated using the provided
API.
Since: 0.6
Synopsis
- newtype Model = Model (ManagedPtr Model)
- class (GObject o, IsDescendantOf Model o) => IsModel o
- toModel :: (MonadIO m, IsModel o) => o -> m Model
- modelAppendv :: (HasCallStack, MonadIO m, IsModel a) => a -> [Word32] -> [GValue] -> m ()
- modelFilterIter :: (HasCallStack, MonadIO m, IsModel a, IsModelIter b) => a -> b -> m Bool
- modelFilterRow :: (HasCallStack, MonadIO m, IsModel a) => a -> Word32 -> m Bool
- modelForeach :: (HasCallStack, MonadIO m, IsModel a) => a -> ModelForeachFunc -> m ()
- modelGetColumnName :: (HasCallStack, MonadIO m, IsModel a) => a -> Word32 -> m Text
- modelGetColumnType :: (HasCallStack, MonadIO m, IsModel a) => a -> Word32 -> m GType
- modelGetFilterSet :: (HasCallStack, MonadIO m, IsModel a) => a -> m Bool
- modelGetFirstIter :: (HasCallStack, MonadIO m, IsModel a) => a -> m ModelIter
- modelGetIterAtRow :: (HasCallStack, MonadIO m, IsModel a) => a -> Word32 -> m ModelIter
- modelGetLastIter :: (HasCallStack, MonadIO m, IsModel a) => a -> m ModelIter
- modelGetNColumns :: (HasCallStack, MonadIO m, IsModel a) => a -> m Word32
- modelGetNRows :: (HasCallStack, MonadIO m, IsModel a) => a -> m Word32
- modelGetSortingColumn :: (HasCallStack, MonadIO m, IsModel a) => a -> m Int32
- modelInsertValue :: (HasCallStack, MonadIO m, IsModel a) => a -> Word32 -> Word32 -> GValue -> m ()
- modelInsertv :: (HasCallStack, MonadIO m, IsModel a) => a -> Word32 -> [Word32] -> [GValue] -> m ()
- modelPrependv :: (HasCallStack, MonadIO m, IsModel a) => a -> [Word32] -> [GValue] -> m ()
- modelRemove :: (HasCallStack, MonadIO m, IsModel a) => a -> Word32 -> m ()
- modelResort :: (HasCallStack, MonadIO m, IsModel a) => a -> m ()
- modelSetFilter :: (HasCallStack, MonadIO m, IsModel a) => a -> Maybe ModelFilterFunc -> m ()
- modelSetNames :: (HasCallStack, MonadIO m, IsModel a) => a -> [Text] -> m ()
- modelSetSort :: (HasCallStack, MonadIO m, IsModel a) => a -> Int32 -> Maybe ModelSortFunc -> m ()
- modelSetSortingColumn :: (HasCallStack, MonadIO m, IsModel a) => a -> Int32 -> m ()
- modelSetTypes :: (HasCallStack, MonadIO m, IsModel a) => a -> [GType] -> m ()
- getModelFilterSet :: (MonadIO m, IsModel o) => o -> m Bool
- type ModelFilterChangedCallback = IO ()
- afterModelFilterChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelFilterChangedCallback) -> m SignalHandlerId
- onModelFilterChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelFilterChangedCallback) -> m SignalHandlerId
- type ModelRowAddedCallback = ModelIter -> IO ()
- afterModelRowAdded :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowAddedCallback) -> m SignalHandlerId
- onModelRowAdded :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowAddedCallback) -> m SignalHandlerId
- type ModelRowChangedCallback = ModelIter -> IO ()
- afterModelRowChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowChangedCallback) -> m SignalHandlerId
- onModelRowChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowChangedCallback) -> m SignalHandlerId
- type ModelRowRemovedCallback = ModelIter -> IO ()
- afterModelRowRemoved :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowRemovedCallback) -> m SignalHandlerId
- onModelRowRemoved :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowRemovedCallback) -> m SignalHandlerId
- type ModelSortChangedCallback = IO ()
- afterModelSortChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelSortChangedCallback) -> m SignalHandlerId
- onModelSortChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelSortChangedCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Model Source # | |
GObject Model Source # | |
Defined in GI.Clutter.Objects.Model | |
ManagedPtrNewtype Model Source # | |
Defined in GI.Clutter.Objects.Model toManagedPtr :: Model -> ManagedPtr Model | |
TypedObject Model Source # | |
Defined in GI.Clutter.Objects.Model | |
HasParentTypes Model Source # | |
Defined in GI.Clutter.Objects.Model | |
IsGValue (Maybe Model) Source # | Convert |
Defined in GI.Clutter.Objects.Model gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Model -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Model) | |
type ParentTypes Model Source # | |
Defined in GI.Clutter.Objects.Model |
class (GObject o, IsDescendantOf Model o) => IsModel o Source #
Instances
(GObject o, IsDescendantOf Model o) => IsModel o Source # | |
Defined in GI.Clutter.Objects.Model |
Methods
Click to display all available methods, including inherited ones
Methods
appendv, bindProperty, bindPropertyFull, filterIter, filterRow, forceFloating, foreach, freezeNotify, getv, insertValue, insertv, isFloating, notify, notifyByPspec, parseCustomNode, prependv, ref, refSink, remove, resort, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getColumnName, getColumnType, getData, getFilterSet, getFirstIter, getId, getIterAtRow, getLastIter, getNColumns, getNRows, getProperty, getQdata, getSortingColumn.
Setters
setCustomProperty, setData, setDataFull, setFilter, setId, setNames, setProperty, setSort, setSortingColumn, setTypes.
appendv
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> [Word32] |
|
-> [GValue] |
|
-> m () |
filterIter
:: (HasCallStack, MonadIO m, IsModel a, IsModelIter b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
filterRow
foreach
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> ModelForeachFunc |
|
-> m () |
Deprecated: (Since version 1.24)Use ListModel
instead
Calls func
for each row in the model.
Since: 0.6
getColumnName
getColumnType
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> Word32 |
|
-> m GType | Returns: the type of the column. |
getFilterSet
Deprecated: (Since version 1.24)Use ListModel
instead
Returns whether the model
has a filter in place, set
using modelSetFilter
Since: 1.0
getFirstIter
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> m ModelIter | Returns: A new |
getIterAtRow
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> Word32 |
|
-> m ModelIter | Returns: A new |
Deprecated: (Since version 1.24)Use ListModel
instead
Retrieves a ModelIter
representing the row at the given index.
If a filter function has been set using modelSetFilter
then the model
implementation will return the first non filtered
row.
Since: 0.6
getLastIter
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> m ModelIter | Returns: A new |
getNColumns
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> m Word32 | Returns: the number of columns |
Deprecated: (Since version 1.24)Use ListModel
instead
Retrieves the number of columns inside model
.
Since: 0.6
getNRows
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> m Word32 | Returns: The length of the |
Deprecated: (Since version 1.24)Use ListModel
instead
Retrieves the number of rows inside model
, eventually taking
into account any filtering function set using modelSetFilter
.
Since: 0.6
getSortingColumn
modelGetSortingColumn Source #
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> m Int32 | Returns: a column number, or -1 if the model is not sorted |
Deprecated: (Since version 1.24)Use ListModel
instead
Retrieves the number of column used for sorting the model
.
Since: 0.6
insertValue
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> Word32 |
|
-> Word32 |
|
-> GValue |
|
-> 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. If the row does
not exist then it is created.
Since: 0.6
insertv
prependv
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> [Word32] |
|
-> [GValue] |
|
-> m () |
remove
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> Word32 |
|
-> m () |
Deprecated: (Since version 1.24)Use ListModel
instead
Removes the row at the given position from the model.
Since: 0.6
resort
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> m () |
setFilter
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> Maybe ModelFilterFunc |
|
-> m () |
Deprecated: (Since version 1.24)Use ListModel
instead
Filters the model
using the given filtering function.
Since: 0.6
setNames
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> [Text] |
|
-> m () |
setSort
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> Int32 |
|
-> Maybe ModelSortFunc |
|
-> m () |
Deprecated: (Since version 1.24)Use ListModel
instead
Sorts model
using the given sorting function.
Since: 0.6
setSortingColumn
modelSetSortingColumn Source #
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> Int32 |
|
-> m () |
Deprecated: (Since version 1.24)Use ListModel
instead
Sets the model to sort by column
. If column
is a negative value
the sorting column will be unset.
Since: 0.6
setTypes
:: (HasCallStack, MonadIO m, IsModel a) | |
=> a |
|
-> [GType] |
|
-> m () |
Properties
filterSet
Whether the Model
has a filter set
This property is set to True
if a filter function has been
set using modelSetFilter
Since: 1.0
getModelFilterSet :: (MonadIO m, IsModel o) => o -> m Bool Source #
Get the value of the “filter-set
” property.
When overloading is enabled, this is equivalent to
get
model #filterSet
Signals
filterChanged
type ModelFilterChangedCallback = IO () Source #
Deprecated: (Since version 1.24)Use ListModel
instead
The filterChanged signal is emitted when a new filter has been applied
Since: 0.6
afterModelFilterChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelFilterChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the filterChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
model #filterChanged callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onModelFilterChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelFilterChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the filterChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
model #filterChanged callback
rowAdded
type ModelRowAddedCallback Source #
afterModelRowAdded :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowAddedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the rowAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
model #rowAdded callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onModelRowAdded :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowAddedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the rowAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
model #rowAdded callback
rowChanged
type ModelRowChangedCallback Source #
Deprecated: (Since version 1.24)Use ListModel
instead
The rowRemoved signal is emitted when a row has been changed. The data on the row has already been updated when the rowChanged signal has been emitted.
Since: 0.6
afterModelRowChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the rowChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
model #rowChanged callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onModelRowChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the rowChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
model #rowChanged callback
rowRemoved
type ModelRowRemovedCallback Source #
Deprecated: (Since version 1.24)Use ListModel
instead
The rowRemoved signal is emitted when a row has been removed. The data on the row pointed by the passed iterator is still valid when the rowRemoved signal has been emitted.
Since: 0.6
afterModelRowRemoved :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowRemovedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the rowRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
model #rowRemoved callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onModelRowRemoved :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelRowRemovedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the rowRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
model #rowRemoved callback
sortChanged
type ModelSortChangedCallback = IO () Source #
Deprecated: (Since version 1.24)Use ListModel
instead
The sortChanged signal is emitted after the model has been sorted
Since: 0.6
afterModelSortChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelSortChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the sortChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
model #sortChanged callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onModelSortChanged :: (IsModel a, MonadIO m) => a -> ((?self :: a) => ModelSortChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the sortChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
model #sortChanged callback