GI.Atk.Interfaces.Selection

Selection should be implemented by UI components with children which are exposed by atk_object_ref_child and atk_object_get_n_children, if the use of the parent UI component ordinarily involves selection of one or more of the objects corresponding to those Object children - for example, selectable lists.

Note that other types of "selection" (for instance text selection) are accomplished a other ATK interfaces - Selection is limited to the selection/deselection of children.

Exported types

newtype Selection

Memory-managed wrapper type.

Constructors

Selection (ManagedPtr Selection)

Instances

Eq Selection

Defined in GI.Atk.Interfaces.Selection

Methods

(==) :: Selection -> Selection -> Bool

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

IsGValue Selection

Convert Selection to and from GValue with toGValue and fromGValue.

Defined in GI.Atk.Interfaces.Selection

Methods

toGValue :: Selection -> IO GValue

fromGValue :: GValue -> IO Selection

ManagedPtrNewtype Selection

Defined in GI.Atk.Interfaces.Selection

Methods

toManagedPtr :: Selection -> ManagedPtr Selection

TypedObject Selection

Defined in GI.Atk.Interfaces.Selection

Methods

glibType :: IO GType

GObject Selection

Defined in GI.Atk.Interfaces.Selection

HasParentTypes Selection

Defined in GI.Atk.Interfaces.Selection

type ParentTypes Selection

Defined in GI.Atk.Interfaces.Selection

type ParentTypes Selection = '[Object]

class (GObject o, IsDescendantOf Selection o) => IsSelection o

Type class for types which can be safely cast to Selection, for instance with toSelection.

Instances

(GObject o, IsDescendantOf Selection o) => IsSelection o

Defined in GI.Atk.Interfaces.Selection

toSelection :: (MonadIO m, IsSelection o) => o -> m Selection

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

Methods

Overloaded methods

addSelection

selectionAddSelection

Arguments

:: (HasCallStack, MonadIO m, IsSelection a)

=> a

selection: a Object instance that implements AtkSelectionIface

-> Int32

i: a gint specifying the child index.

-> m Bool

Returns: TRUE if success, FALSE otherwise.

Adds the specified accessible child of the object to the object's selection.

clearSelection

selectionClearSelection

Arguments

:: (HasCallStack, MonadIO m, IsSelection a)

=> a

selection: a Object instance that implements AtkSelectionIface

-> m Bool

Returns: TRUE if success, FALSE otherwise.

Clears the selection in the object so that no children in the object are selected.

getSelectionCount

selectionGetSelectionCount

Arguments

:: (HasCallStack, MonadIO m, IsSelection a)

=> a

selection: a Object instance that implements AtkSelectionIface

-> m Int32

Returns: a gint representing the number of items selected, or 0 if selection does not implement this interface.

Gets the number of accessible children currently selected. Note: callers should not rely on Nothing or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

isChildSelected

selectionIsChildSelected

Arguments

:: (HasCallStack, MonadIO m, IsSelection a)

=> a

selection: a Object instance that implements AtkSelectionIface

-> Int32

i: a gint specifying the child index.

-> m Bool

Returns: a gboolean representing the specified child is selected, or 0 if selection does not implement this interface.

Determines if the current child of this object is selected Note: callers should not rely on Nothing or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

refSelection

selectionRefSelection

Arguments

:: (HasCallStack, MonadIO m, IsSelection a)

=> a

selection: a Object instance that implements AtkSelectionIface

-> Int32

i: a gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

-> m (Maybe Object)

Returns: an Object representing the selected accessible, or Nothing if selection does not implement this interface.

Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on Nothing or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

removeSelection

selectionRemoveSelection

Arguments

:: (HasCallStack, MonadIO m, IsSelection a)

=> a

selection: a Object instance that implements AtkSelectionIface

-> Int32

i: a gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

-> m Bool

Returns: TRUE if success, FALSE otherwise.

Removes the specified child of the object from the object's selection.

selectAllSelection

selectionSelectAllSelection

Arguments

:: (HasCallStack, MonadIO m, IsSelection a)

=> a

selection: a Object instance that implements AtkSelectionIface

-> m Bool

Returns: TRUE if success, FALSE otherwise.

Causes every child of the object to be selected if the object supports multiple selections.

Signals

selectionChanged

type C_SelectionSelectionChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SelectionSelectionChangedCallback = IO ()

The "selection-changed" signal is emitted by an object which implements AtkSelection interface when the selection changes.

afterSelectionSelectionChanged :: (IsSelection a, MonadIO m) => a -> SelectionSelectionChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectionChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after selection #selectionChanged callback

genClosure_SelectionSelectionChanged :: MonadIO m => SelectionSelectionChangedCallback -> m (GClosure C_SelectionSelectionChangedCallback)

Wrap the callback into a GClosure.

mk_SelectionSelectionChangedCallback :: C_SelectionSelectionChangedCallback -> IO (FunPtr C_SelectionSelectionChangedCallback)

Generate a function pointer callable from C code, from a C_SelectionSelectionChangedCallback.

noSelectionSelectionChangedCallback :: Maybe SelectionSelectionChangedCallback

A convenience synonym for Nothing :: Maybe SelectionSelectionChangedCallback.

onSelectionSelectionChanged :: (IsSelection a, MonadIO m) => a -> SelectionSelectionChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectionChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on selection #selectionChanged callback

wrap_SelectionSelectionChangedCallback :: SelectionSelectionChangedCallback -> C_SelectionSelectionChangedCallback

Wrap a SelectionSelectionChangedCallback into a C_SelectionSelectionChangedCallback.