wx.Html.HtmlWindow Class Reference

Inheritance diagram for wx.Html.HtmlWindow:

List of all members.

Public Member Functions
override bool	AcceptsFocusFromKeyboard ()
void	AddProcessor (HtmlProcessor processor)
bool	AppendToPage (wxString source)
bool	AppendToPage (string source)
new bool	Create (Window parent, int id, Point pos, Size size, wx.WindowStyles style, wxString name)
new bool	Create (Window parent, int id, Point pos, Size size, wx.WindowStyles style, string name)
bool	HistoryBack ()
bool	HistoryCanBack ()
bool	HistoryCanForward ()
void	HistoryClear ()
bool	HistoryForward ()
	HtmlWindow (Window parent, Point pos, Size size, wx.WindowStyles style, string name)
	HtmlWindow (Window parent, Point pos, Size size, wx.WindowStyles style)
	HtmlWindow (Window parent, Point pos, Size size)
	HtmlWindow (Window parent, Point pos)
	HtmlWindow (Window parent)
	HtmlWindow (Window parent, int id, Point pos, Size size, wx.WindowStyles style, string name)
	HtmlWindow (Window parent, int id, Point pos, Size size, wx.WindowStyles style)
	HtmlWindow (Window parent, int id, Point pos, Size size)
	HtmlWindow (Window parent, int id, Point pos)
	HtmlWindow (Window parent, int id)
	HtmlWindow ()
	HtmlWindow (IntPtr wxObject)
virtual bool	LoadFile (wxString filename)
virtual bool	LoadFile (string filename)
virtual bool	LoadPage (wxString location)
virtual bool	LoadPage (string location)
virtual bool	OnCellClicked (HtmlCell cell, int x, int y, MouseEvent evt)
virtual void	OnCellMouseHover (HtmlCell cell, int x, int y)
virtual void	OnLinkClicked (HtmlLinkInfo link)
virtual HtmlOpeningStatus	OnOpeningURL (HtmlURLType type, string url, string redirect)
virtual void	OnSetTitle (string title)
bool	OpenFindDialog (FindReplaceData data)
virtual void	ReadCustomization (Config cfg, string path)
virtual void	ReadCustomization (Config cfg)
void	ScrollToCell (HtmlCell cell)
void	SelectAll ()
void	SelectCell (HtmlCell cell)
void	SelectLine (Point pos)
void	SelectWord (Point pos)
void	SetFonts (wxString normal_face, wxString fixed_face, int[] sizes)
void	SetFonts (string normal_face, string fixed_face, int[] sizes)
bool	SetPage (wxString source)
bool	SetPage (string source)
void	SetRelatedFrame (Frame frame, wxString format)
void	SetRelatedFrame (Frame frame, string format)
virtual void	WriteCustomization (Config cfg, string path)
void	WriteCustomization (Config cfg)
Static Public Member Functions
static void	AddGlobalProcessor (HtmlProcessor processor)
Properties
int	Borders [set]
HtmlFindDialog	FindDialog [get]
bool	HasSelection [get]
HtmlContainerCell	InternalRepresentation [get]
string	OpenedAnchor [get]
string	OpenedPage [get]
string	OpenedPageTitle [get]
HtmlWinParser	Parser [get]
Frame	RelatedFrame [get, set]
int	RelatedStatusBar [set]
InfoOnSelection	SelectionInfo [get]
string	SelectionText [get]
string	Text [get]
int	Version [get]
Classes
class	InfoOnSelection

---

Detailed Description

A window displaying (reduced) HTML formatted text.

---

Constructor & Destructor Documentation

wx.Html.HtmlWindow.HtmlWindow

(

IntPtr

wxObject

)

wx.Html.HtmlWindow.HtmlWindow

(

)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		int	id
	)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		int	id,
		Point	pos
	)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		int	id,
		Point	pos,
		Size	size
	)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		int	id,
		Point	pos,
		Size	size,
		wx.WindowStyles	style
	)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		int	id,
		Point	pos,
		Size	size,
		wx.WindowStyles	style,
		string	name
	)

wx.Html.HtmlWindow.HtmlWindow

(

Window

parent

)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		Point	pos
	)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		Point	pos,
		Size	size
	)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		Point	pos,
		Size	size,
		wx.WindowStyles	style
	)

wx.Html.HtmlWindow.HtmlWindow	(	Window	parent,
		Point	pos,
		Size	size,
		wx.WindowStyles	style,
		string	name
	)

---

Member Function Documentation

override bool wx.Html.HtmlWindow.AcceptsFocusFromKeyboard

(

)

[virtual]

can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it

Reimplemented from wx.Window.

static void wx.Html.HtmlWindow.AddGlobalProcessor

(

HtmlProcessor

processor

)

[static]

void wx.Html.HtmlWindow.AddProcessor

(

HtmlProcessor

processor

)

bool wx.Html.HtmlWindow.AppendToPage

(

wxString

source

)

This will append string source to the currently displayed text.

bool wx.Html.HtmlWindow.AppendToPage

(

string

source

)

This will append string source to the currently displayed text.

new bool wx.Html.HtmlWindow.Create	(	Window	parent,
		int	id,
		Point	pos,
		Size	size,
		wx.WindowStyles	style,
		wxString	name
	)

Do not forget to use style wx.WindowStyles.TAB_TRAVERSAL if you want this panel to be traversal.

Reimplemented from wx.Panel.

new bool wx.Html.HtmlWindow.Create	(	Window	parent,
		int	id,
		Point	pos,
		Size	size,
		wx.WindowStyles	style,
		string	name
	)

Do not forget to use style wx.WindowStyles.TAB_TRAVERSAL if you want this panel to be traversal.

Reimplemented from wx.Panel.

bool wx.Html.HtmlWindow.HistoryBack

(

)

bool wx.Html.HtmlWindow.HistoryCanBack

(

)

bool wx.Html.HtmlWindow.HistoryCanForward

(

)

void wx.Html.HtmlWindow.HistoryClear

(

)

bool wx.Html.HtmlWindow.HistoryForward

(

)

virtual bool wx.Html.HtmlWindow.LoadFile

(

wxString

filename

)

[virtual]

Overload this to change the behaviour on loading a file. The argument is a file name in native style.

virtual bool wx.Html.HtmlWindow.LoadFile

(

string

filename

)

[virtual]

Overload this to change the behaviour on loading a file. The argument is a file name in native style.

virtual bool wx.Html.HtmlWindow.LoadPage

(

wxString

location

)

[virtual]

Overload this to change the behaviour on loading a page from the designated location. Refer to FSFile and FileSystemHandler for remarks on available locations.

virtual bool wx.Html.HtmlWindow.LoadPage

(

string

location

)

[virtual]

Overload this to change the behaviour on loading a page from the designated location. Refer to FSFile and FileSystemHandler for remarks on available locations.

virtual bool wx.Html.HtmlWindow.OnCellClicked	(	HtmlCell	cell,
		int	x,
		int	y,
		MouseEvent	evt
	)			[virtual]

This is called when the user clicks at a particular cell.

virtual void wx.Html.HtmlWindow.OnCellMouseHover	(	HtmlCell	cell,
		int	x,
		int	y
	)			[virtual]

This will be called when the mouse is moved over the cell.

virtual void wx.Html.HtmlWindow.OnLinkClicked

(

HtmlLinkInfo

link

)

[virtual]

This is called when the user clicks on a cell representing a hyper link.

virtual HtmlOpeningStatus wx.Html.HtmlWindow.OnOpeningURL	(	HtmlURLType	type,
		string	url,
		string	redirect
	)			[virtual]

virtual void wx.Html.HtmlWindow.OnSetTitle

(

string

title

)

[virtual]

bool wx.Html.HtmlWindow.OpenFindDialog

(

FindReplaceData

data

)

This will open a find dialog for the current HTML page. The result will be true in case of success and false in case of any problem. This method will fail to open the dialog if it is already open.

Cf. wx.HtmlWindow.FindDialog and HtmlFindDialog.

virtual void wx.Html.HtmlWindow.ReadCustomization	(	Config	cfg,
		string	path
	)			[virtual]

The HTML window is able to configure several properties. You may read from a particular configuration to reuse settings that have been done on previous runs of the appliation. Cf. WriteCustomization().

virtual void wx.Html.HtmlWindow.ReadCustomization

(

Config

cfg

)

[virtual]

The HTML window is able to configure several properties. You may read from a particular configuration to reuse settings that have been done on previous runs of the appliation. Cf. WriteCustomization().

void wx.Html.HtmlWindow.ScrollToCell

(

HtmlCell

cell

)

This will scroll to the position of the provided cell. Equivalent to

 this.Scroll(cell.AbsPos) 

.

void wx.Html.HtmlWindow.SelectAll

(

)

This will select the whole text.

void wx.Html.HtmlWindow.SelectCell

(

HtmlCell

cell

)

This will select the content of the provided cell. Note, that the provided cell may be a formatting cell. So, you might see nothing of the selection.

Please also note, that this method will not scroll the window to the selected cell. Call ScrollToCell() for this purpose.

void wx.Html.HtmlWindow.SelectLine

(

Point

pos

)

This will select a line in the text. Please note, that this method will not scroll to the selected word. Call wx.Window.Scroll().

void wx.Html.HtmlWindow.SelectWord

(

Point

pos

)

This will select a word that is displayed at the provided position. Please note, that this method will not scroll to the selected word. Call wx.Window.Scroll().

void wx.Html.HtmlWindow.SetFonts	(	wxString	normal_face,
		wxString	fixed_face,
		int[]	sizes
	)

void wx.Html.HtmlWindow.SetFonts	(	string	normal_face,
		string	fixed_face,
		int[]	sizes
	)

bool wx.Html.HtmlWindow.SetPage

(

wxString

source

)

This will set a new HTML text to be displayed.

Parameters:

source

The HTML source code that shall be displayed.

bool wx.Html.HtmlWindow.SetPage

(

string

source

)

This will set a new HTML text to be displayed.

Parameters:

source

The HTML source code that shall be displayed.

void wx.Html.HtmlWindow.SetRelatedFrame	(	Frame	frame,
		wxString	format
	)

Sets the related frame. This window will change the title of the related frame according to the title definition of the displayed HTML text.

void wx.Html.HtmlWindow.SetRelatedFrame	(	Frame	frame,
		string	format
	)

Sets the related frame. This window will change the title of the related frame according to the title definition of the displayed HTML text.

Sample:

         m_html.SetRelatedFrame(this, "HTML: %s");

This will display the title according to the displayed HTML page plus a prefix "HTML:"

virtual void wx.Html.HtmlWindow.WriteCustomization	(	Config	cfg,
		string	path
	)			[virtual]

The HTML window is able to configure several properties. You may read from a particular configuration to reuse settings that have been done on previous runs of the appliation. Cf. ReadCustomization().

void wx.Html.HtmlWindow.WriteCustomization

(

Config

cfg

)

The HTML window is able to configure several properties. You may read from a particular configuration to reuse settings that have been done on previous runs of the appliation. Cf. ReadCustomization().

---

Property Documentation

int wx.Html.HtmlWindow.Borders [set]

HtmlFindDialog wx.Html.HtmlWindow.FindDialog [get]

This is a new feature explusive to wx.NET: A search dialog for searching the presented HTML page. This will read the dialog and create one if this has not yet been created. You may alteratively use ShowFindDialog() to show the dialog with particular data.

bool wx.Html.HtmlWindow.HasSelection [get]

This is true if the window knows a selection.

HtmlContainerCell wx.Html.HtmlWindow.InternalRepresentation [get]

Use this to gain access to the internal representation of the displayed HTML text. HTML is displayed as a tree of cells where the container cell represends a node with occasionally more than one sibling.

string wx.Html.HtmlWindow.OpenedAnchor [get]

string wx.Html.HtmlWindow.OpenedPage [get]

HTML text displayed by this window.

string wx.Html.HtmlWindow.OpenedPageTitle [get]

HtmlWinParser wx.Html.HtmlWindow.Parser [get]

Frame wx.Html.HtmlWindow.RelatedFrame [get, set]

Set or gets the related frame. This window will change the title of the related frame according to the title definition of the displayed HTML text. This will simply use "%s" as format for the related frame.

int wx.Html.HtmlWindow.RelatedStatusBar [set]

InfoOnSelection wx.Html.HtmlWindow.SelectionInfo [get]

Returns a new instance providing information in the current selection. The result will be null if nothing is selected.

string wx.Html.HtmlWindow.SelectionText [get]

This is the selected part of the HTML

string wx.Html.HtmlWindow.Text [get]

This is the displayed HTML as text.

int wx.Html.HtmlWindow.Version [get]

This will be incremented whenver the displayed document changes.

---