---
name: "Gtk2::TrayIcon"
section: "3pm"
platform: "linux"
package: "libgtk2-trayicon-perl"
version: "0.06-2+b3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/Gtk2::TrayIcon"
---

# Gtk2::TrayIcon(3pm)

Perl interface to the EggTrayIcon library

## NAME

Gtk2::TrayIcon - Perl interface to the EggTrayIcon library

## SYNOPSIS

```
  use Gtk2::TrayIcon;
  Gtk2->init;
  my $icon= Gtk2::TrayIcon->new("test");
  my $label= Gtk2::Label->new("test");
  $icon->add($label);
  $icon->show_all;
  Gtk2->main;
```

## ABSTRACT

This module allows a Perl developer to embed an arbitrary widget in a System Tray like the Gnome notification area.

## DESCRIPTION

EggTrayIcon is slated for inclusion in Gtk+ at some point, which is the reason the `"Gtk2::TrayIcon"` namespace. As all egg libs, EggTrayIcon is not considered api stable and its not installed as a shared object.

Enough about what it is not, `"Gtk2::TrayIcon"` is first and foremost a simple way of giving a Gtk2 script access to the system tray.

System Trays are found in both KDE and Gnome. But neither support the spec fully (see below).

`"Gtk2::TrayIcon"` is a subclass of `"Gtk2::Plug"` and should be used as such.

## METHODS

5 methods are available.

- $trayicon= Gtk2::TrayIcon-\>new\_from\_screen($screen, $name)

  This creates a widget already connected to the notification area of `$screen`. `$screen` should be a `"Gtk::Gdk::Screen"`.

- $trayicon= Gtk2::TrayIcon-\>new($name)

  Like `"new_from_screen"` but uses the default screen of the active display.

- $msgid= $trayicon-\>send\_message($timeout, $message)

  Ask the tray to display `$message` for `$timeout` milliseconds. If `$timeout` is 0, the message will not expire.

  Note that it is up to the tray to decide what to do with the message both Gnome and KDE just ignores it.

- $trayicon-\>cancel\_message($msgid)

  Ask the tray to cancel the message.

## SEE ALSO

Glib, Gtk2 and The System Tray Spec http://www.freedesktop.org/Standards/systemtray-spec.

## AUTHOR

Christian Borup \<gtk2-perl at borup dot com\>

## COPYRIGHT AND LICENSE

Copyright 2003 by the gtk2-perl team.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 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 Library General Public License for more details.

You should have received a copy of the GNU Library 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.