notify.h File Reference

Notifications library. More...

#include <glib.h>
#include <time.h>
#include <libnotify/notification.h>

Go to the source code of this file.

libnotify Base API
gboolean	notify_init (const char *app_name)
	Initializes the notifications library.
void	notify_uninit (void)
	Uninitializes the notifications library.
gboolean	notify_is_initted (void)
	Returns whether or not the notification library is initialized.
const gchar *	notify_get_app_name (void)
	Returns the name of the application set when notify_init() was called.
GList *	notify_get_server_caps (void)
	Returns the capabilities of the notification server.
gboolean	notify_get_server_info (char **ret_name, char **ret_vendor, char **ret_version, char **ret_spec_version)
	Returns the server notification information.

---

Detailed Description

Notifications library.

Copyright:

(C) 2004-2006 Christian Hammond

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Definition in file notify.h.

---

Function Documentation

const gchar* notify_get_app_name (  void   )

Returns the name of the application set when notify_init() was called. Returns: The name of the application.

GList* notify_get_server_caps (  void   )

Returns the capabilities of the notification server. Returns: A list of capability strings. These strings must be freed.

gboolean notify_get_server_info (  char **  ret_name, char **  ret_vendor, char **  ret_version, char **  ret_spec_version )

Returns the server notification information. The strings returned must be freed. Parameters: ret_name  The returned product name of the server. ret_vendor  The returned vendor. ret_version  The returned server version. ret_spec_version  The returned specification version supported. Returns: TRUE if the call succeeded, or FALSE if there were errors.

gboolean notify_init (  const char *  app_name  )

Initializes the notifications library. Parameters: app_name  The application name. Returns: TRUE if the library initialized properly and a connection to a notification server was made.

gboolean notify_is_initted (  void   )

Returns whether or not the notification library is initialized. Returns: TRUE if the library is initialized, or FALSE.

void notify_uninit (  void   )

Uninitializes the notifications library. This will be automatically called on exit unless previously called.

---