MGUI::DLG_HTML Class Reference

A Simple HTML viewer window. More...

#include <mgui/html.h>

Inheritance diagram for MGUI::DLG_HTML:

[legend]

List of all members.

Public Types
enum	STYLE { STYLE_None = 0x00000000, STYLE_ShowAddressBar = 0x00000001, STYLE_ShowToolBar = 0x00000002, STYLE_AllLinksToExternalBrowser = 0x00000004 }
Public Member Functions
	DLG_HTML (STYLE style=STYLE_None)
virtual	~DLG_HTML ()
void	GetRenderedDocSize (int &height, int &width) const
void	SetDelegateOnHyperLink (FORM_HTML::DELEGATE_HYPERLINK delegate)
void	SetSize (INT32 height, INT32 width)
void	SetURL (const MISTRING &url)
void	SetValue (const MISTRING &value)
void	SetValue (const FILEPATH &filepath)

---

Detailed Description

A Simple HTML viewer window.

---

Member Enumeration Documentation

enum MGUI::DLG_HTML::STYLE

Style settings, may be combined.

Enumerator:

STYLE_None
STYLE_ShowAddressBar
STYLE_ShowToolBar
STYLE_AllLinksToExternalBrowser

Reimplemented from MGUI::DLGSHELL.

---

Constructor & Destructor Documentation

MGUI::DLG_HTML::DLG_HTML

(

STYLE

style = STYLE_None

)

virtual MGUI::DLG_HTML::~DLG_HTML

(

)

[virtual]

---

Member Function Documentation

void MGUI::DLG_HTML::GetRenderedDocSize	(	int &	height,
		int &	width
	)			const

Gets the height and width of the area that the htmldoc has used for rendering.

Note: the layout must already be rendered to call this.

Parameters:

width

height returned width returned;

void MGUI::DLG_HTML::SetDelegateOnHyperLink

(

FORM_HTML::DELEGATE_HYPERLINK

delegate

)

Set delegate to call when user clicks on a link.

By default, all links to a local html file or to an external url which produces a document type of text/html will open in this window. The STYLE_AllLinkstoExternalBrowser flag changes this. NOTE: if you call this, you must do so BEFORE opening the window

void MGUI::DLG_HTML::SetSize	(	INT32	height,
		INT32	width
	)

Set the initial size in pixels.

void MGUI::DLG_HTML::SetURL

(

const MISTRING &

url

)

void MGUI::DLG_HTML::SetValue

(

const MISTRING &

value

)

void MGUI::DLG_HTML::SetValue

(

const FILEPATH &

filepath

)

---

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

• mgui/html.h