screen_notificator.h File Reference

Typedefs
typedef struct _GaminggearScreenNotificator	GaminggearScreenNotificator
typedef struct _GaminggearScreenNotification	GaminggearScreenNotification

Functions
GaminggearScreenNotificator *	gaminggear_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...
GaminggearScreenNotification *	gaminggear_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

GaminggearScreenNotification

typedef struct _GaminggearScreenNotification GaminggearScreenNotification

GaminggearScreenNotificator

typedef struct _GaminggearScreenNotificator GaminggearScreenNotificator

Function Documentation

gaminggear_screen_notification_cancel()

gboolean gaminggear_screen_notification_cancel

(

GaminggearScreenNotification *

notification

)

Cancel a running notification.

Parameters

notification

Notification to be cancelled.

Return values

bool	TRUE on success, else FALSE.

Since

1.0

gaminggear_screen_notification_free()

void gaminggear_screen_notification_free

(

GaminggearScreenNotification *

notification

)

Frees an existing notification.

Parameters

notification

The notification to be freed.

Since

1.0

gaminggear_screen_notification_new()

GaminggearScreenNotification* gaminggear_screen_notification_new

(

GaminggearScreenNotificator *

notificator

)

Create new notification.

Parameters

notificator

A notificator.

Return values

notification

A new notification to be freed with gaminggear_screen_notification_free().

Since

1.0

gaminggear_screen_notification_update()

gboolean gaminggear_screen_notification_update	(	GaminggearScreenNotification *	notification,
		gchar const *	format,
			...
	)

Show notification.

If this notification is already visible its content is updated.

Parameters

notification	The notification to be updated.
format	A printf() compatible format string.
...	The arguments to be inserted in the output.

Return values

bool	TRUE on success, else FALSE.

Since

1.0

gaminggear_screen_notification_update_v()

gboolean gaminggear_screen_notification_update_v	(	GaminggearScreenNotification *	notification,
		gchar const *	format,
		va_list	args
	)

Show notification.

If this notification is already visible its content is updated.

Parameters

notification	The notification to be updated.
format	A printf() compatible format string.
args	The arguments to be inserted in the output.

Return values

bool	TRUE on success, else FALSE.

Since

1.0

gaminggear_screen_notificator_deinit()

void gaminggear_screen_notificator_deinit

(

GaminggearScreenNotificator *

notificator

)

Frees an existing notificator.

Parameters

notificator

The notificator to be freed.

Since

1.0

gaminggear_screen_notificator_init()

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_name	The name of the binary.
icon	The name of the icon to be shown in notification.

Return values

notificator

A new notificator object to be freed with gaminggear_screen_notificator_deinit() or NULL on error.

Since

1.0