// Name: help.h
// Purpose: interface of wxHelpController
// Author: wxWidgets team
-// RCS-ID: $Id$
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
See also the help sample for notes on how to specify section numbers for
various help file formats.
*/
- virtual bool DisplaySection(int sectionNo) = 0;;
+ virtual bool DisplaySection(int sectionNo) = 0;
/**
Displays the text in a popup window, if possible.
virtual bool Quit() = 0;
/**
- 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.
+ Set the parameters of the frame window.
+
+ For wxHtmlHelpController, @a titleFormat specifies the title string
+ format (with @c %s being replaced by the actual page title) and @a size
+ and @a position specify the geometry of the frame.
For all other help controllers this function has no effect.
+
+ Finally, @a newFrameEachTime is always ignored currently.
*/
- virtual void SetFrameParameters(const wxString& title,
+ virtual void SetFrameParameters(const wxString& titleFormat,
const wxSize& size,
const wxPoint& pos = wxDefaultPosition,
bool newFrameEachTime = false);