SystemTrayIcon Class Reference

Application-wide tray icon. More...

#include <systemtrayicon.h>

Collaboration diagram for SystemTrayIcon:

Public Slots
void	show ()
	Displays tray icon.

Signals
void	leftMouseClicked ()
	Emitted if user clicks tray icon with left mouse button.

Public Member Functions
	SystemTrayIcon (const QString &icon, QObject *parent=0)
	Constructor. More...
void	showMessage (const QString &title, const QString &message, MessageIcon icon=Information, int milliseconds_timeout_hint=TRAY_ICON_BUBBLE_TIMEOUT, QObject *click_target=NULL, const char *click_slot=NULL)
	Displays new balloon tip with message. More...

Static Public Member Functions
static bool	isSystemTrayAvailable ()
	Indicates whether tray icon is supported. More...

Detailed Description

Application-wide tray icon.

Definition at line 66 of file systemtrayicon.h.

Constructor & Destructor Documentation

SystemTrayIcon::SystemTrayIcon ( const QString &  icon, QObject *  parent = 0  )

explicit

Constructor.

Parameters

icon	Icon for tray icon.
parent	Parent of tray icon.

Definition at line 61 of file systemtrayicon.cpp.

  : QSystemTrayIcon(parent),
    m_bubbleClickTarget(NULL),
    m_bubbleClickSlot(NULL) {
  qDebug("Creating SystemTrayIcon instance.");

  setIcon(QIcon(icon));

  // Create necessary connections.
  connect(this, SIGNAL(activated(QSystemTrayIcon::ActivationReason)),
          this, SLOT(onActivated(QSystemTrayIcon::ActivationReason)));
}

Member Function Documentation

bool SystemTrayIcon::isSystemTrayAvailable ( )

static

Indicates whether tray icon is supported.

Returns

Returns true if tray icon is supported.

See also

isSystemTrayActivated()

Definition at line 102 of file systemtrayicon.cpp.

                                           {
  return QSystemTrayIcon::isSystemTrayAvailable() && QSystemTrayIcon::supportsMessages();
}

Here is the caller graph for this function:

void SystemTrayIcon::showMessage	(	const QString &	title,
		const QString &	message,
		MessageIcon	icon = Information,
		int	milliseconds_timeout_hint = TRAY_ICON_BUBBLE_TIMEOUT,
		QObject *	click_target = NULL,
		const char *	click_slot = NULL
	)

Displays new balloon tip with message.

Parameters

title	Title of message.
message	Content of message.
icon	Icon of message.
milliseconds_timeout_hint	Number of miliseconds for message to being visible.
click_target	Target object for balloon tip click.
click_slot	Target object method for balloon tip click.

Warning

Use this in cooperation with isSystemTrayActivated() method.

Definition at line 78 of file systemtrayicon.cpp.

                                                         {
  if (m_bubbleClickTarget != NULL && m_bubbleClickSlot != NULL) {
    // Disconnect previous bubble click signalling.
    disconnect(this, SIGNAL(messageClicked()), m_bubbleClickTarget, m_bubbleClickSlot);
  }

  m_bubbleClickSlot = (char*) click_slot;
  m_bubbleClickTarget = click_target;

  if (click_target != NULL && click_slot != NULL) {
    // Establish new connection for bubble click.
    connect(this, SIGNAL(messageClicked()), click_target, click_slot);
  }

  // NOTE: If connections do not work, then use QMetaObject::invokeMethod(...).

  QSystemTrayIcon::showMessage(title, message, icon, milliseconds_timeout_hint);
}

---

The documentation for this class was generated from the following files:

• systemtrayicon.h
• systemtrayicon.cpp