Namespace
Notify – 0.7
Send desktop notifications
Dependencies
| GLib—2.0 | The base type system library |
| Browse documentation | |
| GObject—2.0 | The base type system library |
| Browse documentation |
Classes
| Notification |
A passive pop-up notification. |
Enumerations
| ClosedReason |
since: 0.8.0 |
| Urgency |
The urgency level of the notification. |
Callbacks
| ActionCallback |
An action callback function. |
Functions
| get_app_icon |
Gets the application icon registered. since: 0.8.4 |
| get_app_name |
Gets the application name registered. |
| get_server_caps |
Queries the server capabilities. |
| get_server_info |
Queries the server for information. |
| init |
Initialized libnotify. This must be called before any other functions. |
| is_initted |
Gets whether or not libnotify is initialized. |
| set_app_icon |
Sets the application icon. since: 0.8.4 |
| set_app_name |
Sets the application name. |
| uninit |
Uninitializes libnotify. |
Function Macros
| ACTION_CALLBACK |
A convenience macro for casting a function to a |
| CHECK_VERSION |
Check whether a version equal to or greater than
|
Constants
| EXPIRES_DEFAULT |
The default expiration time on a notification. |
| EXPIRES_NEVER |
The notification never expires. |
| NOTIFICATION_HINT_ACTION_ICONS |
When set, a server that has the “action-icons” capability will attempt to interpret any action identifier as a named icon. The localized display name will be used to annotate the icon for accessibility purposes. The icon name should be compliant with the Freedesktop.org Icon Naming Specification. |
| NOTIFICATION_HINT_CATEGORY |
The type of notification this is. |
| NOTIFICATION_HINT_DESKTOP_ENTRY |
This specifies the name of the desktop filename representing the calling program. This should be the same as the prefix used for the application’s .desktop file. An example would be “rhythmbox” from “rhythmbox.desktop”. This can be used by the daemon to retrieve the correct icon for the application, for logging purposes, etc. |
| NOTIFICATION_HINT_IMAGE_DATA |
This is a raw data image format which describes the width, height, rowstride, has alpha, bits per sample, channels and image data respectively. |
| NOTIFICATION_HINT_IMAGE_DATA_LEGACY |
This is a raw data image format which describes the width, height, rowstride, has alpha, bits per sample, channels and image data respectively. |
| NOTIFICATION_HINT_IMAGE_PATH |
Alternative way to define the notification image. |
| NOTIFICATION_HINT_IMAGE_PATH_LEGACY |
Alternative way to define the notification image. |
| NOTIFICATION_HINT_RESIDENT |
When set the server will not automatically remove the notification when an action has been invoked. The notification will remain resident in the server until it is explicitly removed by the user or by the sender. This hint is likely only useful when the server has the “persistence” capability. |
| NOTIFICATION_HINT_SOUND_FILE |
The path to a sound file to play when the notification pops up. |
| NOTIFICATION_HINT_SOUND_NAME |
A themeable named sound from the freedesktop.org sound naming specification to play when the notification pops up. Similar to icon-name, only for sounds. An example would be “message-new-instant”. |
| NOTIFICATION_HINT_SUPPRESS_SOUND |
Causes the server to suppress playing any sounds, if it has that ability. This is usually set when the client itself is going to play its own sound. |
| NOTIFICATION_HINT_TRANSIENT |
When set the server will treat the notification as transient and by-pass the server’s persistence capability, if it should exist. |
| NOTIFICATION_HINT_URGENCY |
The urgency level. |
| NOTIFICATION_HINT_X |
Specifies the X location on the screen that the notification should point to. The “y” hint must also be specified. |
| NOTIFICATION_HINT_Y |
Specifies the Y location on the screen that the notification should point to. The “x” hint must also be specified. |
| VERSION_MAJOR |
Notify major version component (e.g. 1 if the version is 1.2.3). |
| VERSION_MICRO |
Notify micro version component (e.g. 3 if the version is 1.2.3). |
| VERSION_MINOR |
Notify minor version component (e.g. 2 if the version is 1.2.3). |