#include <stdlib.h>
#include <glib-object.h>
#include <glib.h>
#include "connection.h"
Include dependency graph for notify.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
struct | PurpleNotifySearchResults |
Search results object. More... | |
struct | PurpleNotifySearchColumn |
Single column of a search result. More... | |
struct | PurpleNotifySearchButton |
Definition of a button. More... | |
struct | PurpleNotifyUiOps |
Notification UI operations. More... | |
Notification API | |
#define | purple_notify_info(handle, title, primary, secondary) |
A wrapper for purple_notify_message that displays an information message. | |
#define | purple_notify_warning(handle, title, primary, secondary) |
A wrapper for purple_notify_message that displays a warning message. | |
#define | purple_notify_error(handle, title, primary, secondary) |
A wrapper for purple_notify_message that displays an error message. | |
void * | purple_notify_message (void *handle, PurpleNotifyMsgType type, const char *title, const char *primary, const char *secondary, PurpleNotifyCloseCallback cb, gpointer user_data) |
Displays a notification message to the user. | |
void * | purple_notify_email (void *handle, const char *subject, const char *from, const char *to, const char *url, PurpleNotifyCloseCallback cb, gpointer user_data) |
Displays a single email notification to the user. | |
void * | purple_notify_emails (void *handle, size_t count, gboolean detailed, const char **subjects, const char **froms, const char **tos, const char **urls, PurpleNotifyCloseCallback cb, gpointer user_data) |
Displays a notification for multiple emails to the user. | |
void * | purple_notify_formatted (void *handle, const char *title, const char *primary, const char *secondary, const char *text, PurpleNotifyCloseCallback cb, gpointer user_data) |
Displays a notification with formatted text. | |
void * | purple_notify_userinfo (PurpleConnection *gc, const char *who, PurpleNotifyUserInfo *user_info, PurpleNotifyCloseCallback cb, gpointer user_data) |
Displays user information with formatted text, passing information giving the connection and username from which the user information came. | |
PurpleNotifyUserInfo * | purple_notify_user_info_new (void) |
Create a new PurpleNotifyUserInfo which is suitable for passing to purple_notify_userinfo(). | |
void | purple_notify_user_info_destroy (PurpleNotifyUserInfo *user_info) |
Destroy a PurpleNotifyUserInfo. | |
GList * | purple_notify_user_info_get_entries (PurpleNotifyUserInfo *user_info) |
Retrieve the array of PurpleNotifyUserInfoEntry objects from a PurpleNotifyUserInfo. | |
char * | purple_notify_user_info_get_text_with_newline (PurpleNotifyUserInfo *user_info, const char *newline) |
Create a textual representation of a PurpleNotifyUserInfo, separating entries with newline. | |
void | purple_notify_user_info_add_pair (PurpleNotifyUserInfo *user_info, const char *label, const char *value) |
Add a label/value pair to a PurpleNotifyUserInfo object. | |
void | purple_notify_user_info_prepend_pair (PurpleNotifyUserInfo *user_info, const char *label, const char *value) |
Prepend a label/value pair to a PurpleNotifyUserInfo object. | |
void | purple_notify_user_info_remove_entry (PurpleNotifyUserInfo *user_info, PurpleNotifyUserInfoEntry *user_info_entry) |
Remove a PurpleNotifyUserInfoEntry from a PurpleNotifyUserInfo object without freeing the entry. | |
PurpleNotifyUserInfoEntry * | purple_notify_user_info_entry_new (const char *label, const char *value) |
Create a new PurpleNotifyUserInfoEntry. | |
void | purple_notify_user_info_add_section_break (PurpleNotifyUserInfo *user_info) |
Add a section break. | |
void | purple_notify_user_info_prepend_section_break (PurpleNotifyUserInfo *user_info) |
Prepend a section break. | |
void | purple_notify_user_info_add_section_header (PurpleNotifyUserInfo *user_info, const char *label) |
Add a section header. | |
void | purple_notify_user_info_prepend_section_header (PurpleNotifyUserInfo *user_info, const char *label) |
Prepend a section header. | |
void | purple_notify_user_info_remove_last_item (PurpleNotifyUserInfo *user_info) |
Remove the last item which was added to a PurpleNotifyUserInfo. | |
const gchar * | purple_notify_user_info_entry_get_label (PurpleNotifyUserInfoEntry *user_info_entry) |
Get the label for a PurpleNotifyUserInfoEntry. | |
void | purple_notify_user_info_entry_set_label (PurpleNotifyUserInfoEntry *user_info_entry, const char *label) |
Set the label for a PurpleNotifyUserInfoEntry. | |
const gchar * | purple_notify_user_info_entry_get_value (PurpleNotifyUserInfoEntry *user_info_entry) |
Get the value for a PurpleNotifyUserInfoEntry. | |
void | purple_notify_user_info_entry_set_value (PurpleNotifyUserInfoEntry *user_info_entry, const char *value) |
Set the value for a PurpleNotifyUserInfoEntry. | |
PurpleNotifyUserInfoEntryType | purple_notify_user_info_entry_get_type (PurpleNotifyUserInfoEntry *user_info_entry) |
Get the type of a PurpleNotifyUserInfoEntry. | |
void | purple_notify_user_info_entry_set_type (PurpleNotifyUserInfoEntry *user_info_entry, PurpleNotifyUserInfoEntryType type) |
Set the type of a PurpleNotifyUserInfoEntry. | |
void * | purple_notify_uri (void *handle, const char *uri) |
Opens a URI or somehow presents it to the user. | |
void | purple_notify_close (PurpleNotifyType type, void *ui_handle) |
Closes a notification. | |
void | purple_notify_close_with_handle (void *handle) |
Closes all notifications registered with the specified handle. | |
void * | purple_notify_searchresults (PurpleConnection *gc, const char *title, const char *primary, const char *secondary, PurpleNotifySearchResults *results, PurpleNotifyCloseCallback cb, gpointer user_data) |
Displays results from a buddy search. | |
void | purple_notify_searchresults_free (PurpleNotifySearchResults *results) |
Frees a PurpleNotifySearchResults object. | |
void | purple_notify_searchresults_new_rows (PurpleConnection *gc, PurpleNotifySearchResults *results, void *data) |
Replace old rows with the new. | |
void | purple_notify_searchresults_button_add (PurpleNotifySearchResults *results, PurpleNotifySearchButtonType type, PurpleNotifySearchResultsCallback cb) |
Adds a stock button that will be displayed in the search results dialog. | |
void | purple_notify_searchresults_button_add_labeled (PurpleNotifySearchResults *results, const char *label, PurpleNotifySearchResultsCallback cb) |
Adds a plain labelled button that will be displayed in the search results dialog. | |
PurpleNotifySearchResults * | purple_notify_searchresults_new (void) |
Returns a newly created search results object. | |
PurpleNotifySearchColumn * | purple_notify_searchresults_column_new (const char *title) |
Returns a newly created search result column object. | |
void | purple_notify_searchresults_column_add (PurpleNotifySearchResults *results, PurpleNotifySearchColumn *column) |
Adds a new column to the search result object. | |
void | purple_notify_searchresults_row_add (PurpleNotifySearchResults *results, GList *row) |
Adds a new row of the results to the search results object. | |
guint | purple_notify_searchresults_get_rows_count (PurpleNotifySearchResults *results) |
Returns a number of the rows in the search results object. | |
guint | purple_notify_searchresults_get_columns_count (PurpleNotifySearchResults *results) |
Returns a number of the columns in the search results object. | |
GList * | purple_notify_searchresults_row_get (PurpleNotifySearchResults *results, unsigned int row_id) |
Returns a row of the results from the search results object. | |
char * | purple_notify_searchresults_column_get_title (PurpleNotifySearchResults *results, unsigned int column_id) |
Returns a title of the search results object's column. | |
UI Registration Functions | |
void | purple_notify_set_ui_ops (PurpleNotifyUiOps *ops) |
Sets the UI operations structure to be used when displaying a notification. | |
PurpleNotifyUiOps * | purple_notify_get_ui_ops (void) |
Returns the UI operations structure to be used when displaying a notification. | |
Notify Subsystem | |
void * | purple_notify_get_handle (void) |
Returns the notify subsystem handle. | |
void | purple_notify_init (void) |
Initializes the notify subsystem. | |
void | purple_notify_uninit (void) |
Uninitializes the notify subsystem. | |
Typedefs | |
typedef _PurpleNotifyUserInfoEntry | PurpleNotifyUserInfoEntry |
typedef _PurpleNotifyUserInfo | PurpleNotifyUserInfo |
typedef void(* | PurpleNotifyCloseCallback )(gpointer user_data) |
Notification close callbacks. | |
typedef void(* | PurpleNotifySearchResultsCallback )(PurpleConnection *c, GList *row, gpointer user_data) |
Callback for a button in a search result. | |
Enumerations | |
enum | PurpleNotifyType { PURPLE_NOTIFY_MESSAGE = 0, PURPLE_NOTIFY_EMAIL, PURPLE_NOTIFY_EMAILS, PURPLE_NOTIFY_FORMATTED, PURPLE_NOTIFY_SEARCHRESULTS, PURPLE_NOTIFY_USERINFO, PURPLE_NOTIFY_URI } |
Notification types. More... | |
enum | PurpleNotifyMsgType { PURPLE_NOTIFY_MSG_ERROR = 0, PURPLE_NOTIFY_MSG_WARNING, PURPLE_NOTIFY_MSG_INFO } |
Notification message types. More... | |
enum | PurpleNotifySearchButtonType { PURPLE_NOTIFY_BUTTON_LABELED = 0, PURPLE_NOTIFY_BUTTON_CONTINUE = 1, PURPLE_NOTIFY_BUTTON_ADD, PURPLE_NOTIFY_BUTTON_INFO, PURPLE_NOTIFY_BUTTON_IM, PURPLE_NOTIFY_BUTTON_JOIN, PURPLE_NOTIFY_BUTTON_INVITE } |
The types of buttons. More... | |
enum | PurpleNotifyUserInfoEntryType { PURPLE_NOTIFY_USER_INFO_ENTRY_PAIR = 0, PURPLE_NOTIFY_USER_INFO_ENTRY_SECTION_BREAK, PURPLE_NOTIFY_USER_INFO_ENTRY_SECTION_HEADER } |
Types of PurpleNotifyUserInfoEntry objects. |
Definition in file notify.h.
|
Value: purple_notify_message((handle), PURPLE_NOTIFY_MSG_ERROR, (title), \ (primary), (secondary), NULL, NULL)
|
|
Value: purple_notify_message((handle), PURPLE_NOTIFY_MSG_INFO, (title), \ (primary), (secondary), NULL, NULL)
|
|
Value: purple_notify_message((handle), PURPLE_NOTIFY_MSG_WARNING, (title), \ (primary), (secondary), NULL, NULL)
|
|
Callback for a button in a search result.
|
|
Notification message types.
|
|
The types of buttons.
|
|
|
Closes a notification. This should be used only by the UI operation functions and part of the core.
|
|
Closes all notifications registered with the specified handle.
|
|
Displays a single email notification to the user.
|
|
Displays a notification for multiple emails to the user.
|
|
Displays a notification with formatted text. The text is essentially a stripped-down format of HTML, the same that IMs may send.
|
|
Returns the notify subsystem handle.
|
|
Returns the UI operations structure to be used when displaying a notification.
|
|
Displays a notification message to the user.
|
|
Displays results from a buddy search. This can be, for example, a window with a list of all found buddies, where you are given the option of adding buddies to your buddy list.
|
|
Adds a stock button that will be displayed in the search results dialog.
|
|
Adds a plain labelled button that will be displayed in the search results dialog.
|
|
Adds a new column to the search result object.
|
|
Returns a title of the search results object's column.
|
|
Returns a newly created search result column object.
|
|
Frees a PurpleNotifySearchResults object.
|
|
Returns a number of the columns in the search results object.
|
|
Returns a number of the rows in the search results object.
|
|
Returns a newly created search results object.
|
|
Replace old rows with the new. Reuse an existing window.
|
|
Adds a new row of the results to the search results object.
|
|
Returns a row of the results from the search results object.
|
|
Sets the UI operations structure to be used when displaying a notification.
|
|
Opens a URI or somehow presents it to the user.
|
|
Add a label/value pair to a PurpleNotifyUserInfo object. PurpleNotifyUserInfo keeps track of the order in which pairs are added.
|
|
Add a section break. A UI might display this as a horizontal line.
|
|
Add a section header. A UI might display this in a different font from other text.
|
|
Destroy a PurpleNotifyUserInfo.
|
|
Get the label for a PurpleNotifyUserInfoEntry.
|
|
Get the type of a PurpleNotifyUserInfoEntry.
|
|
Get the value for a PurpleNotifyUserInfoEntry.
|
|
Create a new PurpleNotifyUserInfoEntry. If added to a PurpleNotifyUserInfo object, this should not be free()'d, as PurpleNotifyUserInfo will do so when destroyed. purple_notify_user_info_add_pair() and purple_notify_user_info_prepend_pair() are convenience methods for creating entries and adding them to a PurpleNotifyUserInfo.
|
|
Set the label for a PurpleNotifyUserInfoEntry.
|
|
Set the type of a PurpleNotifyUserInfoEntry.
|
|
Set the value for a PurpleNotifyUserInfoEntry.
|
|
Retrieve the array of PurpleNotifyUserInfoEntry objects from a PurpleNotifyUserInfo. This GList may be manipulated directly with normal GList functions such as g_list_insert(). Only PurpleNotifyUserInfoEntry are allowed in the list. If a PurpleNotifyUserInfoEntry item is added to the list, it should not be g_free()'d by the caller; PurpleNotifyUserInfo will g_free it when destroyed. To remove a PurpleNotifyUserInfoEntry, use purple_notify_user_info_remove_entry(). Do not use the GList directly.
|
|
Create a textual representation of a PurpleNotifyUserInfo, separating entries with newline.
|
|
Create a new PurpleNotifyUserInfo which is suitable for passing to purple_notify_userinfo().
|
|
Prepend a label/value pair to a PurpleNotifyUserInfo object.
|
|
Prepend a section break. A UI might display this as a horizontal line.
|
|
Prepend a section header. A UI might display this in a different font from other text.
|
|
Remove a PurpleNotifyUserInfoEntry from a PurpleNotifyUserInfo object without freeing the entry.
|
|
Remove the last item which was added to a PurpleNotifyUserInfo. This could be used to remove a section header which is not needed. |
|
Displays user information with formatted text, passing information giving the connection and username from which the user information came. The text is essentially a stripped-down format of HTML, the same that IMs may send.
|