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 |
No description available in the introspection data.
Synopsis
- newtype UserMessage = UserMessage (ManagedPtr UserMessage)
- class (GObject o, IsDescendantOf UserMessage o) => IsUserMessage o
- toUserMessage :: (MonadIO m, IsUserMessage o) => o -> m UserMessage
- userMessageGetFdList :: (HasCallStack, MonadIO m, IsUserMessage a) => a -> m UnixFDList
- userMessageGetName :: (HasCallStack, MonadIO m, IsUserMessage a) => a -> m Text
- userMessageGetParameters :: (HasCallStack, MonadIO m, IsUserMessage a) => a -> m GVariant
- userMessageNew :: (HasCallStack, MonadIO m) => Text -> Maybe GVariant -> m UserMessage
- userMessageNewWithFdList :: (HasCallStack, MonadIO m, IsUnixFDList a) => Text -> Maybe GVariant -> Maybe a -> m UserMessage
- userMessageSendReply :: (HasCallStack, MonadIO m, IsUserMessage a, IsUserMessage b) => a -> b -> m ()
- constructUserMessageFdList :: (IsUserMessage o, MonadIO m, IsUnixFDList a) => a -> m (GValueConstruct o)
- getUserMessageFdList :: (MonadIO m, IsUserMessage o) => o -> m UnixFDList
- constructUserMessageName :: (IsUserMessage o, MonadIO m) => Text -> m (GValueConstruct o)
- getUserMessageName :: (MonadIO m, IsUserMessage o) => o -> m Text
- constructUserMessageParameters :: (IsUserMessage o, MonadIO m) => GVariant -> m (GValueConstruct o)
- getUserMessageParameters :: (MonadIO m, IsUserMessage o) => o -> m GVariant
Exported types
newtype UserMessage Source #
Memory-managed wrapper type.
UserMessage (ManagedPtr UserMessage) |
Instances
Eq UserMessage Source # | |
Defined in GI.WebKit2.Objects.UserMessage (==) :: UserMessage -> UserMessage -> Bool (/=) :: UserMessage -> UserMessage -> Bool | |
GObject UserMessage Source # | |
Defined in GI.WebKit2.Objects.UserMessage | |
ManagedPtrNewtype UserMessage Source # | |
Defined in GI.WebKit2.Objects.UserMessage toManagedPtr :: UserMessage -> ManagedPtr UserMessage | |
TypedObject UserMessage Source # | |
Defined in GI.WebKit2.Objects.UserMessage glibType :: IO GType | |
IsGValue UserMessage Source # | Convert |
Defined in GI.WebKit2.Objects.UserMessage toGValue :: UserMessage -> IO GValue fromGValue :: GValue -> IO UserMessage | |
HasParentTypes UserMessage Source # | |
Defined in GI.WebKit2.Objects.UserMessage | |
type ParentTypes UserMessage Source # | |
Defined in GI.WebKit2.Objects.UserMessage type ParentTypes UserMessage = '[Object] |
class (GObject o, IsDescendantOf UserMessage o) => IsUserMessage o Source #
Type class for types which can be safely cast to UserMessage
, for instance with toUserMessage
.
Instances
(GObject o, IsDescendantOf UserMessage o) => IsUserMessage o Source # | |
Defined in GI.WebKit2.Objects.UserMessage |
toUserMessage :: (MonadIO m, IsUserMessage o) => o -> m UserMessage Source #
Cast to UserMessage
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
getFdList
:: (HasCallStack, MonadIO m, IsUserMessage a) | |
=> a |
|
-> m UnixFDList | Returns: the message list of file descriptors |
Get the message
list of file descritpor
Since: 2.28
getName
:: (HasCallStack, MonadIO m, IsUserMessage a) | |
=> a |
|
-> m Text | Returns: the message name |
Get the message
name
Since: 2.28
getParameters
userMessageGetParameters Source #
:: (HasCallStack, MonadIO m, IsUserMessage a) | |
=> a |
|
-> m GVariant | Returns: the message parameters |
Get the message
parameters
Since: 2.28
new
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Maybe GVariant |
|
-> m UserMessage | Returns: the newly created |
Create a new UserMessage
with name
.
Since: 2.28
newWithFdList
userMessageNewWithFdList Source #
:: (HasCallStack, MonadIO m, IsUnixFDList a) | |
=> Text |
|
-> Maybe GVariant |
|
-> Maybe a |
|
-> m UserMessage | Returns: the newly created |
Create a new UserMessage
including also a list of UNIX file descriptors to be sent.
Since: 2.28
sendReply
:: (HasCallStack, MonadIO m, IsUserMessage a, IsUserMessage b) | |
=> a |
|
-> b |
|
-> m () |
Send a reply to message
. If reply
is floating, it's consumed.
You can only send a reply to a UserMessage
that has been
received.
Since: 2.28
Properties
fdList
The UNIX file descriptors of the user message.
Since: 2.28
constructUserMessageFdList :: (IsUserMessage o, MonadIO m, IsUnixFDList a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “fd-list
” property. This is rarely needed directly, but it is used by new
.
getUserMessageFdList :: (MonadIO m, IsUserMessage o) => o -> m UnixFDList Source #
Get the value of the “fd-list
” property.
When overloading is enabled, this is equivalent to
get
userMessage #fdList
name
The name of the user message.
Since: 2.28
constructUserMessageName :: (IsUserMessage o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “name
” property. This is rarely needed directly, but it is used by new
.
getUserMessageName :: (MonadIO m, IsUserMessage o) => o -> m Text Source #
Get the value of the “name
” property.
When overloading is enabled, this is equivalent to
get
userMessage #name
parameters
The parameters of the user message as a GVariant
, or Nothing
if the message doesn't include parameters. Note that only complete types are
allowed.
Since: 2.28
constructUserMessageParameters :: (IsUserMessage o, MonadIO m) => GVariant -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “parameters
” property. This is rarely needed directly, but it is used by new
.
getUserMessageParameters :: (MonadIO m, IsUserMessage o) => o -> m GVariant Source #
Get the value of the “parameters
” property.
When overloading is enabled, this is equivalent to
get
userMessage #parameters