## Tray Tools

Tray Tools — Useful functions dealing with trays.

## Synopsis

    void        gpe_system_tray_dock            (GdkWindow *window);
    guint       gpe_system_tray_send_message    (GdkWindow *window,
                                                 const gchar *text,
                                                 unsigned int timeout);
    void        gpe_system_tray_cancel_message  (GdkWindow *window,
                                                 guint id);

## Description

Some functions that provide easier handling of applications that dock to some kind of tray or panel. (e.g. a notification area of a Gnome panel or a Matchbox-Panel.)

## Details

### gpe_system_tray_dock ()

    void        gpe_system_tray_dock            (GdkWindow *window);

Make a window a dock window and dock it to a system tray.

`window` : | Window to dock.

### gpe_system_tray_send_message ()

    guint       gpe_system_tray_send_message    (GdkWindow *window,
                                                 const gchar *text,
                                                 unsigned int timeout);

Pop up a message in the panel. These messages are intended to give the user some information if something important is going on and should disappear without user interaction. Note that message timeouts may be not implemented in some environments.

`window` : | Dock window that should pop up the message.
`text` : | Message to display.
`timeout` : | Time in seconds until message disappears.
Returns : | An unique message id.

### gpe_system_tray_cancel_message ()

    void        gpe_system_tray_cancel_message  (GdkWindow *window,
                                                 guint id);

Remove a message currently displayed from panel.

`window` : | Window to remove a message from.
`id` : | Id of the message to remove.

## See Also

Used by: gpe-aerial, gpe-bluetooth, gpe-beam and gpe-buttonbox