// Purpose: interface of wxHelpController
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
The following help controller classes are defined:
- wxWinHelpController, for controlling Windows Help.
- wxCHMHelpController, for controlling MS HTML Help. To use this, you need to
- set wxUSE_MS_HTML_HELP to 1 in setup.h and have htmlhelp.h header from
- Microsoft's HTML Help kit (you don't need VC++ specific htmlhelp.lib
+ set wxUSE_MS_HTML_HELP to 1 in setup.h and have the htmlhelp.h header from
+ Microsoft's HTML Help kit. (You don't need the VC++-specific htmlhelp.lib
because wxWidgets loads necessary DLL at runtime and so it works with all
- compilers).
+ compilers.)
- wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime
is not available, wxHtmlHelpController. You need to provide @b both CHM and
HTB versions of the help file. For wxMSW only.
@param newFrameEachTime
@true if a new frame is drawn with each invocation.
*/
- virtual wxFrame* GetFrameParameters(const wxSize* size = NULL,
- const wxPoint* pos = NULL,
+ virtual wxFrame* GetFrameParameters(wxSize* size = NULL,
+ wxPoint* pos = NULL,
bool* newFrameEachTime = NULL);
/**
wxHtmlHelpController ignores this call.
*/
- virtual bool LoadFile(const wxString& file = "");
+ virtual bool LoadFile(const wxString& file = wxEmptyString);
/**
Overridable member called when this application's viewer is quit by the user.
This does not work for all help controllers.
*/
- virtual bool OnQuit();
+ virtual void OnQuit();
/**
If the viewer is running, quits it by disconnecting.
virtual bool Quit();
/**
- For wxHtmlHelpController, the title is set (again with %s indicating the
+ For wxHtmlHelpController, the title is set (with %s indicating the
page title) and also the size and position of the frame if the frame is
already open. @a newFrameEachTime is ignored.