gi-webkit2-4.0.22: WebKit2 bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.WebKit2.Objects.Notification

Contents

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Notification Source #

Memory-managed wrapper type.

Instances
GObject Notification Source # 
Instance details

Defined in GI.WebKit2.Objects.Notification

Methods

gobjectType :: IO GType #

HasParentTypes Notification Source # 
Instance details

Defined in GI.WebKit2.Objects.Notification

type ParentTypes Notification Source # 
Instance details

Defined in GI.WebKit2.Objects.Notification

type ParentTypes Notification = Object ': ([] :: [Type])

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

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

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

Cast to Notification, for types for which this is known to be safe. For general casts, use castTo.

Methods

clicked

notificationClicked Source #

Arguments

:: (HasCallStack, MonadIO m, IsNotification a) 
=> a

notification: a Notification

-> m () 

Tells WebKit the notification has been clicked. This will emit the Notification::clicked signal.

Since: 2.12

close

notificationClose Source #

Arguments

:: (HasCallStack, MonadIO m, IsNotification a) 
=> a

notification: a Notification

-> m () 

Closes the notification.

Since: 2.8

getBody

notificationGetBody Source #

Arguments

:: (HasCallStack, MonadIO m, IsNotification a) 
=> a

notification: a Notification

-> m Text

Returns: the body for the notification

Obtains the body for the notification.

Since: 2.8

getId

notificationGetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsNotification a) 
=> a

notification: a Notification

-> m Word64

Returns: the unique id for the notification

Obtains the unique id for the notification.

Since: 2.8

getTag

notificationGetTag Source #

Arguments

:: (HasCallStack, MonadIO m, IsNotification a) 
=> a

notification: a Notification

-> m (Maybe Text)

Returns: the tag for the notification

Obtains the tag identifier for the notification.

Since: 2.16

getTitle

notificationGetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsNotification a) 
=> a

notification: a Notification

-> m Text

Returns: the title for the notification

Obtains the title for the notification.

Since: 2.8

Properties

body

The body for the notification.

Since: 2.8

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

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

get notification #body

id

The unique id for the notification.

Since: 2.8

getNotificationId :: (MonadIO m, IsNotification o) => o -> m Word64 Source #

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

get notification #id

tag

The tag identifier for the notification.

Since: 2.16

getNotificationTag :: (MonadIO m, IsNotification o) => o -> m (Maybe Text) Source #

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

get notification #tag

title

The title for the notification.

Since: 2.8

getNotificationTitle :: (MonadIO m, IsNotification o) => o -> m Text Source #

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

get notification #title

Signals

clicked

type C_NotificationClickedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type NotificationClickedCallback = IO () Source #

Emitted when a notification has been clicked. See notificationClicked.

Since: 2.12

afterNotificationClicked :: (IsNotification a, MonadIO m) => a -> NotificationClickedCallback -> m SignalHandlerId Source #

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

after notification #clicked callback

onNotificationClicked :: (IsNotification a, MonadIO m) => a -> NotificationClickedCallback -> m SignalHandlerId Source #

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

on notification #clicked callback

closed

type C_NotificationClosedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type NotificationClosedCallback = IO () Source #

Emitted when a notification has been withdrawn.

The default handler will close the notification using libnotify, if built with support for it.

Since: 2.8

afterNotificationClosed :: (IsNotification a, MonadIO m) => a -> NotificationClosedCallback -> m SignalHandlerId Source #

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

onNotificationClosed :: (IsNotification a, MonadIO m) => a -> NotificationClosedCallback -> m SignalHandlerId Source #

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