\section{infowin.h File Reference}
\label{infowin_8h}\index{infowin.h@{infowin.h}}
A GTK+ Widget to implement a RISC OS style info window. 

{\tt \#include $<$gdk/gdk.h$>$}\par
{\tt \#include $<$gtk/gtkdialog.h$>$}\par
{\tt \#include $<$gtk/gtkvbox.h$>$}\par
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct {\bf ROXInfo\-Win}
\begin{CompactList}\small\item\em Definition of a \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} widget. \item\end{CompactList}\item 
struct {\bf ROXInfo\-Win\-Class}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\#define {\bf ROX\_\-INFO\_\-WIN}(obj)~GTK\_\-CHECK\_\-CAST (obj, rox\_\-info\_\-win\_\-get\_\-type (), {\bf ROXInfo\-Win})
\item 
\#define {\bf ROX\_\-INFO\_\-WIN\_\-CLASS}(klass)~GTK\_\-CHECK\_\-CLASS\_\-CAST (klass, rox\_\-info\_\-win\_\-get\_\-type (), {\bf ROXInfo\-Win\-Class})
\item 
\#define {\bf ROX\_\-IS\_\-INFO\_\-WIN}(obj)~GTK\_\-CHECK\_\-TYPE (obj, rox\_\-info\_\-win\_\-get\_\-type ())
\item 
\#define {\bf Info\-Win}~{\bf ROXInfo\-Win}
\item 
\#define {\bf Info\-Win\-Class}~{\bf ROXInfo\-Win\-Class}
\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
GType {\bf rox\_\-info\_\-win\_\-get\_\-type} (void)
\item 
Gtk\-Widget $\ast$ {\bf rox\_\-info\_\-win\_\-new} (const gchar $\ast${\bf program}, const gchar $\ast$purpose, const gchar $\ast$version, const gchar $\ast$author, const gchar $\ast$website)
\item 
void {\bf rox\_\-info\_\-win\_\-add\_\-browser\_\-command} ({\bf ROXInfo\-Win} $\ast$iw, const gchar $\ast$cmd)
\item 
Gtk\-Widget $\ast$ {\bf rox\_\-info\_\-win\_\-get\_\-extension\_\-area} ({\bf ROXInfo\-Win} $\ast$iw)
\item 
Gtk\-Widget $\ast$ {\bf info\_\-win\_\-new} (const gchar $\ast${\bf program}, const gchar $\ast$purpose, const gchar $\ast$version, const gchar $\ast$author, const gchar $\ast$website)
\item 
Gtk\-Widget $\ast$ {\bf info\_\-win\_\-new\_\-from\_\-appinfo} (const gchar $\ast${\bf program})
\item 
void {\bf info\_\-win\_\-add\_\-browser\_\-command} ({\bf ROXInfo\-Win} $\ast$iw, const gchar $\ast$cmd)
\end{CompactItemize}


\subsection{Detailed Description}
A GTK+ Widget to implement a RISC OS style info window. 



\subsection{Define Documentation}
\index{infowin.h@{infowin.h}!InfoWin@{InfoWin}}
\index{InfoWin@{InfoWin}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define Info\-Win~{\bf ROXInfo\-Win}}\label{infowin_8h_1fd2f104df572cb0c02fc993655793f7}


\begin{Desc}
\item[{\bf Deprecated}]Use \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} \end{Desc}
\index{infowin.h@{infowin.h}!InfoWinClass@{InfoWinClass}}
\index{InfoWinClass@{InfoWinClass}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define Info\-Win\-Class~{\bf ROXInfo\-Win\-Class}}\label{infowin_8h_609b778cd493d12a9e08880b2bd6480f}


\begin{Desc}
\item[{\bf Deprecated}]Use \doxyref{ROXInfo\-Win\-Class}{p.}{structROXInfoWinClass} \end{Desc}
\index{infowin.h@{infowin.h}!ROX_INFO_WIN@{ROX\_\-INFO\_\-WIN}}
\index{ROX_INFO_WIN@{ROX\_\-INFO\_\-WIN}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define ROX\_\-INFO\_\-WIN(obj)~GTK\_\-CHECK\_\-CAST (obj, rox\_\-info\_\-win\_\-get\_\-type (), {\bf ROXInfo\-Win})}\label{infowin_8h_4696af05ac6b90d2c24575ea4270e297}


Cast object pointer to \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} $\ast$ or {\tt NULL} if not a valid \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} $\ast$ \begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em obj}]pointer to object \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]pointer to \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} or {\tt NULL} \end{Desc}
\index{infowin.h@{infowin.h}!ROX_INFO_WIN_CLASS@{ROX\_\-INFO\_\-WIN\_\-CLASS}}
\index{ROX_INFO_WIN_CLASS@{ROX\_\-INFO\_\-WIN\_\-CLASS}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define ROX\_\-INFO\_\-WIN\_\-CLASS(klass)~GTK\_\-CHECK\_\-CLASS\_\-CAST (klass, rox\_\-info\_\-win\_\-get\_\-type (), {\bf ROXInfo\-Win\-Class})}\label{infowin_8h_c85e5162151bfb18b15cea30e4adc4fd}


Cast class pointer to \doxyref{ROXInfo\-Win\-Class}{p.}{structROXInfoWinClass} $\ast$ or {\tt NULL} if not a valid \doxyref{ROXInfo\-Win\-Class}{p.}{structROXInfoWinClass} $\ast$ \begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em klass}]pointer to class \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]pointer to \doxyref{ROXInfo\-Win\-Class}{p.}{structROXInfoWinClass} or {\tt NULL} \end{Desc}
\index{infowin.h@{infowin.h}!ROX_IS_INFO_WIN@{ROX\_\-IS\_\-INFO\_\-WIN}}
\index{ROX_IS_INFO_WIN@{ROX\_\-IS\_\-INFO\_\-WIN}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define ROX\_\-IS\_\-INFO\_\-WIN(obj)~GTK\_\-CHECK\_\-TYPE (obj, rox\_\-info\_\-win\_\-get\_\-type ())}\label{infowin_8h_1175a6d690f2593bbcc58c75baa811b9}


Test if object is a \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} \begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em obj}]pointer to object \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]non-zero if argument points to a \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} \end{Desc}


\subsection{Function Documentation}
\index{infowin.h@{infowin.h}!info_win_add_browser_command@{info\_\-win\_\-add\_\-browser\_\-command}}
\index{info_win_add_browser_command@{info\_\-win\_\-add\_\-browser\_\-command}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void info\_\-win\_\-add\_\-browser\_\-command ({\bf ROXInfo\-Win} $\ast$ {\em iw}, const gchar $\ast$ {\em cmd})}\label{infowin_8h_7a3ddce3ee2932149b13f82392f46d57}


\begin{Desc}
\item[{\bf Deprecated}]As \doxyref{rox\_\-info\_\-win\_\-add\_\-browser\_\-command()}{p.}{infowin_8c_40577c74c4e6d3bf8e133b9b953bacf8}. \end{Desc}
\index{infowin.h@{infowin.h}!info_win_new@{info\_\-win\_\-new}}
\index{info_win_new@{info\_\-win\_\-new}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Gtk\-Widget$\ast$ info\_\-win\_\-new (const gchar $\ast$ {\em program}, const gchar $\ast$ {\em purpose}, const gchar $\ast$ {\em version}, const gchar $\ast$ {\em author}, const gchar $\ast$ {\em website})}\label{infowin_8h_f35cd42394ac0a3ac97f8edd139d02f0}


\begin{Desc}
\item[{\bf Deprecated}]As \doxyref{rox\_\-info\_\-win\_\-new()}{p.}{infowin_8c_8da5fdb1ec1b7f2599f4e3af5b3bbfc5} except that the window's delete\_\-event signal is caught to turn closing the window into a hide \end{Desc}
\index{infowin.h@{infowin.h}!info_win_new_from_appinfo@{info\_\-win\_\-new\_\-from\_\-appinfo}}
\index{info_win_new_from_appinfo@{info\_\-win\_\-new\_\-from\_\-appinfo}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Gtk\-Widget$\ast$ info\_\-win\_\-new\_\-from\_\-appinfo (const gchar $\ast$ {\em program})}\label{infowin_8h_6f2c980e4c7398987a02476b2f64c72f}


\begin{Desc}
\item[{\bf Deprecated}]As \doxyref{rox\_\-info\_\-win\_\-new\_\-from\_\-appinfo()}{p.}{infowin_8c_e72cce77ca7fd12fb98db70c85d94e88} except that the window's delete\_\-event signal is caught to turn closing the window into a hide \end{Desc}
\index{infowin.h@{infowin.h}!rox_info_win_add_browser_command@{rox\_\-info\_\-win\_\-add\_\-browser\_\-command}}
\index{rox_info_win_add_browser_command@{rox\_\-info\_\-win\_\-add\_\-browser\_\-command}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void rox\_\-info\_\-win\_\-add\_\-browser\_\-command ({\bf ROXInfo\-Win} $\ast$ {\em iw}, const gchar $\ast$ {\em cmd})}\label{infowin_8h_40577c74c4e6d3bf8e133b9b953bacf8}


Add a possible command for viewing a web page.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftrightarrow$} {\em iw}]a valid info window \item[\mbox{$\leftarrow$} {\em cmd}]command to add. It will be called with a single argument which is the URL to view\end{description}
\end{Desc}
\begin{Desc}
\item[{\bf Deprecated}]Web sites are now viewed using \doxyref{rox\_\-uri\_\-launch()}{p.}{uri_8c_600d9d74224900548e10188f1e4cd384} and commands added by this function are ignored. \end{Desc}
\index{infowin.h@{infowin.h}!rox_info_win_get_extension_area@{rox\_\-info\_\-win\_\-get\_\-extension\_\-area}}
\index{rox_info_win_get_extension_area@{rox\_\-info\_\-win\_\-get\_\-extension\_\-area}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Gtk\-Widget$\ast$ rox\_\-info\_\-win\_\-get\_\-extension\_\-area ({\bf ROXInfo\-Win} $\ast$ {\em iw})}\label{infowin_8h_4645175ce185c2f5fa8b7d1797fa8f81}


Get pointer to a Gtk\-VBox between the default contents and the dialog area with the close button. Arbitrary content may be added here.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftrightarrow$} {\em iw}]a valid info window \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]pointer to a Gtk\-VBox \end{Desc}
\index{infowin.h@{infowin.h}!rox_info_win_get_type@{rox\_\-info\_\-win\_\-get\_\-type}}
\index{rox_info_win_get_type@{rox\_\-info\_\-win\_\-get\_\-type}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}GType rox\_\-info\_\-win\_\-get\_\-type (void)}\label{infowin_8h_5c3141f28041db75688b1865af3a8cf8}


Type code for an Info\-Win \index{infowin.h@{infowin.h}!rox_info_win_new@{rox\_\-info\_\-win\_\-new}}
\index{rox_info_win_new@{rox\_\-info\_\-win\_\-new}!infowin.h@{infowin.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Gtk\-Widget$\ast$ rox\_\-info\_\-win\_\-new (const gchar $\ast$ {\em program}, const gchar $\ast$ {\em purpose}, const gchar $\ast$ {\em version}, const gchar $\ast$ {\em author}, const gchar $\ast$ {\em website})}\label{infowin_8h_8da5fdb1ec1b7f2599f4e3af5b3bbfc5}


Construct an information window for the program.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[\mbox{$\leftarrow$} {\em program}]name of program \item[\mbox{$\leftarrow$} {\em purpose}]short description of program's function \item[\mbox{$\leftarrow$} {\em version}]string describing current version \item[\mbox{$\leftarrow$} {\em author}]name of author(s) \item[\mbox{$\leftarrow$} {\em website}]URL where to find more information or get new versions\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]pointer to a \doxyref{ROXInfo\-Win}{p.}{structROXInfoWin} object\end{Desc}
\begin{Desc}
\item[{\bf Deprecated}]Use \doxyref{rox\_\-info\_\-win\_\-new\_\-from\_\-appinfo()}{p.}{infowin_8c_e72cce77ca7fd12fb98db70c85d94e88} instead. \end{Desc}
