wx.Html.HtmlWindowWithSearch Class Reference

Inheritance diagram for wx.Html.HtmlWindowWithSearch:

List of all members.

Public Member Functions
new void	Create (Window parent, int id, Point pos, Size size, wx.WindowStyles style, string name)
void	FindNext (string searchString)
	HtmlWindowWithSearch (Window parent, int id, Point pos, Size size, wx.WindowStyles style, string name)
	HtmlWindowWithSearch (Window parent, Point pos, Size size, wx.WindowStyles style, string name)
	HtmlWindowWithSearch (Window parent, Point pos, Size size, wx.WindowStyles style)
	HtmlWindowWithSearch (Window parent, Point pos, Size size)
	HtmlWindowWithSearch (Window parent, Point pos)
	HtmlWindowWithSearch (Window parent)
	HtmlWindowWithSearch ()
void	ShowSearchPanel (bool showOrHide, bool pickCurrentSelection)
void	ShowSearchPanel (bool showOrHide)
void	ToggleSearchPanel ()
Public Attributes
Colour	TextBgOnCompletedSearch
Colour	TextBgOnError
Protected Member Functions
virtual HtmlWindow	CreateHtmlWindow ()
Properties
HtmlWindow	Html [get]
bool	IsSearchPanelShown [get]

---

Constructor & Destructor Documentation

wx.Html.HtmlWindowWithSearch.HtmlWindowWithSearch

(

)

This is for two step construction.

wx.Html.HtmlWindowWithSearch.HtmlWindowWithSearch

(

Window

parent

)

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

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

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

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

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

---

Member Function Documentation

new void wx.Html.HtmlWindowWithSearch.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.

virtual HtmlWindow wx.Html.HtmlWindowWithSearch.CreateHtmlWindow

(

)

[protected, virtual]

You may overload this if you want to have a specialization of this class dealing with specific HTML windows. The result mus have this as parent.

void wx.Html.HtmlWindowWithSearch.FindNext

(

string

searchString

)

void wx.Html.HtmlWindowWithSearch.ShowSearchPanel	(	bool	showOrHide,
		bool	pickCurrentSelection
	)

This will show or hide the search panel. Run with true to show and with false to hide the search panel.

Parameters:

pickCurrentSelection

will cause this method with true to initialize the search text with the current selection.

void wx.Html.HtmlWindowWithSearch.ShowSearchPanel

(

bool

showOrHide

)

This will show or hide the search panel. Run with true to show and with false to hide the search panel.

This will initialize the search text with the current selection of the search panel becomes visible because of this method call.

void wx.Html.HtmlWindowWithSearch.ToggleSearchPanel

(

)

Changes visibility of the internal search panel.

---

Member Data Documentation

Colour wx.Html.HtmlWindowWithSearch.TextBgOnCompletedSearch

Background of the search text will switch to this colour if all occurances of the search text have been found but the search can be restarted.

Colour wx.Html.HtmlWindowWithSearch.TextBgOnError

Background of the search text will switch to this colour if the specified text cannot be found.

---

Property Documentation

HtmlWindow wx.Html.HtmlWindowWithSearch.Html [get]

This is the encapsulated HTML window.

bool wx.Html.HtmlWindowWithSearch.IsSearchPanelShown [get]

True iff the integrated search panel is shown.

---