-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Libnotify bindings
--   
--   Bindings for Libnotify, autogenerated by haskell-gi.
@package gi-notify
@version 0.7.21


-- | Build time configuration used during code generation.
module GI.Notify.Config

-- | Overrides used when generating these bindings.
overrides :: Text


module GI.Notify.Constants

-- | <i>No description available in the introspection data.</i>
pattern VERSION_MINOR :: Int32

-- | <i>No description available in the introspection data.</i>
pattern VERSION_MICRO :: Int32

-- | <i>No description available in the introspection data.</i>
pattern VERSION_MAJOR :: Int32

-- | The notification never expires. It stays open until closed by the
--   calling API or the user.
pattern EXPIRES_NEVER :: Int32

-- | The default expiration time on a notification.
pattern EXPIRES_DEFAULT :: Int32


module GI.Notify.Enums

-- | The urgency level of the notification.
data Urgency

-- | Low urgency. Used for unimportant notifications.
UrgencyLow :: Urgency

-- | Normal urgency. Used for most standard notifications.
UrgencyNormal :: Urgency

-- | Critical urgency. Used for very important notifications.
UrgencyCritical :: Urgency

-- | Catch-all for unknown values
AnotherUrgency :: Int -> Urgency
instance GHC.Classes.Eq GI.Notify.Enums.Urgency
instance GHC.Show.Show GI.Notify.Enums.Urgency
instance GHC.Enum.Enum GI.Notify.Enums.Urgency
instance GHC.Classes.Ord GI.Notify.Enums.Urgency
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Notify.Enums.Urgency


module GI.Notify.Functions

-- | Gets the application name registered.
getAppName :: (HasCallStack, MonadIO m) => m Text

-- | Synchronously queries the server for its capabilities and returns them
--   in a <a>List</a>.
getServerCaps :: (HasCallStack, MonadIO m) => m [Text]

-- | Synchronously queries the server for its information, specifically,
--   the name, vendor, server version, and the version of the notifications
--   specification that it is compliant with.
getServerInfo :: (HasCallStack, MonadIO m) => m (Bool, Text, Text, Text, Text)

-- | Initialized libnotify. This must be called before any other functions.
init :: (HasCallStack, MonadIO m) => Text -> m Bool

-- | Gets whether or not libnotify is initialized.
isInitted :: (HasCallStack, MonadIO m) => m Bool

-- | Sets the application name.
setAppName :: (HasCallStack, MonadIO m) => Text -> m ()

-- | Uninitialized libnotify.
--   
--   This should be called when the program no longer needs libnotify for
--   the rest of its lifecycle, typically just before exitting.
uninit :: (HasCallStack, MonadIO m) => m ()


module GI.Notify.Callbacks

-- | An action callback function.
type ActionCallback = Notification -> Text -> IO ()

-- | An action callback function.
type ActionCallback_WithClosures = Notification -> Text -> Ptr () -> IO ()

-- | Type for the callback on the (unwrapped) C side.
type C_ActionCallback = Ptr Notification -> CString -> Ptr () -> IO ()

-- | A simple wrapper that ignores the closure arguments.
drop_closures_ActionCallback :: ActionCallback -> ActionCallback_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_ActionCallback :: (HasCallStack, MonadIO m, IsNotification a) => FunPtr C_ActionCallback -> a -> Text -> Ptr () -> m ()

-- | Wrap the callback into a <a>GClosure</a>.
genClosure_ActionCallback :: MonadIO m => ActionCallback -> m (GClosure C_ActionCallback)

-- | Generate a function pointer callable from C code, from a
--   <a>C_ActionCallback</a>.
mk_ActionCallback :: C_ActionCallback -> IO (FunPtr C_ActionCallback)

-- | A convenience synonym for <tt><a>Nothing</a> :: <a>Maybe</a>
--   <a>ActionCallback</a></tt>.
noActionCallback :: Maybe ActionCallback

-- | A convenience synonym for <tt><a>Nothing</a> :: <a>Maybe</a>
--   <a>ActionCallback_WithClosures</a></tt>.
noActionCallback_WithClosures :: Maybe ActionCallback_WithClosures

-- | Wrap a <a>ActionCallback</a> into a <a>C_ActionCallback</a>.
wrap_ActionCallback :: Maybe (Ptr (FunPtr C_ActionCallback)) -> ActionCallback_WithClosures -> C_ActionCallback


-- | <i>No description available in the introspection data.</i>
module GI.Notify.Objects.Notification

-- | Memory-managed wrapper type.
newtype Notification
Notification :: ManagedPtr Notification -> Notification

-- | Type class for types which can be safely cast to <a>Notification</a>,
--   for instance with <a>toNotification</a>.
class (GObject o, IsDescendantOf Notification o) => IsNotification o

-- | Cast to <a>Notification</a>, for types for which this is known to be
--   safe. For general casts, use <a>castTo</a>.
toNotification :: (MonadIO m, IsNotification o) => o -> m Notification

-- | A convenience alias for <a>Nothing</a> :: <a>Maybe</a>
--   <a>Notification</a>.
noNotification :: Maybe Notification

-- | Adds an action to a notification. When the action is invoked, the
--   specified callback function will be called, along with the value
--   passed to <i><tt>userData</tt></i>.
notificationAddAction :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Text -> ActionCallback -> m ()

-- | Clears all actions from the notification.
notificationClearActions :: (HasCallStack, MonadIO m, IsNotification a) => a -> m ()

-- | Clears all hints from the notification.
notificationClearHints :: (HasCallStack, MonadIO m, IsNotification a) => a -> m ()

-- | Synchronously tells the notification server to hide the notification
--   on the screen.
notificationClose :: (HasCallStack, MonadIO m, IsNotification a) => a -> m ()

-- | Returns the closed reason code for the notification. This is valid
--   only after the "closed" signal is emitted.
notificationGetClosedReason :: (HasCallStack, MonadIO m, IsNotification a) => a -> m Int32

-- | Creates a new <a>Notification</a>. The summary text is required, but
--   all other parameters are optional.
notificationNew :: (HasCallStack, MonadIO m) => Text -> Maybe Text -> Maybe Text -> m Notification

-- | Sets the application name for the notification. If this function is
--   not called or if <i><tt>appName</tt></i> is <a>Nothing</a>, the
--   application name will be set from the value used in <a>init</a> or
--   overridden with <a>setAppName</a>.
--   
--   <i>Since: 0.7.3</i>
notificationSetAppName :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> 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.
notificationSetCategory :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> m ()

-- | Sets a hint for <i><tt>key</tt></i> with value <i><tt>value</tt></i>.
--   If <i><tt>value</tt></i> is <a>Nothing</a>, a previously set hint for
--   <i><tt>key</tt></i> is unset.
--   
--   If <i><tt>value</tt></i> is floating, it is consumed.
--   
--   <i>Since: 0.6</i>
notificationSetHint :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Maybe GVariant -> m ()

-- | Sets a hint with a byte value.

-- | <i>Deprecated: (Since version 0.6.)Use <a>notificationSetHint</a>
--   instead</i>
notificationSetHintByte :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Word8 -> m ()

-- | Sets a hint with a byte array value. The length of
--   <i><tt>value</tt></i> must be passed as <i><tt>len</tt></i>.

-- | <i>Deprecated: (Since version 0.6.)Use <a>notificationSetHint</a>
--   instead</i>
notificationSetHintByteArray :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> ByteString -> m ()

-- | Sets a hint with a double value.

-- | <i>Deprecated: (Since version 0.6.)Use <a>notificationSetHint</a>
--   instead</i>
notificationSetHintDouble :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Double -> m ()

-- | Sets a hint with a 32-bit integer value.

-- | <i>Deprecated: (Since version 0.6.)Use <a>notificationSetHint</a>
--   instead</i>
notificationSetHintInt32 :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Int32 -> m ()

-- | Sets a hint with a string value.

-- | <i>Deprecated: (Since version 0.6.)Use <a>notificationSetHint</a>
--   instead</i>
notificationSetHintString :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Text -> m ()

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

-- | <i>Deprecated: (Since version 0.6.)Use <a>notificationSetHint</a>
--   instead</i>
notificationSetHintUint32 :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Word32 -> m ()

-- | Sets the icon in the notification from a <a>Pixbuf</a>.

-- | <i>Deprecated: use <a>notificationSetImageFromPixbuf</a> instead.</i>
notificationSetIconFromPixbuf :: (HasCallStack, MonadIO m, IsNotification a, IsPixbuf b) => a -> b -> m ()

-- | Sets the image in the notification from a <a>Pixbuf</a>.
notificationSetImageFromPixbuf :: (HasCallStack, MonadIO m, IsNotification a, IsPixbuf b) => a -> b -> m ()

-- | Sets the timeout of the notification. To set the default time, pass
--   <a>EXPIRES_DEFAULT</a> as <i><tt>timeout</tt></i>. To set the
--   notification to never expire, pass <a>EXPIRES_NEVER</a>.
--   
--   Note that the timeout may be ignored by the server.
notificationSetTimeout :: (HasCallStack, MonadIO m, IsNotification a) => a -> Int32 -> m ()

-- | Sets the urgency level of this notification.
--   
--   See: <a>Urgency</a>
notificationSetUrgency :: (HasCallStack, MonadIO m, IsNotification a) => a -> Urgency -> m ()

-- | Tells the notification server to display the notification on the
--   screen.
notificationShow :: (HasCallStack, MonadIO m, IsNotification a) => a -> m ()

-- | 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
--   <a>notificationShow</a>.
notificationUpdate :: (HasCallStack, MonadIO m, IsNotification a) => a -> Text -> Maybe Text -> Maybe Text -> m Bool

-- | Construct a <a>GValueConstruct</a> with valid value for the
--   “<tt>app-name</tt>” property. This is rarely needed directly, but it
--   is used by <a>new</a>.
constructNotificationAppName :: IsNotification o => Text -> IO (GValueConstruct o)

-- | Get the value of the “<tt>app-name</tt>” property. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>get</a> notification #appName
--   </pre>
getNotificationAppName :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

-- | Set the value of the “<tt>app-name</tt>” property. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>set</a> notification [ #appName <a>:=</a> value ]
--   </pre>
setNotificationAppName :: (MonadIO m, IsNotification o) => o -> Text -> m ()

-- | Set the value of the “<tt>body</tt>” property to <a>Nothing</a>. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>clear</a> #body
--   </pre>
clearNotificationBody :: (MonadIO m, IsNotification o) => o -> m ()

-- | Construct a <a>GValueConstruct</a> with valid value for the
--   “<tt>body</tt>” property. This is rarely needed directly, but it is
--   used by <a>new</a>.
constructNotificationBody :: IsNotification o => Text -> IO (GValueConstruct o)

-- | Get the value of the “<tt>body</tt>” property. When <a>overloading</a>
--   is enabled, this is equivalent to
--   
--   <pre>
--   <a>get</a> notification #body
--   </pre>
getNotificationBody :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

-- | Set the value of the “<tt>body</tt>” property. When <a>overloading</a>
--   is enabled, this is equivalent to
--   
--   <pre>
--   <a>set</a> notification [ #body <a>:=</a> value ]
--   </pre>
setNotificationBody :: (MonadIO m, IsNotification o) => o -> Text -> m ()

-- | Get the value of the “<tt>closed-reason</tt>” property. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>get</a> notification #closedReason
--   </pre>
getNotificationClosedReason :: (MonadIO m, IsNotification o) => o -> m Int32

-- | Set the value of the “<tt>icon-name</tt>” property to <a>Nothing</a>.
--   When <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>clear</a> #iconName
--   </pre>
clearNotificationIconName :: (MonadIO m, IsNotification o) => o -> m ()

-- | Construct a <a>GValueConstruct</a> with valid value for the
--   “<tt>icon-name</tt>” property. This is rarely needed directly, but it
--   is used by <a>new</a>.
constructNotificationIconName :: IsNotification o => Text -> IO (GValueConstruct o)

-- | Get the value of the “<tt>icon-name</tt>” property. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>get</a> notification #iconName
--   </pre>
getNotificationIconName :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

-- | Set the value of the “<tt>icon-name</tt>” property. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>set</a> notification [ #iconName <a>:=</a> value ]
--   </pre>
setNotificationIconName :: (MonadIO m, IsNotification o) => o -> Text -> m ()

-- | Construct a <a>GValueConstruct</a> with valid value for the
--   “<tt>id</tt>” property. This is rarely needed directly, but it is used
--   by <a>new</a>.
constructNotificationId :: IsNotification o => Int32 -> IO (GValueConstruct o)

-- | Get the value of the “<tt>id</tt>” property. When <a>overloading</a>
--   is enabled, this is equivalent to
--   
--   <pre>
--   <a>get</a> notification #id
--   </pre>
getNotificationId :: (MonadIO m, IsNotification o) => o -> m Int32

-- | Set the value of the “<tt>id</tt>” property. When <a>overloading</a>
--   is enabled, this is equivalent to
--   
--   <pre>
--   <a>set</a> notification [ #id <a>:=</a> value ]
--   </pre>
setNotificationId :: (MonadIO m, IsNotification o) => o -> Int32 -> m ()

-- | Set the value of the “<tt>summary</tt>” property to <a>Nothing</a>.
--   When <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>clear</a> #summary
--   </pre>
clearNotificationSummary :: (MonadIO m, IsNotification o) => o -> m ()

-- | Construct a <a>GValueConstruct</a> with valid value for the
--   “<tt>summary</tt>” property. This is rarely needed directly, but it is
--   used by <a>new</a>.
constructNotificationSummary :: IsNotification o => Text -> IO (GValueConstruct o)

-- | Get the value of the “<tt>summary</tt>” property. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>get</a> notification #summary
--   </pre>
getNotificationSummary :: (MonadIO m, IsNotification o) => o -> m (Maybe Text)

-- | Set the value of the “<tt>summary</tt>” property. When
--   <a>overloading</a> is enabled, this is equivalent to
--   
--   <pre>
--   <a>set</a> notification [ #summary <a>:=</a> value ]
--   </pre>
setNotificationSummary :: (MonadIO m, IsNotification o) => o -> Text -> m ()

-- | Type for the callback on the (unwrapped) C side.
type C_NotificationClosedCallback = Ptr () -> Ptr () -> IO ()

-- | Emitted when the notification is closed.
type NotificationClosedCallback = IO ()

-- | Connect a signal handler for the <a>closed</a> signal, to be run after
--   the default handler. When <a>overloading</a> is enabled, this is
--   equivalent to
--   
--   <pre>
--   <a>after</a> notification #closed callback
--   </pre>
afterNotificationClosed :: (IsNotification a, MonadIO m) => a -> NotificationClosedCallback -> m SignalHandlerId

-- | Wrap the callback into a <a>GClosure</a>.
genClosure_NotificationClosed :: MonadIO m => NotificationClosedCallback -> m (GClosure C_NotificationClosedCallback)

-- | Generate a function pointer callable from C code, from a
--   <a>C_NotificationClosedCallback</a>.
mk_NotificationClosedCallback :: C_NotificationClosedCallback -> IO (FunPtr C_NotificationClosedCallback)

-- | A convenience synonym for <tt><a>Nothing</a> :: <a>Maybe</a>
--   <a>NotificationClosedCallback</a></tt>.
noNotificationClosedCallback :: Maybe NotificationClosedCallback

-- | Connect a signal handler for the <a>closed</a> signal, to be run
--   before the default handler. When <a>overloading</a> is enabled, this
--   is equivalent to
--   
--   <pre>
--   <a>on</a> notification #closed callback
--   </pre>
onNotificationClosed :: (IsNotification a, MonadIO m) => a -> NotificationClosedCallback -> m SignalHandlerId

-- | Wrap a <a>NotificationClosedCallback</a> into a
--   <a>C_NotificationClosedCallback</a>.
wrap_NotificationClosedCallback :: NotificationClosedCallback -> C_NotificationClosedCallback
instance GHC.Classes.Eq GI.Notify.Objects.Notification.Notification
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Notify.Objects.Notification.Notification o) => GI.Notify.Objects.Notification.IsNotification o
instance Data.GI.Base.BasicTypes.GObject GI.Notify.Objects.Notification.Notification
instance Data.GI.Base.GValue.IsGValue GI.Notify.Objects.Notification.Notification
instance Data.GI.Base.Overloading.HasParentTypes GI.Notify.Objects.Notification.Notification


module GI.Notify.Objects


module GI.Notify