---

help_controller Class Reference

A class to manage displaying of online help. More...

#include <help_controller.h>

Inheritance diagram for help_controller:

List of all members.

Public Methods
	help_controller ()
	Constructor.
	~help_controller ()
	Destructor.
void	add_book (const wxString &help_fullname)
	Adds a specified "book" (.htb file) to the help controller.
void	show_help_topic (const wxString &topic)
	Shows the specified help topic.
void	show_help ()
	Shows the help frame, with no topics initially selected.
void	search_help (wxWindow *parent)
	Search help for a keyword, and display results.
void	close ()
	Closes the help (frame), but doesn't delete the help controller.
Static Public Methods
help_controller *	get (bool create_on_demand=TRUE)
	Gets the global object or creates one if none exists.
help_controller *	set (help_controller *desired_help_controller)
	Sets the global object and returns a pointer to previous one (may be NULL).

---

Detailed Description

A class to manage displaying of online help.

---

Constructor & Destructor Documentation

help_controller::help_controller (    )

Constructor. Parameters: parent  Parent window of the help controller.

---

Member Function Documentation

void help_controller::add_book (  const wxString &    help_fullname )

Adds a specified "book" (.htb file) to the help controller. Also error handles if something went wrong. Parameters: help_fullname  The fullname of the .htb file to add.

void help_controller::close (    )

Closes the help (frame), but doesn't delete the help controller. Deletion of the whole help controller is done via module. The frame is destroyed by the base class wxHelpHelpController

help_controller* help_controller::get (  bool    create_on_demand = TRUE )  [static]

Gets the global object or creates one if none exists. Parameters: create_on_demand  TRUE to create if not exist. Otherwise don't create one [useful if you just want to get() to close it.]

void help_controller::search_help (  wxWindow *    parent )

Search help for a keyword, and display results. Prompts for a text to search for via a text entry dialog, then shows help controller selected to the search tab. It starts searching help, and displays the pages containing that phrase in the display window. Parameters: parent  Parent window of the help controller.

help_controller* help_controller::set (  help_controller *    desired_help_controller )  [static]

Sets the global object and returns a pointer to previous one (may be NULL). Parameters: desired_help_controller  The new help_controller.

void help_controller::show_help (    )

Shows the help frame, with no topics initially selected. Parameters: parent  Parent window of the help controller.

void help_controller::show_help_topic (  const wxString &    topic )

Shows the specified help topic. Parameters: parent  Parent window of the help controller. topic  The topic to be shown.