Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Atk.Interfaces.Selection
Contents
Description
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.
- newtype Selection = Selection (ManagedPtr Selection)
- noSelection :: Maybe Selection
- class GObject o => IsSelection o
- toSelection :: (MonadIO m, IsSelection o) => o -> m Selection
- data SelectionAddSelectionMethodInfo
- selectionAddSelection :: (HasCallStack, MonadIO m, IsSelection a) => a -> Int32 -> m Bool
- data SelectionClearSelectionMethodInfo
- selectionClearSelection :: (HasCallStack, MonadIO m, IsSelection a) => a -> m Bool
- data SelectionGetSelectionCountMethodInfo
- selectionGetSelectionCount :: (HasCallStack, MonadIO m, IsSelection a) => a -> m Int32
- data SelectionIsChildSelectedMethodInfo
- selectionIsChildSelected :: (HasCallStack, MonadIO m, IsSelection a) => a -> Int32 -> m Bool
- data SelectionRefSelectionMethodInfo
- selectionRefSelection :: (HasCallStack, MonadIO m, IsSelection a) => a -> Int32 -> m (Maybe Object)
- data SelectionRemoveSelectionMethodInfo
- selectionRemoveSelection :: (HasCallStack, MonadIO m, IsSelection a) => a -> Int32 -> m Bool
- data SelectionSelectAllSelectionMethodInfo
- selectionSelectAllSelection :: (HasCallStack, MonadIO m, IsSelection a) => a -> m Bool
- type C_SelectionSelectionChangedCallback = Ptr () -> Ptr () -> IO ()
- type SelectionSelectionChangedCallback = IO ()
- data SelectionSelectionChangedSignalInfo
- afterSelectionSelectionChanged :: (IsSelection a, MonadIO m) => a -> SelectionSelectionChangedCallback -> m SignalHandlerId
- genClosure_SelectionSelectionChanged :: SelectionSelectionChangedCallback -> IO Closure
- mk_SelectionSelectionChangedCallback :: C_SelectionSelectionChangedCallback -> IO (FunPtr C_SelectionSelectionChangedCallback)
- noSelectionSelectionChangedCallback :: Maybe SelectionSelectionChangedCallback
- onSelectionSelectionChanged :: (IsSelection a, MonadIO m) => a -> SelectionSelectionChangedCallback -> m SignalHandlerId
- wrap_SelectionSelectionChangedCallback :: SelectionSelectionChangedCallback -> Ptr () -> Ptr () -> IO ()
Exported types
Constructors
Selection (ManagedPtr Selection) |
Instances
GObject Selection # | |
IsObject Selection # | |
IsSelection Selection # | |
((~) * info (ResolveSelectionMethod t Selection), MethodInfo * info Selection p) => IsLabel t (Selection -> p) # | |
((~) * info (ResolveSelectionMethod t Selection), MethodInfo * info Selection p) => IsLabelProxy t (Selection -> p) # | |
HasAttributeList * Selection # | |
type AttributeList Selection # | |
type SignalList Selection # | |
class GObject o => IsSelection o #
Instances
toSelection :: (MonadIO m, IsSelection o) => o -> m Selection #
Methods
addSelection
data SelectionAddSelectionMethodInfo #
Instances
((~) * signature (Int32 -> m Bool), MonadIO m, IsSelection a) => MethodInfo * SelectionAddSelectionMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsSelection a) | |
=> a |
|
-> Int32 |
|
-> m Bool | Returns: TRUE if success, FALSE otherwise. |
Adds the specified accessible child of the object to the object's selection.
clearSelection
data SelectionClearSelectionMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m, IsSelection a) => MethodInfo * SelectionClearSelectionMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsSelection a) | |
=> a |
|
-> m Bool | Returns: TRUE if success, FALSE otherwise. |
Clears the selection in the object so that no children in the object are selected.
getSelectionCount
data SelectionGetSelectionCountMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsSelection a) => MethodInfo * SelectionGetSelectionCountMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsSelection a) | |
=> a |
|
-> m Int32 | Returns: a gint representing the number of items selected, or 0
if |
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
data SelectionIsChildSelectedMethodInfo #
Instances
((~) * signature (Int32 -> m Bool), MonadIO m, IsSelection a) => MethodInfo * SelectionIsChildSelectedMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsSelection a) | |
=> a |
|
-> Int32 |
|
-> m Bool | Returns: a gboolean representing the specified child is selected, or 0
if |
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
data SelectionRefSelectionMethodInfo #
Instances
((~) * signature (Int32 -> m (Maybe Object)), MonadIO m, IsSelection a) => MethodInfo * SelectionRefSelectionMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsSelection a) | |
=> a |
|
-> Int32 |
|
-> m (Maybe Object) | Returns: an |
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
data SelectionRemoveSelectionMethodInfo #
Instances
((~) * signature (Int32 -> m Bool), MonadIO m, IsSelection a) => MethodInfo * SelectionRemoveSelectionMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsSelection a) | |
=> a |
|
-> Int32 |
|
-> m Bool | Returns: TRUE if success, FALSE otherwise. |
Removes the specified child of the object from the object's selection.
selectAllSelection
data SelectionSelectAllSelectionMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m, IsSelection a) => MethodInfo * SelectionSelectAllSelectionMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsSelection a) | |
=> a |
|
-> 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 SelectionSelectionChangedCallback = IO () #
afterSelectionSelectionChanged :: (IsSelection a, MonadIO m) => a -> SelectionSelectionChangedCallback -> m SignalHandlerId #
mk_SelectionSelectionChangedCallback :: C_SelectionSelectionChangedCallback -> IO (FunPtr C_SelectionSelectionChangedCallback) #
onSelectionSelectionChanged :: (IsSelection a, MonadIO m) => a -> SelectionSelectionChangedCallback -> m SignalHandlerId #
wrap_SelectionSelectionChangedCallback :: SelectionSelectionChangedCallback -> Ptr () -> Ptr () -> IO () #