Synopsis

Screenshot

Options

Image to be shown, can be either a
file (prefix "%/") or a stock item (prefix "%#").

-onActivate string
(default: "")

Tcl command which is executed if
the Enter is pressed in the entry. Before evaluation the following
percent strings are substituted:

%wwidget name%ttext contents of
the entry widget buffer

-onButtonPressstring (default: "")

Tcl script which is executed if a
mouse button is press inside the widget. Before evaluation the following
percent strings are substituted:

%wwidget name%ttype of event. One of buttonPress, button2Press or button3Press%xx coordinate%yy coordinate%bbutton number%sstate of the buttons and modifiers (bitmask)

-onButtonReleasestring (default: "")

Tcl script which is executed if a
mouse button is released inside the widget. Before evaluation the
following percent strings are substituted:

%wwidget name%ttype of event. One of buttonPress, button2Press or button3Press%xx coordinate%yy coordinate%bbutton number%sstate of the buttons and modifiers (bitmask)

-onPopup string
(default: "")

Tcl script which is executed
prior to
the display of the default popup menu allowing the controlling
script to add items and submenus to the popup. Before evaluation the following percent strings are
substituted:

%w widget name%g widget glade name

-onSizeChange string (default: "")

Tcl script executed in response to a resizing of the the status icon itself. Before evaluation the following percent strings are
substituted:

%w widget name%g widget glade name

-tooltipstring (default: "")

Message that appear next to this
widget when the mouse pointer is held over it for a short amount of
time.

-visible boolean (default: 1)

Whether or not the item is visible.

Description

The Gnome desktop has a "system tray" which functions as notification
area and generally contains transient icons
that indicate some special state. For example, a system tray icon would
be displayed to notify the user that they have received new mail or an
incoming instant
message.

NOTE:

Reference to the Gtk+ documentation will describe this object as a Gtk+ Display widget. As this item relies upon resource not contained within the core Gtk+ intallation and may not be a cross-plaform feature, this item is included with the GnoclGnome package.

Commands

idcgetoption

Returns the value for the specified
option. The option may have any of hte values accepted by configure.

idclass

Returns the class of the widget, i.e.
statusIcon.

idconfigure [-option value...]

Configures the widget. Option may have
any of the values accepted on creation of the widget.

idnotifiy[-option value...]

Display a notification popup with
message above the statusIcon.

Options

-appNamestring (default: "")

<description to be added>

-summarystring (default: "")

The main notifcation message presented
in enboldened capitals.

-bodystring (default: "")

A message that expands upon the reason
for the notification, typically contains extra information. The string
can be formatted as a pango markup string..

-iconpercent-string (default: "")

Image to be shown, can either be a file
(prefic "%/") or stock item (prefix "%#").

-soundstring

Name of sound file to be played when
notification appears. The sound files loaded are contained in those directories containing sound themes, typically /usr/share/sounds or similar.

-timeoutint (default: 3000)

Specify how long the notifiy widget
will be displayed in milliseconds.

-urgencystring (default: "normal")

Provide user feedback on the urgency of
the message notified. The available options are: low, normal or
critical. The levels of urgency will be reflected in the colouration of
the stripe displayed in left section of the notification widget.

iddelete

Deletes the widget and the
associated tcl command.

Example

# statusIcon.tcl##!/bin/sh# the next line restarts using tclsh \exec tclsh "$0" "$@"