Libnotify

High level interface to libnotify API

Notification API

data Notification

Notification object

Instances

Eq Notification

Defined in Libnotify

Methods

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

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

Show Notification

Defined in Libnotify

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

display :: Mod Notification -> IO Notification

Display notification

>>> token <- display (summary "Greeting" <> body "Hello world!" <> icon "face-smile-big")

You can reuse notification tokens:

>>> display_ (reuse token <> body "Hey!")

display_ :: Mod Notification -> IO ()

Display and discard notification token

>>> display_ (summary "Greeting" <> body "Hello world!" <> icon "face-smile-big")

close :: Notification -> IO ()

Close notification

Modifiers

data Mod a

A notification modifier

Instances

Semigroup (Mod a)

Defined in Libnotify

Methods

(<>) :: Mod a -> Mod a -> Mod a

sconcat :: NonEmpty (Mod a) -> Mod a

stimes :: Integral b => b -> Mod a -> Mod a

Monoid (Mod a)

Defined in Libnotify

Methods

mempty :: Mod a

mappend :: Mod a -> Mod a -> Mod a

mconcat :: [Mod a] -> Mod a

summary :: String -> Mod Notification

Set notification summary

>>> display_ (summary "Hello!")

body :: String -> Mod Notification

Set notification body

>>> display_ (body "Hello world!")

icon :: String -> Mod Notification

Set notification icon

>>> display_ (icon "face-smile")

The argument is either icon name or file name

timeout :: Timeout -> Mod Notification

Set notification timeout

data Timeout

Timeout after which notification is closed

Constructors

Default

Default server timeout

Custom Int

User defined timeout (in milliseconds)

Infinite

Notification will never expire

Instances

Eq Timeout

Defined in Libnotify.C.NotifyNotification

Methods

(==) :: Timeout -> Timeout -> Bool

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

Data Timeout

Defined in Libnotify.C.NotifyNotification

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Timeout -> c Timeout

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Timeout

toConstr :: Timeout -> Constr

dataTypeOf :: Timeout -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Timeout)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Timeout)

gmapT :: (forall b. Data b => b -> b) -> Timeout -> Timeout

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Timeout -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Timeout -> r

gmapQ :: (forall d. Data d => d -> u) -> Timeout -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Timeout -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Timeout -> m Timeout

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Timeout -> m Timeout

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Timeout -> m Timeout

Show Timeout

Defined in Libnotify.C.NotifyNotification

Methods

showsPrec :: Int -> Timeout -> ShowS

show :: Timeout -> String

showList :: [Timeout] -> ShowS

Generic Timeout

Defined in Libnotify.C.NotifyNotification

Associated Types

type Rep Timeout :: * -> *

Methods

from :: Timeout -> Rep Timeout x

to :: Rep Timeout x -> Timeout

type Rep Timeout

Defined in Libnotify.C.NotifyNotification

type Rep Timeout = D1 (MetaData "Timeout" "Libnotify.C.NotifyNotification" "libnotify-0.2.1-JWZmgYuBBe35aIczEgjA7J" False) (C1 (MetaCons "Default" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Custom" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :+: C1 (MetaCons "Infinite" PrefixI False) (U1 :: * -> *)))

category :: String -> Mod Notification

Set notification category

urgency :: Urgency -> Mod Notification

Set notification urgency

data Urgency

The urgency level of the notification

Constructors

Low

Low urgency. Used for unimportant notifications

Normal

Normal urgency. Used for most standard notifications

Critical

Critical urgency. Used for very important notifications

Instances

Eq Urgency

Defined in Libnotify.C.NotifyNotification

Methods

(==) :: Urgency -> Urgency -> Bool

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

Data Urgency

Defined in Libnotify.C.NotifyNotification

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Urgency -> c Urgency

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Urgency

toConstr :: Urgency -> Constr

dataTypeOf :: Urgency -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Urgency)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Urgency)

gmapT :: (forall b. Data b => b -> b) -> Urgency -> Urgency

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Urgency -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Urgency -> r

gmapQ :: (forall d. Data d => d -> u) -> Urgency -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Urgency -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Urgency -> m Urgency

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Urgency -> m Urgency

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Urgency -> m Urgency

Ord Urgency

Defined in Libnotify.C.NotifyNotification

Methods

compare :: Urgency -> Urgency -> Ordering

(<) :: Urgency -> Urgency -> Bool

(<=) :: Urgency -> Urgency -> Bool

(>) :: Urgency -> Urgency -> Bool

(>=) :: Urgency -> Urgency -> Bool

max :: Urgency -> Urgency -> Urgency

min :: Urgency -> Urgency -> Urgency

Show Urgency

Defined in Libnotify.C.NotifyNotification

Methods

showsPrec :: Int -> Urgency -> ShowS

show :: Urgency -> String

showList :: [Urgency] -> ShowS

Generic Urgency

Defined in Libnotify.C.NotifyNotification

Associated Types

type Rep Urgency :: * -> *

Methods

from :: Urgency -> Rep Urgency x

to :: Rep Urgency x -> Urgency

type Rep Urgency

Defined in Libnotify.C.NotifyNotification

type Rep Urgency = D1 (MetaData "Urgency" "Libnotify.C.NotifyNotification" "libnotify-0.2.1-JWZmgYuBBe35aIczEgjA7J" False) (C1 (MetaCons "Low" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Normal" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Critical" PrefixI False) (U1 :: * -> *)))

image :: Pixbuf -> Mod Notification

Set notification image

class Hint v where

Add a hint to notification

It's perfectly OK to add multiple hints to a single notification

Minimal complete definition

hint

Methods

hint :: String -> v -> Mod Notification

Instances

Hint Double

Defined in Libnotify

Methods

hint :: String -> Double -> Mod Notification

Hint Int32

Defined in Libnotify

Methods

hint :: String -> Int32 -> Mod Notification

Hint Word8

Defined in Libnotify

Methods

hint :: String -> Word8 -> Mod Notification

Hint String

Defined in Libnotify

Methods

hint :: String -> String -> Mod Notification

Hint ByteString

Defined in Libnotify

Methods

hint :: String -> ByteString -> Mod Notification

nohints :: Mod Notification

Remove all hints from the notification

action

Arguments

:: String

Name

-> String

Button label

-> (Notification -> String -> IO a)

Callback

-> Mod Notification

Add an action to notification

It's perfectly OK to add multiple actions to a single notification

>>> display_ (action "hello" "Hello world!" (\_ _ -> return ()))

noactions :: Mod Notification

Remove all actions from the notification

>>> let callback _ _ = return ()
>>> display_ (summary "No hello for you!" <> action "hello" "Hello world!" callback <> noactions)

appName :: String -> Mod Notification

Set the application name.

reuse :: Notification -> Mod Notification

Reuse existing notification token, instead of creating a new one

If you try to reuse multiple tokens, the last one wins, e.g.

>>> foo <- display (body "foo")
>>> bar <- display (body "bar")
>>> display_ (base foo <> base bar)

will show only "bar"