GI.Gio.Objects.ListStore

ListStore is a simple implementation of ListModel that stores all items in memory.

It provides insertions, deletions, and lookups in logarithmic time with a fast path for the common case of iterating the list linearly.

Exported types

newtype ListStore

Constructors

ListStore (ManagedPtr ListStore)

Instances

GObject ListStore

Methods

gobjectType :: ListStore -> IO GType

IsObject ListStore

IsListModel ListStore

IsListStore ListStore

((~) * info (ResolveListStoreMethod t ListStore), MethodInfo * info ListStore p) => IsLabel t (ListStore -> p)

Methods

fromLabel :: Proxy# Symbol t -> ListStore -> p

((~) * info (ResolveListStoreMethod t ListStore), MethodInfo * info ListStore p) => IsLabelProxy t (ListStore -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> ListStore -> p

HasAttributeList * ListStore

type AttributeList ListStore

type AttributeList ListStore

type SignalList ListStore

type SignalList ListStore

class GObject o => IsListStore o

Instances

(GObject a, UnknownAncestorError Constraint ListStore a) => IsListStore a

IsListStore ListStore

toListStore :: IsListStore o => o -> IO ListStore

noListStore :: Maybe ListStore

Methods

append

data ListStoreAppendMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsListStore a, IsObject b) => MethodInfo * ListStoreAppendMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ListStoreAppendMethodInfo a -> signature -> s

listStoreAppend

Arguments

:: (HasCallStack, MonadIO m, IsListStore a, IsObject b)

=> a

store: a ListStore

-> b

item: the new item

-> m ()

Appends item to store. item must be of type ListStore:item-type.

This function takes a ref on item.

Use listStoreSplice to append multiple items at the same time efficiently.

Since: 2.44

insert

data ListStoreInsertMethodInfo

Instances

((~) * signature (Word32 -> b -> m ()), MonadIO m, IsListStore a, IsObject b) => MethodInfo * ListStoreInsertMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ListStoreInsertMethodInfo a -> signature -> s

listStoreInsert

Arguments

:: (HasCallStack, MonadIO m, IsListStore a, IsObject b)

=> a

store: a ListStore

-> Word32

position: the position at which to insert the new item

-> b

item: the new item

-> m ()

Inserts item into store at position. item must be of type ListStore:item-type or derived from it. position must be smaller than the length of the list, or equal to it to append.

This function takes a ref on item.

Use listStoreSplice to insert multiple items at the same time efficiently.

Since: 2.44

insertSorted

data ListStoreInsertSortedMethodInfo

Instances

((~) * signature (b -> CompareDataFunc -> m Word32), MonadIO m, IsListStore a, IsObject b) => MethodInfo * ListStoreInsertSortedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ListStoreInsertSortedMethodInfo a -> signature -> s

listStoreInsertSorted

Arguments

:: (HasCallStack, MonadIO m, IsListStore a, IsObject b)

=> a

store: a ListStore

-> b

item: the new item

-> CompareDataFunc

compareFunc: pairwise comparison function for sorting

-> m Word32

Returns: the position at which item was inserted

Inserts item into store at a position to be determined by the compareFunc.

The list must already be sorted before calling this function or the result is undefined. Usually you would approach this by only ever inserting items by way of this function.

This function takes a ref on item.

Since: 2.44

new

listStoreNew

Arguments

:: (HasCallStack, MonadIO m)

=> GType

itemType: the GType of items in the list

-> m ListStore

Returns: a new ListStore

Creates a new ListStore with items of type itemType. itemType must be a subclass of Object.

Since: 2.44

remove

data ListStoreRemoveMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsListStore a) => MethodInfo * ListStoreRemoveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ListStoreRemoveMethodInfo a -> signature -> s

listStoreRemove

Arguments

:: (HasCallStack, MonadIO m, IsListStore a)

=> a

store: a ListStore

-> Word32

position: the position of the item that is to be removed

-> m ()

Removes the item from store that is at position. position must be smaller than the current length of the list.

Use listStoreSplice to remove multiple items at the same time efficiently.

Since: 2.44

removeAll

data ListStoreRemoveAllMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsListStore a) => MethodInfo * ListStoreRemoveAllMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ListStoreRemoveAllMethodInfo a -> signature -> s

listStoreRemoveAll

Arguments

:: (HasCallStack, MonadIO m, IsListStore a)

=> a

store: a ListStore

-> m ()

Removes all items from store.

Since: 2.44

sort

data ListStoreSortMethodInfo

Instances

((~) * signature (CompareDataFunc -> m ()), MonadIO m, IsListStore a) => MethodInfo * ListStoreSortMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ListStoreSortMethodInfo a -> signature -> s

listStoreSort

Arguments

:: (HasCallStack, MonadIO m, IsListStore a)

=> a

store: a ListStore

-> CompareDataFunc

compareFunc: pairwise comparison function for sorting

-> m ()

Sort the items in store according to compareFunc.

Since: 2.46

splice

data ListStoreSpliceMethodInfo

Instances

((~) * signature (Word32 -> Word32 -> [Object] -> m ()), MonadIO m, IsListStore a) => MethodInfo * ListStoreSpliceMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ListStoreSpliceMethodInfo a -> signature -> s

listStoreSplice

Arguments

:: (HasCallStack, MonadIO m, IsListStore a)

=> a

store: a ListStore

-> Word32

position: the position at which to make the change

-> Word32

nRemovals: the number of items to remove

-> [Object]

additions: the items to add

-> m ()

Changes store by removing nRemovals items and adding nAdditions items to it. additions must contain nAdditions items of type ListStore:item-type. Nothing is not permitted.

This function is more efficient than listStoreInsert and listStoreRemove, because it only emits ListModel::items-changed once for the change.

This function takes a ref on each item in additions.

The parameters position and nRemovals must be correct (ie: position + nRemovals must be less than or equal to the length of the list at the time this function is called).

Since: 2.44

Properties

itemType

data ListStoreItemTypePropertyInfo

Instances

AttrInfo ListStoreItemTypePropertyInfo

Associated Types

type AttrAllowedOps ListStoreItemTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ListStoreItemTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ListStoreItemTypePropertyInfo :: * -> Constraint

type AttrGetType ListStoreItemTypePropertyInfo :: *

type AttrLabel ListStoreItemTypePropertyInfo :: Symbol

type AttrOrigin ListStoreItemTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ListStoreItemTypePropertyInfo o => Proxy * ListStoreItemTypePropertyInfo -> o -> IO (AttrGetType ListStoreItemTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint ListStoreItemTypePropertyInfo o, AttrSetTypeConstraint ListStoreItemTypePropertyInfo b) => Proxy * ListStoreItemTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ListStoreItemTypePropertyInfo o => Proxy * ListStoreItemTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ListStoreItemTypePropertyInfo o, AttrSetTypeConstraint ListStoreItemTypePropertyInfo b) => Proxy * ListStoreItemTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ListStoreItemTypePropertyInfo

type AttrOrigin ListStoreItemTypePropertyInfo = ListStore

type AttrLabel ListStoreItemTypePropertyInfo

type AttrLabel ListStoreItemTypePropertyInfo = "item-type"

type AttrGetType ListStoreItemTypePropertyInfo

type AttrGetType ListStoreItemTypePropertyInfo = GType

type AttrBaseTypeConstraint ListStoreItemTypePropertyInfo

type AttrBaseTypeConstraint ListStoreItemTypePropertyInfo = IsListStore

type AttrSetTypeConstraint ListStoreItemTypePropertyInfo

type AttrSetTypeConstraint ListStoreItemTypePropertyInfo = * ~ GType

type AttrAllowedOps ListStoreItemTypePropertyInfo

type AttrAllowedOps ListStoreItemTypePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructListStoreItemType :: IsListStore o => GType -> IO (GValueConstruct o)

getListStoreItemType :: (MonadIO m, IsListStore o) => o -> m GType

listStoreItemType :: AttrLabelProxy "itemType"