wx.Html.Help.HtmlHelpController Class Reference

Inheritance diagram for wx.Html.Help.HtmlHelpController:

List of all members.

Public Types
enum	Style
Public Member Functions
bool	AddBook (wxString book_url)
bool	AddBook (string book_url)
bool	Display (int id)
bool	Display (wxString x)
bool	Display (string x)
bool	DisplayContents ()
bool	DisplayIndex ()
	HtmlHelpController (Style style)
	HtmlHelpController ()
	HtmlHelpController (IntPtr wxObject)
bool	KeywordSearch (wxString keyword, HelpSearchMode mode)
bool	KeywordSearch (string keyword, HelpSearchMode mode)
bool	KeywordSearch (string keyword)
void	OnCloseFrame (CloseEvent evt)
void	ReadCustomization (Config cfg, wxString path)
void	ReadCustomization (Config cfg, string path)
void	ReadCustomization (Config cfg)
void	UseConfig (Config config, wxString rootpath)
void	UseConfig (Config config, string rootpath)
void	UseConfig (Config config)
void	WriteCustomization (Config cfg, wxString path)
void	WriteCustomization (Config cfg, string path)
void	WriteCustomization (Config cfg)
Static Public Member Functions
static HtmlHelpController	GetSingleton ()
static HtmlHelpController	SetInstance (Style style)
static HtmlHelpController	SetInstance (HtmlHelpController newSingleton)
Properties
Frame	Frame [get]
string	TempDir [set]
string	TitleFormat [set]

---

Detailed Description

The help controller.

---

Member Enumeration Documentation

enum wx::Html::Help::HtmlHelpController::Style

Some style flags for the HtmlHelpController.

Enumerator:

StaticNumberOfColumns	The number of columns os fixed and cannot be changed. This is the default.
DynamicNumberOfColumns	The number of columns can change. Models using this style shall add a handler of the ColumnPropertyCollection.OnChanging event.
StaticNumberOfRows	The number of rows os fixed and cannot be changed. This is the default.
DynamicNumberOfRows	The number of rows can change. Models using this style shall add a handler of the RowPropertyCollection.OnChanging event.
List
Choice
TOOLBAR
CONTENTS
INDEX
SEARCH
BOOKMARKS
OPEN_FILES
PRINT
FLAT_TOOLBAR
MERGE_BOOKS
ICONS_BOOK
ICONS_BOOK_CHAPTER
ICONS_FOLDER	this is 0 since it is default
DEFAULT_STYLE

---

Constructor & Destructor Documentation

wx.Html.Help.HtmlHelpController.HtmlHelpController

(

IntPtr

wxObject

)

wx.Html.Help.HtmlHelpController.HtmlHelpController

(

)

wx.Html.Help.HtmlHelpController.HtmlHelpController

(

Style

style

)

---

Member Function Documentation

bool wx.Html.Help.HtmlHelpController.AddBook

(

wxString

book_url

)

Adds the book at the provided file name. In contrast to the wxWidgets version, this method silently installs the wx file handler for zip file entries. The file system is currently not wrapped since the .NET framework implements most of the provided functions. However, handling of zip-archives is required to deal with hyper text books (HTB), so this ability will be installed on using it.

bool wx.Html.Help.HtmlHelpController.AddBook

(

string

book_url

)

Adds the book at the provided file name. In contrast to the wxWidgets version, this method silently installs the wx file handler for zip file entries. The file system is currently not wrapped since the .NET framework implements most of the provided functions. However, handling of zip-archives is required to deal with hyper text books (HTB), so this ability will be installed on using it.

bool wx.Html.Help.HtmlHelpController.Display

(

int

id

)

This alternative form is used to search help contents by numeric IDs.

Parameters:

id

ID of a help context

Returns:

bool wx.Html.Help.HtmlHelpController.Display

(

wxString

x

)

Displays page x. This is THE important function - it is used to display the help in application.

You can specify the page in many ways:

• as direct filename of HTML document
• as chapter name (from contents) or as a book name
• as some word from index
• even as any word (will be searched)

Looking for the page runs in these steps:

• try to locate file named x (if x is for example "doc/howto.htm")
• try to open starting page of book named x
• try to find x in contents (if x is for example "How To ...")
• try to find x in index (if x is for example "How To ...")
• switch to Search panel and start searching >

  Parameters:

  x

  Returns:

bool wx.Html.Help.HtmlHelpController.Display

(

string

x

)

Displays page x. This is THE important function - it is used to display the help in application.

You can specify the page in many ways:

• as direct filename of HTML document
• as chapter name (from contents) or as a book name
• as some word from index
• even as any word (will be searched)

Looking for the page runs in these steps:

• try to locate file named x (if x is for example "doc/howto.htm")
• try to open starting page of book named x
• try to find x in contents (if x is for example "How To ...")
• try to find x in index (if x is for example "How To ...")
• switch to Search panel and start searching >

  Parameters:

  x

  Returns:

bool wx.Html.Help.HtmlHelpController.DisplayContents

(

)

Display the table of contents.

Returns:

bool wx.Html.Help.HtmlHelpController.DisplayIndex

(

)

Display the "Index" page.

Returns:

static HtmlHelpController wx.Html.Help.HtmlHelpController.GetSingleton

(

)

[static]

Returns the singleton. If you call this for the first time, this will create a singleton of default style.

bool wx.Html.Help.HtmlHelpController.KeywordSearch	(	wxString	keyword,
		HelpSearchMode	mode
	)

Displays help window, focuses search panel and starts searching. Returns true if the keyword was found. Optionally it searches through the index (mode = wxHELP_SEARCH_INDEX), default the content (mode = wxHELP_SEARCH_ALL).

Important: KeywordSearch searches only pages listed in .hhc file(s). You should list all pages in the contents file.

Parameters:

keyword

The keyword that this method will search for.

Returns:

bool wx.Html.Help.HtmlHelpController.KeywordSearch	(	string	keyword,
		HelpSearchMode	mode
	)

Displays help window, focuses search panel and starts searching. Returns true if the keyword was found. Optionally it searches through the index (mode = wxHELP_SEARCH_INDEX), default the content (mode = wxHELP_SEARCH_ALL).

Important: KeywordSearch searches only pages listed in .hhc file(s). You should list all pages in the contents file.

Parameters:

keyword

The keyword that this method will search for.

Returns:

bool wx.Html.Help.HtmlHelpController.KeywordSearch

(

string

keyword

)

Displays help window, focuses search panel and starts searching. Returns true if the keyword was found. This will search for occurances of the keyword in the content if help pages.

Important: KeywordSearch searches only pages listed in .hhc file(s). You should list all pages in the contents file.

Parameters:

keyword

The keyword that this method will search for.

Returns:

void wx.Html.Help.HtmlHelpController.OnCloseFrame

(

CloseEvent

evt

)

void wx.Html.Help.HtmlHelpController.ReadCustomization	(	Config	cfg,
		wxString	path
	)

void wx.Html.Help.HtmlHelpController.ReadCustomization	(	Config	cfg,
		string	path
	)

void wx.Html.Help.HtmlHelpController.ReadCustomization

(

Config

cfg

)

static HtmlHelpController wx.Html.Help.HtmlHelpController.SetInstance

(

Style

style

)

[static]

Sets the singleton. If a singleton already exists, this will be replaced.

Parameters:

newSingleton

The new singleton will be an instance of this style.

Returns:

If this call replaces an existing singleton, the old singleton will be returned. This is null otherwise.

static HtmlHelpController wx.Html.Help.HtmlHelpController.SetInstance

(

HtmlHelpController

newSingleton

)

[static]

Sets the singleton. If a singleton already exists, this will be replaced.

Parameters:

newSingleton

The instance that shall become the new singleton.

Returns:

If this call replaces an existing singleton, the old singleton will be returned. This is null otherwise.

void wx.Html.Help.HtmlHelpController.UseConfig	(	Config	config,
		wxString	rootpath
	)

void wx.Html.Help.HtmlHelpController.UseConfig	(	Config	config,
		string	rootpath
	)

void wx.Html.Help.HtmlHelpController.UseConfig

(

Config

config

)

void wx.Html.Help.HtmlHelpController.WriteCustomization	(	Config	cfg,
		wxString	path
	)

void wx.Html.Help.HtmlHelpController.WriteCustomization	(	Config	cfg,
		string	path
	)

void wx.Html.Help.HtmlHelpController.WriteCustomization

(

Config

cfg

)

---

Property Documentation

Frame wx.Html.Help.HtmlHelpController.Frame [get]

string wx.Html.Help.HtmlHelpController.TempDir [set]

Write-only property to set the directory for temporary files (option for better performance).

string wx.Html.Help.HtmlHelpController.TitleFormat [set]

This property is for writing only and set the title format.

---