infowin.h File Reference

A GTK+ Widget to implement a RISC OS style info window. More...

#include <gdk/gdk.h>
#include <gtk/gtkdialog.h>
#include <gtk/gtkvbox.h>

Data Structures
struct	ROXInfoWin
	Definition of a ROXInfoWin widget. More...
struct	ROXInfoWinClass
Defines
#define	ROX_INFO_WIN(obj)   GTK_CHECK_CAST (obj, rox_info_win_get_type (), ROXInfoWin)
#define	ROX_INFO_WIN_CLASS(klass)   GTK_CHECK_CLASS_CAST (klass, rox_info_win_get_type (), ROXInfoWinClass)
#define	ROX_IS_INFO_WIN(obj)   GTK_CHECK_TYPE (obj, rox_info_win_get_type ())
#define	InfoWin   ROXInfoWin
#define	InfoWinClass   ROXInfoWinClass
Functions
GType	rox_info_win_get_type (void)
GtkWidget *	rox_info_win_new (const gchar *program, const gchar *purpose, const gchar *version, const gchar *author, const gchar *website)
void	rox_info_win_add_browser_command (ROXInfoWin *iw, const gchar *cmd)
GtkWidget *	rox_info_win_get_extension_area (ROXInfoWin *iw)
GtkWidget *	info_win_new (const gchar *program, const gchar *purpose, const gchar *version, const gchar *author, const gchar *website)
GtkWidget *	info_win_new_from_appinfo (const gchar *program)
void	info_win_add_browser_command (ROXInfoWin *iw, const gchar *cmd)

---

Detailed Description

A GTK+ Widget to implement a RISC OS style info window.

---

Define Documentation

#define InfoWin   ROXInfoWin

Deprecated:

Use ROXInfoWin

#define InfoWinClass   ROXInfoWinClass

Deprecated:

Use ROXInfoWinClass

#define ROX_INFO_WIN

(

obj

)

GTK_CHECK_CAST (obj, rox_info_win_get_type (), ROXInfoWin)

Cast object pointer to ROXInfoWin * or NULL if not a valid ROXInfoWin *

Parameters:

[in]

obj

pointer to object

Returns:

pointer to ROXInfoWin or NULL

#define ROX_INFO_WIN_CLASS

(

klass

)

GTK_CHECK_CLASS_CAST (klass, rox_info_win_get_type (), ROXInfoWinClass)

Cast class pointer to ROXInfoWinClass * or NULL if not a valid ROXInfoWinClass *

Parameters:

[in]

klass

pointer to class

Returns:

pointer to ROXInfoWinClass or NULL

#define ROX_IS_INFO_WIN

(

obj

)

GTK_CHECK_TYPE (obj, rox_info_win_get_type ())

Test if object is a ROXInfoWin

Parameters:

[in]

obj

pointer to object

Returns:

non-zero if argument points to a ROXInfoWin

---

Function Documentation

void info_win_add_browser_command	(	ROXInfoWin *	iw,
		const gchar *	cmd
	)

Deprecated:

As rox_info_win_add_browser_command().

GtkWidget* info_win_new	(	const gchar *	program,
		const gchar *	purpose,
		const gchar *	version,
		const gchar *	author,
		const gchar *	website
	)

Deprecated:

As rox_info_win_new() except that the window's delete_event signal is caught to turn closing the window into a hide

GtkWidget* info_win_new_from_appinfo

(

const gchar *

program

)

Deprecated:

As rox_info_win_new_from_appinfo() except that the window's delete_event signal is caught to turn closing the window into a hide

void rox_info_win_add_browser_command	(	ROXInfoWin *	iw,
		const gchar *	cmd
	)

Add a possible command for viewing a web page.

Parameters:

[in,out]	iw	a valid info window
[in]	cmd	command to add. It will be called with a single argument which is the URL to view

Deprecated:

Web sites are now viewed using rox_uri_launch() and commands added by this function are ignored.

GtkWidget* rox_info_win_get_extension_area

(

ROXInfoWin *

iw

)

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

Parameters:

[in,out]

iw

a valid info window

Returns:

pointer to a GtkVBox

GType rox_info_win_get_type

(

void

)

Type code for an InfoWin

GtkWidget* rox_info_win_new	(	const gchar *	program,
		const gchar *	purpose,
		const gchar *	version,
		const gchar *	author,
		const gchar *	website
	)

Construct an information window for the program.

Parameters:

[in]	program	name of program
[in]	purpose	short description of program's function
[in]	version	string describing current version
[in]	author	name of author(s)
[in]	website	URL where to find more information or get new versions

Returns:

pointer to a ROXInfoWin object

Deprecated:

Use rox_info_win_new_from_appinfo() instead.

---