/////////////////////////////////////////////////////////////////////////////
// Name: help.h
-// Purpose: documentation for wxHelpController class
+// Purpose: interface of wxHelpController
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
The default browser is Netscape Navigator. The 'help' sample shows its use.
wxWinceHelpController, for controlling a simple @c .htm help controller for
Windows CE applications.
- wxHtmlHelpController, a sophisticated help controller using wxHTML, in
+ wxHtmlHelpController, a sophisticated help controller using wxHTML(), in
a similar style to the Microsoft HTML Help viewer and using some of the same
files.
Although it has an API compatible with other help controllers, it has more
@library{wxbase}
@category{help}
- @seealso
- wxHtmlHelpController, wxHTML
+ @see wxHtmlHelpController, wxHTML()
*/
class wxHelpController : public wxObject
{
@e WinHelp, MS HTML Help @a sectionNo is a context id.
@e External HTML help: wxExtHelpController implements @a sectionNo as an id in
a map file, which is of the form:
-
+
@e wxHtmlHelpController: @a sectionNo is an identifier as specified in the @c
.hhc file. See @ref overview_helpformat "Help files format".
See also the help sample for notes on how to specify section numbers for
wxHtmlHelpController returns the frame, size and position.
For all other help controllers, this function does nothing
and just returns @NULL.
-
+
@param viewer
This defaults to "netscape" for wxExtHelpController.
@param flags
used
by wxCHMHelpController, wxWinHelpController and wxHtmlHelpController.
*/
- virtual wxWindow* GetParentWindow();
+ virtual wxWindow* GetParentWindow() const;
//@{
/**
*/
virtual void SetViewer(const wxString& viewer, long flags);
};
+