libgaminggear
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Typedefs | Functions
screen_notificator.h File Reference

Typedefs

typedef struct
_GaminggearScreenNotificator 
GaminggearScreenNotificator
 
typedef struct
_GaminggearScreenNotification 
GaminggearScreenNotification
 

Functions

GaminggearScreenNotificatorgaminggear_screen_notificator_init (gchar const *app_name, gchar const *icon)
 Initializes an screen notificator. More...
 
void gaminggear_screen_notificator_deinit (GaminggearScreenNotificator *notificator)
 Frees an existing notificator. More...
 
GaminggearScreenNotificationgaminggear_screen_notification_new (GaminggearScreenNotificator *notificator)
 Create new notification. More...
 
void gaminggear_screen_notification_free (GaminggearScreenNotification *notification)
 Frees an existing notification. More...
 
gboolean gaminggear_screen_notification_update (GaminggearScreenNotification *notification, gchar const *format,...)
 Show notification. More...
 
gboolean gaminggear_screen_notification_update_v (GaminggearScreenNotification *notification, gchar const *format, va_list args)
 Show notification. More...
 
gboolean gaminggear_screen_notification_cancel (GaminggearScreenNotification *notification)
 Cancel a running notification. More...
 

Typedef Documentation

typedef struct _GaminggearScreenNotification GaminggearScreenNotification
typedef struct _GaminggearScreenNotificator GaminggearScreenNotificator

Function Documentation

gboolean gaminggear_screen_notification_cancel ( GaminggearScreenNotification notification)

Cancel a running notification.

Parameters
notificationNotification to be cancelled.
Return values
boolTRUE on success, else FALSE.
Since
1.0
void gaminggear_screen_notification_free ( GaminggearScreenNotification notification)

Frees an existing notification.

Parameters
notificationThe notification to be freed.
Since
1.0
GaminggearScreenNotification* gaminggear_screen_notification_new ( GaminggearScreenNotificator notificator)

Create new notification.

Parameters
notificatorA notificator.
Return values
notificationA new notification to be freed with gaminggear_screen_notification_free().
Since
1.0
gboolean gaminggear_screen_notification_update ( GaminggearScreenNotification notification,
gchar const *  format,
  ... 
)

Show notification.

If this notification is already visible it's content is updated.

Parameters
notificationThe notification to be updated.
formatA printf() compatible format string.
...The arguments to be inserted in the output.
Return values
boolTRUE on success, else FALSE.
Since
1.0
gboolean gaminggear_screen_notification_update_v ( GaminggearScreenNotification notification,
gchar const *  format,
va_list  args 
)

Show notification.

If this notification is already visible it's content is updated.

Parameters
notificationThe notification to be updated.
formatA printf() compatible format string.
argsThe arguments to be inserted in the output.
Return values
boolTRUE on success, else FALSE.
Since
1.0
void gaminggear_screen_notificator_deinit ( GaminggearScreenNotificator notificator)

Frees an existing notificator.

Parameters
notificatorThe notificator to be freed.
Since
1.0
GaminggearScreenNotificator* gaminggear_screen_notificator_init ( gchar const *  app_name,
gchar const *  icon 
)

Initializes an screen notificator.

The nomenclature init/deinit means there is only one instance of this object supported by an application.

Parameters
app_nameThe name of the binary.
iconThe name of the icon to be shown in notification.
Return values
notificatorA new notificator object to be freed with gaminggear_screen_notificator_deinit() or NULL on error.
Since
1.0