XGP::HTMLViewer Class Reference

Helper class to display a HTML document in a dialog. More...

Inherits XGP::XDialog.

List of all members.

Classes
class	CreateError
Public Types
enum	widgetTypes { GTKHTML, GTKMOZEMBED, WEBKIT, LAST }
Public Member Functions
virtual	~HTMLViewer ()
void	display (const std::string &file)
Static Public Member Functions
static HTMLViewer *	create (const std::string &file, const Glib::ustring &title, widgetTypes type) throw (CreateError)
Protected Member Functions
	HTMLViewer (const std::string &file, const Glib::ustring &title, widgetTypes type) throw (CreateError)

---

Detailed Description

Helper class to display a HTML document in a dialog.

Uses GTKHTML or GtkMozEmbed to display the HTML code.

---

Member Enumeration Documentation

enum XGP::HTMLViewer::widgetTypes

Supported widgets to display HTML.

---

Constructor & Destructor Documentation

XGP::HTMLViewer::~HTMLViewer

(

)

[virtual]

Destructor.

XGP::HTMLViewer::HTMLViewer	(	const std::string &	file,
		const Glib::ustring &	title,
		widgetTypes	type
	)			throw (CreateError) [protected]

Creates a dialog displaying a HTML-document.

Parameters:

	file	File containing the HTML-document to display
	title	Title of help-window
	type	Type of control to create

Exceptions:

CreateError

in case of error

---

Member Function Documentation

HTMLViewer * XGP::HTMLViewer::create	(	const std::string &	file,
		const Glib::ustring &	title,
		widgetTypes	type
	)			throw (CreateError) [static]

Creates (or updates) a dialog displaying a HTML-document.

Parameters:

	file	File containing the HTML-document to display
	title	Title of help-window
	type	Type of control to create

Returns:

HTMLViewer* Pointer to the created dialog

Exceptions:

CreateError

in case of error

void XGP::HTMLViewer::display

(

const std::string &

file

)

Sets the HTML-document to display in the dialog.

Parameters:

file

File containing the HTML-document to display

---

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

• HTMLViewer.h
• HTMLViewer.cpp