Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
A server which represents a sharing of a set of
DbusmenuMenuitems
across DBus to a Client
.
Synopsis
- newtype Server = Server (ManagedPtr Server)
- class (GObject o, IsDescendantOf Server o) => IsServer o
- toServer :: (MonadIO m, IsServer o) => o -> m Server
- noServer :: Maybe Server
- serverGetIconPaths :: (HasCallStack, MonadIO m, IsServer a) => a -> m [Text]
- serverGetStatus :: (HasCallStack, MonadIO m, IsServer a) => a -> m Status
- serverGetTextDirection :: (HasCallStack, MonadIO m, IsServer a) => a -> m TextDirection
- serverNew :: (HasCallStack, MonadIO m) => Text -> m Server
- serverSetIconPaths :: (HasCallStack, MonadIO m, IsServer a) => a -> [Text] -> m ()
- serverSetRoot :: (HasCallStack, MonadIO m, IsServer a, IsMenuitem b) => a -> b -> m ()
- serverSetStatus :: (HasCallStack, MonadIO m, IsServer a) => a -> Status -> m ()
- serverSetTextDirection :: (HasCallStack, MonadIO m, IsServer a) => a -> TextDirection -> m ()
- constructServerDbusObject :: IsServer o => Text -> IO (GValueConstruct o)
- getServerDbusObject :: (MonadIO m, IsServer o) => o -> m (Maybe Text)
- clearServerRootNode :: (MonadIO m, IsServer o) => o -> m ()
- constructServerRootNode :: (IsServer o, IsMenuitem a) => a -> IO (GValueConstruct o)
- getServerRootNode :: (MonadIO m, IsServer o) => o -> m (Maybe Menuitem)
- setServerRootNode :: (MonadIO m, IsServer o, IsMenuitem a) => o -> a -> m ()
- getServerVersion :: (MonadIO m, IsServer o) => o -> m Word32
- type C_ServerItemActivationRequestedCallback = Ptr () -> Int32 -> Word32 -> Ptr () -> IO ()
- type ServerItemActivationRequestedCallback = Int32 -> Word32 -> IO ()
- afterServerItemActivationRequested :: (IsServer a, MonadIO m) => a -> ServerItemActivationRequestedCallback -> m SignalHandlerId
- genClosure_ServerItemActivationRequested :: MonadIO m => ServerItemActivationRequestedCallback -> m (GClosure C_ServerItemActivationRequestedCallback)
- mk_ServerItemActivationRequestedCallback :: C_ServerItemActivationRequestedCallback -> IO (FunPtr C_ServerItemActivationRequestedCallback)
- noServerItemActivationRequestedCallback :: Maybe ServerItemActivationRequestedCallback
- onServerItemActivationRequested :: (IsServer a, MonadIO m) => a -> ServerItemActivationRequestedCallback -> m SignalHandlerId
- wrap_ServerItemActivationRequestedCallback :: ServerItemActivationRequestedCallback -> C_ServerItemActivationRequestedCallback
- type C_ServerItemPropertyUpdatedCallback = Ptr () -> Int32 -> CString -> Ptr GVariant -> Ptr () -> IO ()
- type ServerItemPropertyUpdatedCallback = Int32 -> Text -> GVariant -> IO ()
- afterServerItemPropertyUpdated :: (IsServer a, MonadIO m) => a -> ServerItemPropertyUpdatedCallback -> m SignalHandlerId
- genClosure_ServerItemPropertyUpdated :: MonadIO m => ServerItemPropertyUpdatedCallback -> m (GClosure C_ServerItemPropertyUpdatedCallback)
- mk_ServerItemPropertyUpdatedCallback :: C_ServerItemPropertyUpdatedCallback -> IO (FunPtr C_ServerItemPropertyUpdatedCallback)
- noServerItemPropertyUpdatedCallback :: Maybe ServerItemPropertyUpdatedCallback
- onServerItemPropertyUpdated :: (IsServer a, MonadIO m) => a -> ServerItemPropertyUpdatedCallback -> m SignalHandlerId
- wrap_ServerItemPropertyUpdatedCallback :: ServerItemPropertyUpdatedCallback -> C_ServerItemPropertyUpdatedCallback
- type C_ServerItemUpdatedCallback = Ptr () -> Int32 -> Ptr () -> IO ()
- type ServerItemUpdatedCallback = Int32 -> IO ()
- afterServerItemUpdated :: (IsServer a, MonadIO m) => a -> ServerItemUpdatedCallback -> m SignalHandlerId
- genClosure_ServerItemUpdated :: MonadIO m => ServerItemUpdatedCallback -> m (GClosure C_ServerItemUpdatedCallback)
- mk_ServerItemUpdatedCallback :: C_ServerItemUpdatedCallback -> IO (FunPtr C_ServerItemUpdatedCallback)
- noServerItemUpdatedCallback :: Maybe ServerItemUpdatedCallback
- onServerItemUpdated :: (IsServer a, MonadIO m) => a -> ServerItemUpdatedCallback -> m SignalHandlerId
- wrap_ServerItemUpdatedCallback :: ServerItemUpdatedCallback -> C_ServerItemUpdatedCallback
- type C_ServerLayoutUpdatedCallback = Ptr () -> Word32 -> Int32 -> Ptr () -> IO ()
- type ServerLayoutUpdatedCallback = Word32 -> Int32 -> IO ()
- afterServerLayoutUpdated :: (IsServer a, MonadIO m) => a -> ServerLayoutUpdatedCallback -> m SignalHandlerId
- genClosure_ServerLayoutUpdated :: MonadIO m => ServerLayoutUpdatedCallback -> m (GClosure C_ServerLayoutUpdatedCallback)
- mk_ServerLayoutUpdatedCallback :: C_ServerLayoutUpdatedCallback -> IO (FunPtr C_ServerLayoutUpdatedCallback)
- noServerLayoutUpdatedCallback :: Maybe ServerLayoutUpdatedCallback
- onServerLayoutUpdated :: (IsServer a, MonadIO m) => a -> ServerLayoutUpdatedCallback -> m SignalHandlerId
- wrap_ServerLayoutUpdatedCallback :: ServerLayoutUpdatedCallback -> C_ServerLayoutUpdatedCallback
Exported types
Memory-managed wrapper type.
Instances
Eq Server Source # | |
GObject Server Source # | |
Defined in GI.Dbusmenu.Objects.Server gobjectType :: IO GType # | |
IsGValue Server Source # | Convert |
HasParentTypes Server Source # | |
Defined in GI.Dbusmenu.Objects.Server | |
type ParentTypes Server Source # | |
Defined in GI.Dbusmenu.Objects.Server |
class (GObject o, IsDescendantOf Server o) => IsServer o Source #
Instances
(GObject o, IsDescendantOf Server o) => IsServer o Source # | |
Defined in GI.Dbusmenu.Objects.Server |
Methods
Overloaded methods
getIconPaths
:: (HasCallStack, MonadIO m, IsServer a) | |
=> a |
|
-> m [Text] | Returns: A NULL-terminated list of icon paths with memory managed by the server. Duplicate if you want to keep them. |
Gets the stored and exported icon paths from the server.
getStatus
:: (HasCallStack, MonadIO m, IsServer a) | |
=> a |
|
-> m Status |
Gets the current statust hat the server is sending out over DBus.
Return value: The current status the server is sending
getTextDirection
serverGetTextDirection Source #
:: (HasCallStack, MonadIO m, IsServer a) | |
=> a |
|
-> m TextDirection |
Returns the value of the text direction that is being exported over DBus for this server. It should relate to the direction of the labels and other text fields that are being exported by this server.
Return value: Text direction exported for this server.
new
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Server |
setIconPaths
:: (HasCallStack, MonadIO m, IsServer a) | |
=> a |
|
-> [Text] | |
-> m () |
Sets the icon paths for the server. This will replace previously set icon theme paths.
setRoot
:: (HasCallStack, MonadIO m, IsServer a, IsMenuitem b) | |
=> a |
|
-> b |
|
-> m () |
setStatus
:: (HasCallStack, MonadIO m, IsServer a) | |
=> a |
|
-> Status |
|
-> m () |
Changes the status of the server.
setTextDirection
serverSetTextDirection Source #
:: (HasCallStack, MonadIO m, IsServer a) | |
=> a |
|
-> TextDirection |
|
-> m () |
Sets the text direction that should be exported over DBus for
this server. If the value is set to DBUSMENU_TEXT_DIRECTION_NONE
the default detection will be used for setting the value and
exported over DBus.
Properties
dbusObject
No description available in the introspection data.
constructServerDbusObject :: IsServer o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “dbus-object
” property. This is rarely needed directly, but it is used by new
.
getServerDbusObject :: (MonadIO m, IsServer o) => o -> m (Maybe Text) Source #
Get the value of the “dbus-object
” property.
When overloading is enabled, this is equivalent to
get
server #dbusObject
rootNode
No description available in the introspection data.
clearServerRootNode :: (MonadIO m, IsServer o) => o -> m () Source #
Set the value of the “root-node
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#rootNode
constructServerRootNode :: (IsServer o, IsMenuitem a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “root-node
” property. This is rarely needed directly, but it is used by new
.
getServerRootNode :: (MonadIO m, IsServer o) => o -> m (Maybe Menuitem) Source #
Get the value of the “root-node
” property.
When overloading is enabled, this is equivalent to
get
server #rootNode
setServerRootNode :: (MonadIO m, IsServer o, IsMenuitem a) => o -> a -> m () Source #
Set the value of the “root-node
” property.
When overloading is enabled, this is equivalent to
set
server [ #rootNode:=
value ]
version
No description available in the introspection data.
getServerVersion :: (MonadIO m, IsServer o) => o -> m Word32 Source #
Get the value of the “version
” property.
When overloading is enabled, this is equivalent to
get
server #version
Signals
itemActivationRequested
type C_ServerItemActivationRequestedCallback = Ptr () -> Int32 -> Word32 -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ServerItemActivationRequestedCallback Source #
= Int32 |
|
-> Word32 |
|
-> IO () |
This is signaled when a menuitem under this server sends its activate signal.
afterServerItemActivationRequested :: (IsServer a, MonadIO m) => a -> ServerItemActivationRequestedCallback -> m SignalHandlerId Source #
Connect a signal handler for the itemActivationRequested signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
server #itemActivationRequested callback
genClosure_ServerItemActivationRequested :: MonadIO m => ServerItemActivationRequestedCallback -> m (GClosure C_ServerItemActivationRequestedCallback) Source #
Wrap the callback into a GClosure
.
mk_ServerItemActivationRequestedCallback :: C_ServerItemActivationRequestedCallback -> IO (FunPtr C_ServerItemActivationRequestedCallback) Source #
Generate a function pointer callable from C code, from a C_ServerItemActivationRequestedCallback
.
noServerItemActivationRequestedCallback :: Maybe ServerItemActivationRequestedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ServerItemActivationRequestedCallback
onServerItemActivationRequested :: (IsServer a, MonadIO m) => a -> ServerItemActivationRequestedCallback -> m SignalHandlerId Source #
Connect a signal handler for the itemActivationRequested signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
server #itemActivationRequested callback
wrap_ServerItemActivationRequestedCallback :: ServerItemActivationRequestedCallback -> C_ServerItemActivationRequestedCallback Source #
itemPropertyUpdated
type C_ServerItemPropertyUpdatedCallback = Ptr () -> Int32 -> CString -> Ptr GVariant -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ServerItemPropertyUpdatedCallback = Int32 -> Text -> GVariant -> IO () Source #
No description available in the introspection data.
afterServerItemPropertyUpdated :: (IsServer a, MonadIO m) => a -> ServerItemPropertyUpdatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the itemPropertyUpdated signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
server #itemPropertyUpdated callback
genClosure_ServerItemPropertyUpdated :: MonadIO m => ServerItemPropertyUpdatedCallback -> m (GClosure C_ServerItemPropertyUpdatedCallback) Source #
Wrap the callback into a GClosure
.
mk_ServerItemPropertyUpdatedCallback :: C_ServerItemPropertyUpdatedCallback -> IO (FunPtr C_ServerItemPropertyUpdatedCallback) Source #
Generate a function pointer callable from C code, from a C_ServerItemPropertyUpdatedCallback
.
noServerItemPropertyUpdatedCallback :: Maybe ServerItemPropertyUpdatedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ServerItemPropertyUpdatedCallback
onServerItemPropertyUpdated :: (IsServer a, MonadIO m) => a -> ServerItemPropertyUpdatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the itemPropertyUpdated signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
server #itemPropertyUpdated callback
wrap_ServerItemPropertyUpdatedCallback :: ServerItemPropertyUpdatedCallback -> C_ServerItemPropertyUpdatedCallback Source #
itemUpdated
type C_ServerItemUpdatedCallback = Ptr () -> Int32 -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ServerItemUpdatedCallback = Int32 -> IO () Source #
No description available in the introspection data.
afterServerItemUpdated :: (IsServer a, MonadIO m) => a -> ServerItemUpdatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the itemUpdated signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
server #itemUpdated callback
genClosure_ServerItemUpdated :: MonadIO m => ServerItemUpdatedCallback -> m (GClosure C_ServerItemUpdatedCallback) Source #
Wrap the callback into a GClosure
.
mk_ServerItemUpdatedCallback :: C_ServerItemUpdatedCallback -> IO (FunPtr C_ServerItemUpdatedCallback) Source #
Generate a function pointer callable from C code, from a C_ServerItemUpdatedCallback
.
noServerItemUpdatedCallback :: Maybe ServerItemUpdatedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ServerItemUpdatedCallback
onServerItemUpdated :: (IsServer a, MonadIO m) => a -> ServerItemUpdatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the itemUpdated signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
server #itemUpdated callback
wrap_ServerItemUpdatedCallback :: ServerItemUpdatedCallback -> C_ServerItemUpdatedCallback Source #
Wrap a ServerItemUpdatedCallback
into a C_ServerItemUpdatedCallback
.
layoutUpdated
type C_ServerLayoutUpdatedCallback = Ptr () -> Word32 -> Int32 -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ServerLayoutUpdatedCallback Source #
= Word32 |
|
-> Int32 |
|
-> IO () |
This signal is emitted any time the layout of the menuitems under this server is changed.
afterServerLayoutUpdated :: (IsServer a, MonadIO m) => a -> ServerLayoutUpdatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the layoutUpdated signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
server #layoutUpdated callback
genClosure_ServerLayoutUpdated :: MonadIO m => ServerLayoutUpdatedCallback -> m (GClosure C_ServerLayoutUpdatedCallback) Source #
Wrap the callback into a GClosure
.
mk_ServerLayoutUpdatedCallback :: C_ServerLayoutUpdatedCallback -> IO (FunPtr C_ServerLayoutUpdatedCallback) Source #
Generate a function pointer callable from C code, from a C_ServerLayoutUpdatedCallback
.
noServerLayoutUpdatedCallback :: Maybe ServerLayoutUpdatedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ServerLayoutUpdatedCallback
onServerLayoutUpdated :: (IsServer a, MonadIO m) => a -> ServerLayoutUpdatedCallback -> m SignalHandlerId Source #
Connect a signal handler for the layoutUpdated signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
server #layoutUpdated callback