GI.Notify.Objects.Notification

A passive pop-up notification.

Exported types

newtype Notification

Memory-managed wrapper type.

Constructors

Notification (ManagedPtr Notification)

Instances

Eq Notification

Defined in GI.Notify.Objects.Notification

Methods

(==) :: Notification -> Notification -> Bool

(/=) :: Notification -> Notification -> Bool

GObject Notification

Defined in GI.Notify.Objects.Notification

ManagedPtrNewtype Notification

Defined in GI.Notify.Objects.Notification

Methods

toManagedPtr :: Notification -> ManagedPtr Notification

TypedObject Notification

Defined in GI.Notify.Objects.Notification

Methods

glibType :: IO GType

HasParentTypes Notification

Defined in GI.Notify.Objects.Notification

IsGValue (Maybe Notification)

Convert Notification to and from GValue. See toGValue and fromGValue.

Defined in GI.Notify.Objects.Notification

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Notification -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Notification)

type ParentTypes Notification

Defined in GI.Notify.Objects.Notification

type ParentTypes Notification = '[Object]

class (GObject o, IsDescendantOf Notification o) => IsNotification o

Type class for types which can be safely cast to Notification, for instance with toNotification.

Instances

(GObject o, IsDescendantOf Notification o) => IsNotification o

Defined in GI.Notify.Objects.Notification

toNotification :: (MonadIO m, IsNotification o) => o -> m Notification

Cast to Notification, 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

addAction, bindProperty, bindPropertyFull, clearActions, clearHints, close, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, show, stealData, stealQdata, thawNotify, unref, update, watchClosure.

Getters

getActivationToken, getClosedReason, getData, getProperty, getQdata.

Setters

setAppName, setCategory, setData, setDataFull, setHint, setHintByte, setHintByteArray, setHintDouble, setHintInt32, setHintString, setHintUint32, setIconFromPixbuf, setImageFromPixbuf, setProperty, setTimeout, setUrgency.

addAction

notificationAddAction

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

action: The action ID.

-> Text

label: The human-readable action label.

-> ActionCallback

callback: The action's callback function.

-> m ()

Adds an action to a notification. When the action is invoked, the specified callback function will be called, along with the value passed to userData.

clearActions

notificationClearActions

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> m ()

Clears all actions from the notification.

clearHints

notificationClearHints

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> m ()

Clears all hints from the notification.

close

notificationClose

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> m ()

(Can throw GError)

Synchronously tells the notification server to hide the notification on the screen.

getActivationToken

notificationGetActivationToken

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> m Text

Returns: The current activation token, or Nothing if none

If an an action is currently being activated, return the activation token. This function is intended to be used in a ActionCallback to get the activation token for the activated action, if the notification daemon supports it.

Since: 0.7.10

getClosedReason

notificationGetClosedReason

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> m Int32

Returns: An integer representing the closed reason code (Since 0.8.0 it's also a ClosedReason).

Returns the closed reason code for the notification. This is valid only after the "closed" signal is emitted.

Since version 0.8.0 the returned value is of type ClosedReason.

new

notificationNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

summary: The required summary text.

-> Maybe Text

body: The optional body text.

-> Maybe Text

icon: The optional icon theme icon name or filename.

-> m Notification

Returns: The new Notification.

Creates a new Notification. The summary text is required, but all other parameters are optional.

setAppName

notificationSetAppName

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Text

appName: the localised application name

-> m ()

Sets the application name for the notification. If this function is not called or if appName is Nothing, the application name will be set from the value used in init or overridden with setAppName.

Since: 0.7.3

setCategory

notificationSetCategory

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

category: The category.

-> m ()

Sets the category of this notification. This can be used by the notification server to filter or display the data in a certain way.

setHint

notificationSetHint

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Text

key: the hint key

-> Maybe GVariant

value: the hint value, or Nothing to unset the hint

-> m ()

Sets a hint for key with value value. If value is Nothing, a previously set hint for key is unset.

If value is floating, it is consumed.

Since: 0.6

setHintByte

notificationSetHintByte

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

key: The hint.

-> Word8

value: The hint's value.

-> m ()

Deprecated: (Since version 0.6.)Use notificationSetHint instead

Sets a hint with a byte value.

setHintByteArray

notificationSetHintByteArray

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

key: The hint.

-> ByteString

value: The hint's value.

-> m ()

Deprecated: (Since version 0.6.)Use notificationSetHint instead

Sets a hint with a byte array value. The length of value must be passed as len.

setHintDouble

notificationSetHintDouble

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

key: The hint.

-> Double

value: The hint's value.

-> m ()

Deprecated: (Since version 0.6.)Use notificationSetHint instead

Sets a hint with a double value.

setHintInt32

notificationSetHintInt32

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

key: The hint.

-> Int32

value: The hint's value.

-> m ()

Deprecated: (Since version 0.6.)Use notificationSetHint instead

Sets a hint with a 32-bit integer value.

setHintString

notificationSetHintString

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

key: The hint.

-> Text

value: The hint's value.

-> m ()

Deprecated: (Since version 0.6.)Use notificationSetHint instead

Sets a hint with a string value.

setHintUint32

notificationSetHintUint32

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Text

key: The hint.

-> Word32

value: The hint's value.

-> m ()

Deprecated: (Since version 0.6.)Use notificationSetHint instead

Sets a hint with an unsigned 32-bit integer value.

setIconFromPixbuf

notificationSetIconFromPixbuf

Arguments

:: (HasCallStack, MonadIO m, IsNotification a, IsPixbuf b)

=> a

notification: The notification.

-> b

icon: The icon.

-> m ()

Deprecated: use notificationSetImageFromPixbuf instead.

Sets the icon in the notification from a Pixbuf.

setImageFromPixbuf

notificationSetImageFromPixbuf

Arguments

:: (HasCallStack, MonadIO m, IsNotification a, IsPixbuf b)

=> a

notification: The notification.

-> b

pixbuf: The image.

-> m ()

Sets the image in the notification from a Pixbuf.

setTimeout

notificationSetTimeout

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Int32

timeout: The timeout in milliseconds.

-> m ()

Sets the timeout of the notification. To set the default time, pass EXPIRES_DEFAULT as timeout. To set the notification to never expire, pass EXPIRES_NEVER.

Note that the timeout may be ignored by the server.

setUrgency

notificationSetUrgency

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> Urgency

urgency: The urgency level.

-> m ()

Sets the urgency level of this notification.

See: Urgency

show

notificationShow

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification.

-> m ()

(Can throw GError)

Tells the notification server to display the notification on the screen.

update

notificationUpdate

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: The notification to update.

-> Text

summary: The new required summary text.

-> Maybe Text

body: The optional body text.

-> Maybe Text

icon: The optional icon theme icon name or filename.

-> m Bool

Returns: True, unless an invalid parameter was passed.

Updates the notification text and icon. This won't send the update out and display it on the screen. For that, you will need to call notificationShow.

Properties

appName

No description available in the introspection data.

constructNotificationAppName :: (IsNotification o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-name” property. This is rarely needed directly, but it is used by new.

getNotificationAppName :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

Get the value of the “app-name” property. When overloading is enabled, this is equivalent to

get notification #appName

setNotificationAppName :: (MonadIO m, IsNotification o) => o -> Text -> m ()

Set the value of the “app-name” property. When overloading is enabled, this is equivalent to

set notification [ #appName := value ]

body

No description available in the introspection data.

clearNotificationBody :: (MonadIO m, IsNotification o) => o -> m ()

Set the value of the “body” property to Nothing. When overloading is enabled, this is equivalent to

clear #body

constructNotificationBody :: (IsNotification o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “body” property. This is rarely needed directly, but it is used by new.

getNotificationBody :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

Get the value of the “body” property. When overloading is enabled, this is equivalent to

get notification #body

setNotificationBody :: (MonadIO m, IsNotification o) => o -> Text -> m ()

Set the value of the “body” property. When overloading is enabled, this is equivalent to

set notification [ #body := value ]

closedReason

No description available in the introspection data.

getNotificationClosedReason :: (MonadIO m, IsNotification o) => o -> m Int32

Get the value of the “closed-reason” property. When overloading is enabled, this is equivalent to

get notification #closedReason

iconName

No description available in the introspection data.

clearNotificationIconName :: (MonadIO m, IsNotification o) => o -> m ()

Set the value of the “icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #iconName

constructNotificationIconName :: (IsNotification o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “icon-name” property. This is rarely needed directly, but it is used by new.

getNotificationIconName :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

Get the value of the “icon-name” property. When overloading is enabled, this is equivalent to

get notification #iconName

setNotificationIconName :: (MonadIO m, IsNotification o) => o -> Text -> m ()

Set the value of the “icon-name” property. When overloading is enabled, this is equivalent to

set notification [ #iconName := value ]

id

No description available in the introspection data.

constructNotificationId :: (IsNotification o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “id” property. This is rarely needed directly, but it is used by new.

getNotificationId :: (MonadIO m, IsNotification o) => o -> m Int32

Get the value of the “id” property. When overloading is enabled, this is equivalent to

get notification #id

setNotificationId :: (MonadIO m, IsNotification o) => o -> Int32 -> m ()

Set the value of the “id” property. When overloading is enabled, this is equivalent to

set notification [ #id := value ]

summary

No description available in the introspection data.

clearNotificationSummary :: (MonadIO m, IsNotification o) => o -> m ()

Set the value of the “summary” property to Nothing. When overloading is enabled, this is equivalent to

clear #summary

constructNotificationSummary :: (IsNotification o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “summary” property. This is rarely needed directly, but it is used by new.

getNotificationSummary :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

Get the value of the “summary” property. When overloading is enabled, this is equivalent to

get notification #summary

setNotificationSummary :: (MonadIO m, IsNotification o) => o -> Text -> m ()

Set the value of the “summary” property. When overloading is enabled, this is equivalent to

set notification [ #summary := value ]

Signals

closed

type NotificationClosedCallback = IO ()

Emitted when the notification is closed.

afterNotificationClosed :: (IsNotification a, MonadIO m) => a -> ((?self :: a) => NotificationClosedCallback) -> m SignalHandlerId

Connect a signal handler for the closed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after notification #closed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onNotificationClosed :: (IsNotification a, MonadIO m) => a -> ((?self :: a) => NotificationClosedCallback) -> m SignalHandlerId

Connect a signal handler for the closed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on notification #closed callback