GI.Gtk.Objects.SliceListModel

GtkSliceListModel is a list model that presents a slice of another model.

This is useful when implementing paging by setting the size to the number of elements per page and updating the offset whenever a different page is opened.

GtkSliceListModel passes through sections from the underlying model.

Exported types

newtype SliceListModel

Memory-managed wrapper type.

Constructors

SliceListModel (ManagedPtr SliceListModel)

Instances

Eq SliceListModel

Defined in GI.Gtk.Objects.SliceListModel

Methods

(==) :: SliceListModel -> SliceListModel -> Bool

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

GObject SliceListModel

Defined in GI.Gtk.Objects.SliceListModel

ManagedPtrNewtype SliceListModel

Defined in GI.Gtk.Objects.SliceListModel

Methods

toManagedPtr :: SliceListModel -> ManagedPtr SliceListModel

TypedObject SliceListModel

Defined in GI.Gtk.Objects.SliceListModel

Methods

glibType :: IO GType

HasParentTypes SliceListModel

Defined in GI.Gtk.Objects.SliceListModel

IsGValue (Maybe SliceListModel)

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

Defined in GI.Gtk.Objects.SliceListModel

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SliceListModel

Defined in GI.Gtk.Objects.SliceListModel

type ParentTypes SliceListModel = '[Object, ListModel, SectionModel]

class (GObject o, IsDescendantOf SliceListModel o) => IsSliceListModel o

Type class for types which can be safely cast to SliceListModel, for instance with toSliceListModel.

Instances

(GObject o, IsDescendantOf SliceListModel o) => IsSliceListModel o

Defined in GI.Gtk.Objects.SliceListModel

toSliceListModel :: (MonadIO m, IsSliceListModel o) => o -> m SliceListModel

Cast to SliceListModel, 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, forceFloating, freezeNotify, getv, isFloating, itemsChanged, notify, notifyByPspec, ref, refSink, runDispose, sectionsChanged, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getItem, getItemType, getModel, getNItems, getOffset, getProperty, getQdata, getSection, getSize.

Setters

setData, setDataFull, setModel, setOffset, setProperty, setSize.

getModel

sliceListModelGetModel

Arguments

:: (HasCallStack, MonadIO m, IsSliceListModel a)

=> a

self: a GtkSliceListModel

-> m (Maybe ListModel)

Returns: The model in use

Gets the model that is currently being used or Nothing if none.

getOffset

sliceListModelGetOffset

Arguments

:: (HasCallStack, MonadIO m, IsSliceListModel a)

=> a

self: a GtkSliceListModel

-> m Word32

Returns: The offset

Gets the offset set via sliceListModelSetOffset.

getSize

sliceListModelGetSize

Arguments

:: (HasCallStack, MonadIO m, IsSliceListModel a)

=> a

self: a GtkSliceListModel

-> m Word32

Returns: The size

Gets the size set via sliceListModelSetSize.

new

sliceListModelNew

Arguments

:: (HasCallStack, MonadIO m, IsListModel a)

=> Maybe a

model: The model to use

-> Word32

offset: the offset of the slice

-> Word32

size: maximum size of the slice

-> m SliceListModel

Returns: A new GtkSliceListModel

Creates a new slice model.

It presents the slice from offset to offset + size of the given model.

setModel

sliceListModelSetModel

Arguments

:: (HasCallStack, MonadIO m, IsSliceListModel a, IsListModel b)

=> a

self: a GtkSliceListModel

-> Maybe b

model: The model to be sliced

-> m ()

Sets the model to show a slice of.

The model's item type must conform to self's item type.

setOffset

sliceListModelSetOffset

Arguments

:: (HasCallStack, MonadIO m, IsSliceListModel a)

=> a

self: a GtkSliceListModel

-> Word32

offset: the new offset to use

-> m ()

Sets the offset into the original model for this slice.

If the offset is too large for the sliced model, self will end up empty.

setSize

sliceListModelSetSize

Arguments

:: (HasCallStack, MonadIO m, IsSliceListModel a)

=> a

self: a GtkSliceListModel

-> Word32

size: the maximum size

-> m ()

Sets the maximum size. self will never have more items than size.

It can however have fewer items if the offset is too large or the model sliced from doesn't have enough items.

Properties

itemType

The type of items. See listModelGetItemType.

Since: 4.8

getSliceListModelItemType :: (MonadIO m, IsSliceListModel o) => o -> m GType

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

get sliceListModel #itemType

model

Child model to take slice from.

clearSliceListModelModel :: (MonadIO m, IsSliceListModel o) => o -> m ()

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

clear #model

constructSliceListModelModel :: (IsSliceListModel o, MonadIO m, IsListModel 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.

getSliceListModelModel :: (MonadIO m, IsSliceListModel o) => o -> m (Maybe ListModel)

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

get sliceListModel #model

setSliceListModelModel :: (MonadIO m, IsSliceListModel o, IsListModel a) => o -> a -> m ()

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

set sliceListModel [ #model := value ]

nItems

The number of items. See listModelGetNItems.

Since: 4.8

getSliceListModelNItems :: (MonadIO m, IsSliceListModel o) => o -> m Word32

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

get sliceListModel #nItems

offset

Offset of slice.

constructSliceListModelOffset :: (IsSliceListModel o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSliceListModelOffset :: (MonadIO m, IsSliceListModel o) => o -> m Word32

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

get sliceListModel #offset

setSliceListModelOffset :: (MonadIO m, IsSliceListModel o) => o -> Word32 -> m ()

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

set sliceListModel [ #offset := value ]

size

Maximum size of slice.

constructSliceListModelSize :: (IsSliceListModel o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSliceListModelSize :: (MonadIO m, IsSliceListModel o) => o -> m Word32

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

get sliceListModel #size

setSliceListModelSize :: (MonadIO m, IsSliceListModel o) => o -> Word32 -> m ()

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

set sliceListModel [ #size := value ]