MGUI::FORM_HTML Class Reference

An HTML Control. More...

#include <mgui/html.h>

Inheritance diagram for MGUI::FORM_HTML:

[legend]

List of all members.

Public Types
typedef fastdelegate::FastDelegate < void(const MISTRING &href)>	DELEGATE_HYPERLINK
Public Member Functions
	FORM_HTML ()
	~FORM_HTML ()
void	Create (LAYOUT_PANE_BASE &ParentPane, int height, int width, LAYOUT_SIZEALIGN sizealign=LAYOUT_SIZEALIGN_Expand)
void	GetRenderedDocSize (int &height, int &width) const
void	GetTitle (MISTRING &title) const
void	Redraw ()
void	SetBackgroundColor (const COLOR &BgColor)
void	SetDelegateOnHyperLink (DELEGATE_HYPERLINK delegate)
void	SetMinimumSize (int height, int width)
void	SetValue (const FILEPATH &filepath)
void	SetValue (const MISTRING &value)

---

Detailed Description

An HTML Control.

This control is currently only implemented for X. An MFC version could probably be implemented if needed.

The control is based on the XmHTML widget which is very old and doesn't support any of the newer features that you'd find in a real browser (such as CSS, Javascript, etc).

---

Member Typedef Documentation

typedef fastdelegate::FastDelegate<void(const MISTRING& href)> MGUI::FORM_HTML::DELEGATE_HYPERLINK

---

Constructor & Destructor Documentation

MGUI::FORM_HTML::FORM_HTML

(

)

Constructor.

MGUI::FORM_HTML::~FORM_HTML

(

)

Destructor.

---

Member Function Documentation

void MGUI::FORM_HTML::Create	(	LAYOUT_PANE_BASE &	ParentPane,
		int	height,
		int	width,
		LAYOUT_SIZEALIGN	sizealign = LAYOUT_SIZEALIGN_Expand
	)

Parameters:

	height	Height in pixels
	width	Width in pixels

void MGUI::FORM_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::FORM_HTML::GetTitle

(

MISTRING &

title

)

const

Return the title of the HTML document being shown.

void MGUI::FORM_HTML::Redraw

(

)

Redraw.

void MGUI::FORM_HTML::SetBackgroundColor

(

const COLOR &

BgColor

)

Set the initial background color for this widget.

Default is COLOR::WHITE

void MGUI::FORM_HTML::SetDelegateOnHyperLink

(

DELEGATE_HYPERLINK

delegate

)

[inline]

Set delegate to call when user clicks on a link.

void MGUI::FORM_HTML::SetMinimumSize	(	int	height,
		int	width
	)

Parameters:

	height	Minimum height in pixels, -1 to leave unchanged
	width	Minimum width in pixels, -1 to leave unchanged

void MGUI::FORM_HTML::SetValue

(

const FILEPATH &

filepath

)

void MGUI::FORM_HTML::SetValue

(

const MISTRING &

value

)

---

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

• mgui/html.h