GI.Gtk.Objects.SingleSelection

GtkSingleSelection is an implementation of the SelectionModel interface that allows selecting a single element. It is the default selection method used by list widgets in GTK.

Note that the selection is *persistent* -- if the selected item is removed and re-added in the same itemsChanged emission, it stays selected. In particular, this means that changing the sort order of an underlying sort model will preserve the selection.

Exported types

newtype SingleSelection

Memory-managed wrapper type.

Constructors

SingleSelection (ManagedPtr SingleSelection)

Instances

Eq SingleSelection

Defined in GI.Gtk.Objects.SingleSelection

Methods

(==) :: SingleSelection -> SingleSelection -> Bool

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

GObject SingleSelection

Defined in GI.Gtk.Objects.SingleSelection

ManagedPtrNewtype SingleSelection

Defined in GI.Gtk.Objects.SingleSelection

Methods

toManagedPtr :: SingleSelection -> ManagedPtr SingleSelection

TypedObject SingleSelection

Defined in GI.Gtk.Objects.SingleSelection

Methods

glibType :: IO GType

HasParentTypes SingleSelection

Defined in GI.Gtk.Objects.SingleSelection

IsGValue (Maybe SingleSelection)

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

Defined in GI.Gtk.Objects.SingleSelection

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SingleSelection

Defined in GI.Gtk.Objects.SingleSelection

type ParentTypes SingleSelection = '[Object, ListModel, SelectionModel]

class (GObject o, IsDescendantOf SingleSelection o) => IsSingleSelection o

Type class for types which can be safely cast to SingleSelection, for instance with toSingleSelection.

Instances

(GObject o, IsDescendantOf SingleSelection o) => IsSingleSelection o

Defined in GI.Gtk.Objects.SingleSelection

toSingleSelection :: (MonadIO m, IsSingleSelection o) => o -> m SingleSelection

Cast to SingleSelection, 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, isSelected, itemsChanged, notify, notifyByPspec, ref, refSink, runDispose, selectAll, selectItem, selectRange, selectionChanged, stealData, stealQdata, thawNotify, unref, unselectAll, unselectItem, unselectRange, watchClosure.

Getters

getAutoselect, getCanUnselect, getData, getItem, getItemType, getModel, getNItems, getProperty, getQdata, getSelected, getSelectedItem, getSelection, getSelectionInRange.

Setters

setAutoselect, setCanUnselect, setData, setDataFull, setModel, setProperty, setSelected, setSelection.

getAutoselect

singleSelectionGetAutoselect

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> m Bool

Returns: True if autoselect is enabled

Checks if autoselect has been enabled or disabled via singleSelectionSetAutoselect.

getCanUnselect

singleSelectionGetCanUnselect

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> m Bool

Returns: True to support unselecting

If True, selectionModelUnselectItem is supported and allows unselecting the selected item.

getModel

singleSelectionGetModel

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> m ListModel

Returns: The model being wrapped

Gets the model that self is wrapping.

getSelected

singleSelectionGetSelected

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> m Word32

Returns: The position of the selected item

Gets the position of the selected item. If no item is selected, GTK_INVALID_LIST_POSITION is returned.

getSelectedItem

singleSelectionGetSelectedItem

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> m (Ptr ())

Returns: The selected item

Gets the selected item.

If no item is selected, Nothing is returned.

new

singleSelectionNew

Arguments

:: (HasCallStack, MonadIO m, IsListModel a)

=> Maybe a

model: the ListModel to manage, or Nothing

-> m SingleSelection

Returns: a new SingleSelection

Creates a new selection to handle model.

setAutoselect

singleSelectionSetAutoselect

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> Bool

autoselect: True to always select an item

-> m ()

If autoselect is True, self will enforce that an item is always selected. It will select a new item when the currently selected item is deleted and it will disallow unselecting the current item.

setCanUnselect

singleSelectionSetCanUnselect

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> Bool

canUnselect: True to allow unselecting

-> m ()

If True, unselecting the current item via selectionModelUnselectItem is supported.

Note that setting SingleSelection:autoselect will cause the unselecting to not work, so it practically makes no sense to set both at the same time the same time.

setModel

singleSelectionSetModel

Arguments

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

=> a

self: a SingleSelection

-> Maybe b

model: A ListModel to wrap

-> m ()

Sets the model that self should wrap. If model is Nothing, self will be empty.

setSelected

singleSelectionSetSelected

Arguments

:: (HasCallStack, MonadIO m, IsSingleSelection a)

=> a

self: a SingleSelection

-> Word32

position: the item to select or GTK_INVALID_LIST_POSITION

-> m ()

Selects the item at the given position.

If the list does not have an item at position or GTK_INVALID_LIST_POSITION is given, the behavior depends on the value of the SingleSelection:autoselect property: If it is set, no change will occur and the old item will stay selected. If it is unset, the selection will be unset and no item will be selected.

Properties

autoselect

If the selection will always select an item

constructSingleSelectionAutoselect :: (IsSingleSelection o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSingleSelectionAutoselect :: (MonadIO m, IsSingleSelection o) => o -> m Bool

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

get singleSelection #autoselect

setSingleSelectionAutoselect :: (MonadIO m, IsSingleSelection o) => o -> Bool -> m ()

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

set singleSelection [ #autoselect := value ]

canUnselect

If unselecting the selected item is allowed

constructSingleSelectionCanUnselect :: (IsSingleSelection o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSingleSelectionCanUnselect :: (MonadIO m, IsSingleSelection o) => o -> m Bool

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

get singleSelection #canUnselect

setSingleSelectionCanUnselect :: (MonadIO m, IsSingleSelection o) => o -> Bool -> m ()

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

set singleSelection [ #canUnselect := value ]

model

The model being managed

clearSingleSelectionModel :: (MonadIO m, IsSingleSelection o) => o -> m ()

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

clear #model

constructSingleSelectionModel :: (IsSingleSelection 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.

getSingleSelectionModel :: (MonadIO m, IsSingleSelection o) => o -> m ListModel

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

get singleSelection #model

setSingleSelectionModel :: (MonadIO m, IsSingleSelection o, IsListModel a) => o -> a -> m ()

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

set singleSelection [ #model := value ]

selected

Position of the selected item

constructSingleSelectionSelected :: (IsSingleSelection o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSingleSelectionSelected :: (MonadIO m, IsSingleSelection o) => o -> m Word32

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

get singleSelection #selected

setSingleSelectionSelected :: (MonadIO m, IsSingleSelection o) => o -> Word32 -> m ()

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

set singleSelection [ #selected := value ]

selectedItem

The selected item

getSingleSelectionSelectedItem :: (MonadIO m, IsSingleSelection o) => o -> m (Maybe Object)

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

get singleSelection #selectedItem