| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Atk.Interfaces.Action
Description
The ATK interface provided by UI components which the user can activate/interact with.
Action should be implemented by instances of Object classes
with which the user can interact directly, i.e. buttons,
checkboxes, scrollbars, e.g. components which are not "passive"
providers of UI information.
Exceptions: when the user interaction is already covered by another
appropriate interface such as EditableText (insert/delete text,
etc.) or Value (set value) then these actions should not be
exposed by Action as well.
Though most UI interactions on components should be invocable via
keyboard as well as mouse, there will generally be a close mapping
between "mouse actions" that are possible on a component and the
AtkActions. Where mouse and keyboard actions are redundant in
effect, Action should expose only one action rather than
exposing redundant actions if possible. By convention we have been
using "mouse centric" terminology for Action names.
Synopsis
- newtype Action = Action (ManagedPtr Action)
- class (ManagedPtrNewtype o, IsDescendantOf Action o) => IsAction o
- type family ResolveActionMethod (t :: Symbol) o where ...
- data ActionDoActionMethodInfo
- actionDoAction :: (HasCallStack, MonadIO m, IsAction a) => a -> Int32 -> m Bool
- data ActionGetDescriptionMethodInfo
- actionGetDescription :: (HasCallStack, MonadIO m, IsAction a) => a -> Int32 -> m (Maybe Text)
- data ActionGetKeybindingMethodInfo
- actionGetKeybinding :: (HasCallStack, MonadIO m, IsAction a) => a -> Int32 -> m (Maybe Text)
- data ActionGetLocalizedNameMethodInfo
- actionGetLocalizedName :: (HasCallStack, MonadIO m, IsAction a) => a -> Int32 -> m (Maybe Text)
- data ActionGetNActionsMethodInfo
- actionGetNActions :: (HasCallStack, MonadIO m, IsAction a) => a -> m Int32
- data ActionGetNameMethodInfo
- actionGetName :: (HasCallStack, MonadIO m, IsAction a) => a -> Int32 -> m (Maybe Text)
- data ActionSetDescriptionMethodInfo
- actionSetDescription :: (HasCallStack, MonadIO m, IsAction a) => a -> Int32 -> Text -> m Bool
Exported types
Memory-managed wrapper type.
Constructors
| Action (ManagedPtr Action) |
Instances
| Eq Action Source # | |
| BoxedPtr Action Source # | |
Defined in GI.Atk.Interfaces.Action | |
| ManagedPtrNewtype Action Source # | |
Defined in GI.Atk.Interfaces.Action Methods toManagedPtr :: Action -> ManagedPtr Action # | |
| (info ~ ResolveActionMethod t Action, OverloadedMethod info Action p, HasField t Action p) => HasField (t :: Symbol) Action (p :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action | |
| (info ~ ResolveActionMethod t Action, OverloadedMethodInfo info Action) => IsLabel t (MethodProxy info Action) Source # | |
Defined in GI.Atk.Interfaces.Action Methods fromLabel :: MethodProxy info Action # | |
| (info ~ ResolveActionMethod t Action, OverloadedMethod info Action p) => IsLabel t (Action -> p) Source # | |
Defined in GI.Atk.Interfaces.Action | |
| type SignalList Action Source # | |
Defined in GI.Atk.Interfaces.Action | |
class (ManagedPtrNewtype o, IsDescendantOf Action o) => IsAction o Source #
Type class for types which implement Action.
Instances
| (ManagedPtrNewtype o, IsDescendantOf Action o) => IsAction o Source # | |
Defined in GI.Atk.Interfaces.Action | |
Methods
Click to display all available methods, including inherited ones
type family ResolveActionMethod (t :: Symbol) o where ... Source #
Equations
| ResolveActionMethod "doAction" o = ActionDoActionMethodInfo | |
| ResolveActionMethod "getDescription" o = ActionGetDescriptionMethodInfo | |
| ResolveActionMethod "getKeybinding" o = ActionGetKeybindingMethodInfo | |
| ResolveActionMethod "getLocalizedName" o = ActionGetLocalizedNameMethodInfo | |
| ResolveActionMethod "getNActions" o = ActionGetNActionsMethodInfo | |
| ResolveActionMethod "getName" o = ActionGetNameMethodInfo | |
| ResolveActionMethod "setDescription" o = ActionSetDescriptionMethodInfo | |
| ResolveActionMethod l o = MethodResolutionFailed l o :: Type |
doAction
data ActionDoActionMethodInfo Source #
Instances
| (signature ~ (Int32 -> m Bool), MonadIO m, IsAction a) => OverloadedMethod ActionDoActionMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Action Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ActionDoActionMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsAction a) | |
| => a |
|
| -> Int32 |
|
| -> m Bool |
Perform the specified action on the object.
getDescription
data ActionGetDescriptionMethodInfo Source #
Instances
| (signature ~ (Int32 -> m (Maybe Text)), MonadIO m, IsAction a) => OverloadedMethod ActionGetDescriptionMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Action Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ActionGetDescriptionMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsAction a) | |
| => a |
|
| -> Int32 |
|
| -> m (Maybe Text) | Returns: a description string, or |
Returns a description of the specified action of the object.
getKeybinding
data ActionGetKeybindingMethodInfo Source #
Instances
| (signature ~ (Int32 -> m (Maybe Text)), MonadIO m, IsAction a) => OverloadedMethod ActionGetKeybindingMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Action Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ActionGetKeybindingMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsAction a) | |
| => a |
|
| -> Int32 |
|
| -> m (Maybe Text) | Returns: the keybinding which can be used to activate
this action, or |
Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut".
- The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for a button.
- The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a traditional "New..." menu item.
- The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a traditional "New..." menu item.
Example: For a traditional "New..." menu item, the expected return value would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.
getLocalizedName
data ActionGetLocalizedNameMethodInfo Source #
Instances
| (signature ~ (Int32 -> m (Maybe Text)), MonadIO m, IsAction a) => OverloadedMethod ActionGetLocalizedNameMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Action Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ActionGetLocalizedNameMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action Methods | |
actionGetLocalizedName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAction a) | |
| => a |
|
| -> Int32 |
|
| -> m (Maybe Text) | Returns: a name string, or |
Returns the localized name of the specified action of the object.
getNActions
data ActionGetNActionsMethodInfo Source #
Instances
| (signature ~ m Int32, MonadIO m, IsAction a) => OverloadedMethod ActionGetNActionsMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Action Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ActionGetNActionsMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsAction a) | |
| => a |
|
| -> m Int32 | Returns: a the number of actions, or 0 if |
Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object.
getName
data ActionGetNameMethodInfo Source #
Instances
| (signature ~ (Int32 -> m (Maybe Text)), MonadIO m, IsAction a) => OverloadedMethod ActionGetNameMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Action Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ActionGetNameMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsAction a) | |
| => a |
|
| -> Int32 |
|
| -> m (Maybe Text) | Returns: a name string, or |
Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the 'interaction type' which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. "click", "press", "release", "drag", "drop", "popup", etc. The "popup" action should be used to pop up a context menu for the object, if one exists.
For technical reasons, some toolkits cannot guarantee that the
reported action is actually 'bound' to a nontrivial user event;
i.e. the result of some actions via actionDoAction may be
NIL.
setDescription
data ActionSetDescriptionMethodInfo Source #
Instances
| (signature ~ (Int32 -> Text -> m Bool), MonadIO m, IsAction a) => OverloadedMethod ActionSetDescriptionMethodInfo a signature Source # | |
Defined in GI.Atk.Interfaces.Action Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ActionSetDescriptionMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Interfaces.Action Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsAction a) | |
| => a |
|
| -> Int32 |
|
| -> Text |
|
| -> m Bool | Returns: a gboolean representing if the description was successfully set; |
Sets a description of the specified action of the object.