wx.Html.Help.HtmlSearchStatus Class Reference

Inheritance diagram for wx.Html.Help.HtmlSearchStatus:

List of all members.

Public Member Functions
	HtmlSearchStatus (HtmlHelpData data, wxString keyword, bool searchCaseSensitive, bool searchWholeWords, wxString book)
	HtmlSearchStatus (HtmlHelpData data, string keyword, bool searchCaseSensitive, bool searchWholeWords, string book)
	HtmlSearchStatus (HtmlHelpData data, string keyword, bool searchCaseSensitive, bool searchWholeWords)
bool	Search ()
Properties
HtmlHelpDataItem	Current [get]
int	CurrentIndex [get]
bool	IsActive [get]
int	MaxIndex [get]
string	Name [get]

---

Detailed Description

State information of a search action. Note: This is about searching for pages containing a particular text rather than searching a single page.

---

Constructor & Destructor Documentation

wx.Html.Help.HtmlSearchStatus.HtmlSearchStatus	(	HtmlHelpData	data,
		string	keyword,
		bool	searchCaseSensitive,
		bool	searchWholeWords
	)

Constructor: Supply HtmlHelpData instance, the keyword and (optionally) the title of the book to search. By default, all books are searched.

wx.Html.Help.HtmlSearchStatus.HtmlSearchStatus	(	HtmlHelpData	data,
		string	keyword,
		bool	searchCaseSensitive,
		bool	searchWholeWords,
		string	book
	)

Constructor: Supply HtmlHelpData instance, the keyword and (optionally) the title of the book to search. By default, all books are searched.

wx.Html.Help.HtmlSearchStatus.HtmlSearchStatus	(	HtmlHelpData	data,
		wxString	keyword,
		bool	searchCaseSensitive,
		bool	searchWholeWords,
		wxString	book
	)

---

Member Function Documentation

bool wx.Html.Help.HtmlSearchStatus.Search

(

)

do the next iteration.

---

Property Documentation

HtmlHelpDataItem wx.Html.Help.HtmlSearchStatus.Current [get]

int wx.Html.Help.HtmlSearchStatus.CurrentIndex [get]

bool wx.Html.Help.HtmlSearchStatus.IsActive [get]

int wx.Html.Help.HtmlSearchStatus.MaxIndex [get]

string wx.Html.Help.HtmlSearchStatus.Name [get]

---