\section{systray.c File Reference}
\label{systray_8c}\index{systray.c@{systray.c}}
Interface to the system tray. 

{\tt \#include \char`\"{}rox-clib.h\char`\"{}}\par
{\tt \#include $<$stdlib.h$>$}\par
{\tt \#include $<$stdio.h$>$}\par
{\tt \#include $<$string.h$>$}\par
{\tt \#include $<$time.h$>$}\par
{\tt \#include $<$unistd.h$>$}\par
{\tt \#include $<$gdk/gdk.h$>$}\par
{\tt \#include $<$gdk/gdkx.h$>$}\par
{\tt \#include $<$gtk/gtk.h$>$}\par
{\tt \#include \char`\"{}choices.h\char`\"{}}\par
{\tt \#include \char`\"{}rox.h\char`\"{}}\par
{\tt \#include \char`\"{}systray.h\char`\"{}}\par
\subsection*{Functions}
\begin{CompactItemize}
\item 
void {\bf rox\_\-systray\_\-init} (void)
\item 
Gtk\-Widget $\ast$ {\bf rox\_\-systray\_\-new} (void)
\item 
Gtk\-Widget $\ast$ {\bf rox\_\-systray\_\-new\_\-on\_\-screen} (Gdk\-Screen $\ast$screen)
\item 
int {\bf rox\_\-systray\_\-send\_\-message} (Gtk\-Widget $\ast$systray, const char $\ast$message, unsigned usec)
\item 
void {\bf rox\_\-systray\_\-cancel\_\-message} (Gtk\-Widget $\ast$systray, int id)
\item 
gboolean {\bf rox\_\-systray\_\-is\_\-vertical} (Gtk\-Widget $\ast$systray)
\end{CompactItemize}


\subsection{Detailed Description}
Interface to the system tray. 



\subsection{Function Documentation}
\index{systray.c@{systray.c}!rox_systray_cancel_message@{rox\_\-systray\_\-cancel\_\-message}}
\index{rox_systray_cancel_message@{rox\_\-systray\_\-cancel\_\-message}!systray.c@{systray.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void rox\_\-systray\_\-cancel\_\-message (Gtk\-Widget $\ast$ {\em systray}, int {\em id})}\label{systray_8c_2516f8c9cbbdd719f48df64c6c8b20fd}


Cancel a balloon help message.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em systray}]system tray container as used in \doxyref{rox\_\-systray\_\-send\_\-message()}{p.}{systray_8c_b4673dd0c88c6cddd06e92a2585e1c7b}. \item[\mbox{$\leftarrow$} {\em id}]id code returned by \doxyref{rox\_\-systray\_\-send\_\-message()}{p.}{systray_8c_b4673dd0c88c6cddd06e92a2585e1c7b}. \end{description}
\end{Desc}
\index{systray.c@{systray.c}!rox_systray_init@{rox\_\-systray\_\-init}}
\index{rox_systray_init@{rox\_\-systray\_\-init}!systray.c@{systray.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void rox\_\-systray\_\-init (void)}\label{systray_8c_5fe82b64f48b083672bfd4a86464e766}


Initialize the system tray interface. \index{systray.c@{systray.c}!rox_systray_is_vertical@{rox\_\-systray\_\-is\_\-vertical}}
\index{rox_systray_is_vertical@{rox\_\-systray\_\-is\_\-vertical}!systray.c@{systray.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}gboolean rox\_\-systray\_\-is\_\-vertical (Gtk\-Widget $\ast$ {\em systray})}\label{systray_8c_c6bc5823120b39b75b174696b3ae4b70}


Determine the orientation of the system tray.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em systray}]system tray container returned by \doxyref{rox\_\-systray\_\-new()}{p.}{systray_8c_84df3c464d98e48f70250b2ed88cda44}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]{\tt TRUE} if the system tray has a vertical orientation, or {\tt FALSE} if horizontal. \end{Desc}
\index{systray.c@{systray.c}!rox_systray_new@{rox\_\-systray\_\-new}}
\index{rox_systray_new@{rox\_\-systray\_\-new}!systray.c@{systray.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Gtk\-Widget$\ast$ rox\_\-systray\_\-new (void)}\label{systray_8c_84df3c464d98e48f70250b2ed88cda44}


Create a new system tray widget for the default screen. A container widget is returned, you should add whatever widgets are needed to it. \doxyref{rox\_\-systray\_\-init()}{p.}{systray_8c_5fe82b64f48b083672bfd4a86464e766} must be called first.

\begin{Desc}
\item[Returns:]a pointer to a Gtk\-Container widget, or NULL if no system tray manager was found. \end{Desc}
\index{systray.c@{systray.c}!rox_systray_new_on_screen@{rox\_\-systray\_\-new\_\-on\_\-screen}}
\index{rox_systray_new_on_screen@{rox\_\-systray\_\-new\_\-on\_\-screen}!systray.c@{systray.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Gtk\-Widget$\ast$ rox\_\-systray\_\-new\_\-on\_\-screen (Gdk\-Screen $\ast$ {\em screen})}\label{systray_8c_3c4f999cf4124f1047e0c060f1a1c338}


Create a new system tray widget for the specified screen. A container widget is returned, you should add whatever widgets are needed to it. \doxyref{rox\_\-systray\_\-init()}{p.}{systray_8c_5fe82b64f48b083672bfd4a86464e766} must be called first.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em screen}]screen where the system tray manager is running \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]a pointer to a Gtk\-Container widget, or NULL if no system tray manager was found for the screen. \end{Desc}
\index{systray.c@{systray.c}!rox_systray_send_message@{rox\_\-systray\_\-send\_\-message}}
\index{rox_systray_send_message@{rox\_\-systray\_\-send\_\-message}!systray.c@{systray.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int rox\_\-systray\_\-send\_\-message (Gtk\-Widget $\ast$ {\em systray}, const char $\ast$ {\em message}, unsigned {\em usec})}\label{systray_8c_b4673dd0c88c6cddd06e92a2585e1c7b}


Send a balloon message to the system tray icon.

This shows the message immediately. If instead you wish to show a tooltip when the mouse hovers over the icon then you should instead pack your icon in a Gtk\-Event\-Box and set the tooltip on that instead.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em systray}]system tray container as returned by \doxyref{rox\_\-systray\_\-new()}{p.}{systray_8c_84df3c464d98e48f70250b2ed88cda44} or \doxyref{rox\_\-systray\_\-new\_\-on\_\-screen()}{p.}{systray_8c_3c4f999cf4124f1047e0c060f1a1c338}. \item[\mbox{$\leftarrow$} {\em message}]message to display \item[\mbox{$\leftarrow$} {\em usec}]time in micro-seconds to display balloon message, or 0 for no time out. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]id code for message, 0 returned for failure \end{Desc}
