Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
The GRemoteActionGroup
interface is implemented by ActionGroup
instances that either transmit action invocations to other processes
or receive action invocations in the local process from other
processes.
The interface has _full
variants of the two
methods on ActionGroup
used to activate actions:
actionGroupActivateAction
and
actionGroupChangeActionState
. These variants allow a
‘platform data’ [structgLib
.Variant] to be specified: a dictionary providing
context for the action invocation (for example: timestamps, startup
notification IDs, etc).
DBusActionGroup
implements GRemoteActionGroup
. This provides a
mechanism to send platform data for action invocations over D-Bus.
Additionally, dBusConnectionExportActionGroup
will check if
the exported ActionGroup
implements GRemoteActionGroup
and use
the _full
variants of the calls if available. This
provides a mechanism by which to receive platform data for action
invocations that arrive by way of D-Bus.
Since: 2.32
Synopsis
- newtype RemoteActionGroup = RemoteActionGroup (ManagedPtr RemoteActionGroup)
- class (GObject o, IsDescendantOf RemoteActionGroup o) => IsRemoteActionGroup o
- toRemoteActionGroup :: (MonadIO m, IsRemoteActionGroup o) => o -> m RemoteActionGroup
- remoteActionGroupActivateActionFull :: (HasCallStack, MonadIO m, IsRemoteActionGroup a) => a -> Text -> Maybe GVariant -> GVariant -> m ()
- remoteActionGroupChangeActionStateFull :: (HasCallStack, MonadIO m, IsRemoteActionGroup a) => a -> Text -> GVariant -> GVariant -> m ()
Exported types
newtype RemoteActionGroup Source #
Memory-managed wrapper type.
Instances
Eq RemoteActionGroup Source # | |
Defined in GI.Gio.Interfaces.RemoteActionGroup (==) :: RemoteActionGroup -> RemoteActionGroup -> Bool # (/=) :: RemoteActionGroup -> RemoteActionGroup -> Bool # | |
GObject RemoteActionGroup Source # | |
Defined in GI.Gio.Interfaces.RemoteActionGroup | |
ManagedPtrNewtype RemoteActionGroup Source # | |
TypedObject RemoteActionGroup Source # | |
Defined in GI.Gio.Interfaces.RemoteActionGroup | |
HasParentTypes RemoteActionGroup Source # | |
Defined in GI.Gio.Interfaces.RemoteActionGroup | |
IsGValue (Maybe RemoteActionGroup) Source # | Convert |
Defined in GI.Gio.Interfaces.RemoteActionGroup gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe RemoteActionGroup -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe RemoteActionGroup) # | |
type ParentTypes RemoteActionGroup Source # | |
Defined in GI.Gio.Interfaces.RemoteActionGroup |
class (GObject o, IsDescendantOf RemoteActionGroup o) => IsRemoteActionGroup o Source #
Type class for types which can be safely cast to RemoteActionGroup
, for instance with toRemoteActionGroup
.
Instances
(GObject o, IsDescendantOf RemoteActionGroup o) => IsRemoteActionGroup o Source # | |
Defined in GI.Gio.Interfaces.RemoteActionGroup |
toRemoteActionGroup :: (MonadIO m, IsRemoteActionGroup o) => o -> m RemoteActionGroup Source #
Cast to RemoteActionGroup
, 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
actionAdded, actionEnabledChanged, actionRemoved, actionStateChanged, activateAction, activateActionFull, bindProperty, bindPropertyFull, changeActionState, changeActionStateFull, forceFloating, freezeNotify, getv, hasAction, isFloating, listActions, notify, notifyByPspec, queryAction, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getActionEnabled, getActionParameterType, getActionState, getActionStateHint, getActionStateType, getData, getProperty, getQdata.
Setters
activateActionFull
remoteActionGroupActivateActionFull Source #
:: (HasCallStack, MonadIO m, IsRemoteActionGroup a) | |
=> a |
|
-> Text |
|
-> Maybe GVariant |
|
-> GVariant |
|
-> m () |
Activates the remote action.
This is the same as actionGroupActivateAction
except that it
allows for provision of "platform data" to be sent along with the
activation request. This typically contains details such as the user
interaction timestamp or startup notification information.
platformData
must be non-Nothing
and must have the type
G_VARIANT_TYPE_VARDICT
. If it is floating, it will be consumed.
Since: 2.32
changeActionStateFull
remoteActionGroupChangeActionStateFull Source #
:: (HasCallStack, MonadIO m, IsRemoteActionGroup a) | |
=> a |
|
-> Text |
|
-> GVariant |
|
-> GVariant |
|
-> m () |
Changes the state of a remote action.
This is the same as actionGroupChangeActionState
except that
it allows for provision of "platform data" to be sent along with the
state change request. This typically contains details such as the
user interaction timestamp or startup notification information.
platformData
must be non-Nothing
and must have the type
G_VARIANT_TYPE_VARDICT
. If it is floating, it will be consumed.
Since: 2.32