GI.Gtk.Objects.FilterListModel

FilterListModel is a list model that filters a given other listmodel. It hides some elements from the other model according to criteria given by a FilterListModelFilterFunc.

Exported types

newtype FilterListModel

Memory-managed wrapper type.

Constructors

FilterListModel (ManagedPtr FilterListModel)

Instances

Eq FilterListModel

Defined in GI.Gtk.Objects.FilterListModel

Methods

(==) :: FilterListModel -> FilterListModel -> Bool

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

IsGValue FilterListModel

Convert FilterListModel to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.FilterListModel

Methods

toGValue :: FilterListModel -> IO GValue

fromGValue :: GValue -> IO FilterListModel

GObject FilterListModel

Defined in GI.Gtk.Objects.FilterListModel

Methods

gobjectType :: IO GType

HasParentTypes FilterListModel

Defined in GI.Gtk.Objects.FilterListModel

type ParentTypes FilterListModel

Defined in GI.Gtk.Objects.FilterListModel

type ParentTypes FilterListModel = '[Object, ListModel]

class (GObject o, IsDescendantOf FilterListModel o) => IsFilterListModel o

Type class for types which can be safely cast to FilterListModel, for instance with toFilterListModel.

Instances

(GObject o, IsDescendantOf FilterListModel o) => IsFilterListModel o

Defined in GI.Gtk.Objects.FilterListModel

toFilterListModel :: (MonadIO m, IsFilterListModel o) => o -> m FilterListModel

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

noFilterListModel :: Maybe FilterListModel

A convenience alias for Nothing :: Maybe FilterListModel.

Methods

Overloaded methods

getModel

filterListModelGetModel

Arguments

:: (HasCallStack, MonadIO m, IsFilterListModel a)

=> a

self: a FilterListModel

-> m (Maybe ListModel)

Returns: The model that gets filtered

Gets the model currently filtered or Nothing if none.

hasFilter

filterListModelHasFilter

Arguments

:: (HasCallStack, MonadIO m, IsFilterListModel a)

=> a

self: a FilterListModel

-> m Bool

Returns: True if a filter function is set

Checks if a filter function is currently set on self

new

filterListModelNew

Arguments

:: (HasCallStack, MonadIO m, IsListModel a)

=> a

model: the model to sort

-> Maybe FilterListModelFilterFunc

filterFunc: filter function or Nothing to not filter items

-> m FilterListModel

Returns: a new FilterListModel

Creates a new FilterListModel that will filter model using the given filterFunc.

newForType

filterListModelNewForType

Arguments

:: (HasCallStack, MonadIO m)

=> GType

itemType: the type of the items that will be returned

-> m FilterListModel

Returns: a new FilterListModel

Creates a new empty filter list model set up to return items of type itemType. It is up to the application to set a proper filter function and model to ensure the item type is matched.

refilter

filterListModelRefilter

Arguments

:: (HasCallStack, MonadIO m, IsFilterListModel a)

=> a

self: a FilterListModel

-> m ()

Causes self to refilter all items in the model.

Calling this function is necessary when data used by the filter function has changed.

setFilterFunc

filterListModelSetFilterFunc

Arguments

:: (HasCallStack, MonadIO m, IsFilterListModel a)

=> a

self: a FilterListModel

-> Maybe FilterListModelFilterFunc

filterFunc: filter function or Nothing to not filter items

-> m ()

Sets the function used to filter items. The function will be called for every item and if it returns True the item is considered visible.

setModel

filterListModelSetModel

Arguments

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

=> a

self: a FilterListModel

-> Maybe b

model: The model to be filtered

-> m ()

Sets the model to be filtered.

Note that GTK makes no effort to ensure that model conforms to the item type of self. It assumes that the caller knows what they are doing and have set up an appropriate filter function to ensure that item types match.

Properties

hasFilter

If a filter is set for this model

getFilterListModelHasFilter :: (MonadIO m, IsFilterListModel o) => o -> m Bool

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

get filterListModel #hasFilter

itemType

The GType for elements of this object

constructFilterListModelItemType :: IsFilterListModel o => GType -> IO (GValueConstruct o)

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

getFilterListModelItemType :: (MonadIO m, IsFilterListModel o) => o -> m GType

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

get filterListModel #itemType

model

The model being filtered

constructFilterListModelModel :: (IsFilterListModel o, IsListModel a) => a -> IO (GValueConstruct o)

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

getFilterListModelModel :: (MonadIO m, IsFilterListModel o) => o -> m (Maybe ListModel)

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

get filterListModel #model