#include <wx/generic/helpext.h>
This class implements help via an external browser.
It requires the name of a directory containing the documentation and a file mapping numerical Section numbers to relative URLS.
The map file contains two or three fields per line: numeric_id relative_URL [; comment/documentation]
The numeric_id is the id used to look up the entry in DisplaySection()/DisplayBlock(). The relative_URL is a filename of an html file, relative to the help directory. The optional comment/documentation field (after a ';') is used for keyword searches, so some meaningful text here does not hurt. If the documentation itself contains a ';', only the part before that will be displayed in the listbox, but all of it used for search.
Lines starting with ';' will be ignored.
<>< =''>:</>&;&;< =''>\ </></>
Public Member Functions | |
wxExtHelpController (wxWindow *parentWindow=NULL) | |
virtual | ~wxExtHelpController () |
virtual void | SetViewer (const wxString &viewer=wxEmptyString, long flags=wxHELP_NETSCAPE) |
Tell it which browser to use. | |
virtual bool | Initialize (const wxString &dir) |
This must be called to tell the controller where to find the documentation. | |
virtual bool | LoadFile (const wxString &file=wxEmptyString) |
If file is "", reloads file given in Initialize. | |
virtual bool | DisplayContents () |
Display list of all help entries. | |
virtual bool | DisplaySection (int sectionNo) |
Display help for id sectionNo. | |
virtual bool | DisplaySection (const wxString §ion) |
Display help for id sectionNo – identical with DisplaySection(). | |
virtual bool | DisplayBlock (long blockNo) |
Display help for URL (using DisplayHelp) or keyword (using KeywordSearch) | |
virtual bool | KeywordSearch (const wxString &k, wxHelpSearchMode mode=wxHELP_SEARCH_ALL) |
Search comment/documentation fields in map file and present a list to chose from. | |
virtual bool | Quit () |
Does nothing. | |
virtual void | OnQuit () |
Does nothing. | |
virtual bool | DisplayHelp (const wxString &relativeURL) |
Call the browser using a relative URL. | |
virtual void | SetFrameParameters (const wxString &titleFormat, const wxSize &size, const wxPoint &pos=wxDefaultPosition, bool newFrameEachTime=false) |
Allows one to override the default settings for the help frame. | |
virtual wxFrame * | GetFrameParameters (wxSize *size=NULL, wxPoint *pos=NULL, bool *newFrameEachTime=NULL) |
Obtains the latest settings used by the help frame and the help frame. | |
![]() | |
wxHelpControllerBase (wxWindow *parentWindow=NULL) | |
Constructs a help instance object, but does not invoke the help viewer. | |
~wxHelpControllerBase () | |
Destroys the help instance, closing down the viewer if it is running. | |
virtual bool | DisplayContextPopup (int contextId) |
Displays the section as a popup window using a context id. | |
virtual bool | DisplayTextPopup (const wxString &text, const wxPoint &pos) |
Displays the text in a popup window, if possible. | |
virtual wxWindow * | GetParentWindow () const |
Returns the window to be used as the parent for the help window. | |
virtual bool | Initialize (const wxString &file, int server) |
virtual void | SetParentWindow (wxWindow *parentWindow) |
Sets the window to be used as the parent for the help window. | |
![]() | |
wxObject () | |
Default ctor; initializes to NULL the internal reference data. | |
wxObject (const wxObject &other) | |
Copy ctor. | |
virtual | ~wxObject () |
Destructor. | |
virtual wxClassInfo * | GetClassInfo () const |
This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). | |
wxObjectRefData * | GetRefData () const |
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. | |
bool | IsKindOf (const wxClassInfo *info) const |
Determines whether this class is a subclass of (or the same class as) the given class. | |
bool | IsSameAs (const wxObject &obj) const |
Returns true if this object has the same data pointer as obj. | |
void | Ref (const wxObject &clone) |
Makes this object refer to the data in clone. | |
void | SetRefData (wxObjectRefData *data) |
Sets the wxObject::m_refData pointer. | |
void | UnRef () |
Decrements the reference count in the associated data, and if it is zero, deletes the data. | |
void | UnShare () |
This is the same of AllocExclusive() but this method is public. | |
void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
Additional Inherited Members | |
![]() | |
void | AllocExclusive () |
Ensure that this object's data is not shared with any other object. | |
virtual wxObjectRefData * | CreateRefData () const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. | |
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. | |
![]() | |
wxObjectRefData * | m_refData |
Pointer to an object which is the object's reference-counted data. | |
|
virtual |
Display help for URL (using DisplayHelp) or keyword (using KeywordSearch)
Implements wxHelpControllerBase.
Call the browser using a relative URL.
Display help for id sectionNo – identical with DisplaySection().
Reimplemented from wxHelpControllerBase.
|
virtual |
Obtains the latest settings used by the help frame and the help frame.
Reimplemented from wxHelpControllerBase.
This must be called to tell the controller where to find the documentation.
If a locale is set, look in file/localename, i.e. If passed "/usr/local/myapp/help" and the current wxLocale is set to be "de", then look in "/usr/local/myapp/help/de/" first and fall back to "/usr/local/myapp/help" if that doesn't exist.
dir | directory name where to fine the help files |
Reimplemented from wxHelpControllerBase.
|
virtual |
Search comment/documentation fields in map file and present a list to chose from.
k | string to search for, empty string will list all entries |
mode | optional parameter allows the search the index (wxHELP_SEARCH_INDEX) but this currently only supported by the wxHtmlHelpController. |
Implements wxHelpControllerBase.
|
virtual |
If file is "", reloads file given in Initialize.
file | Name of help directory. |
Implements wxHelpControllerBase.
Does nothing.
Reimplemented from wxHelpControllerBase.
Does nothing.
Implements wxHelpControllerBase.
|
virtual |
Allows one to override the default settings for the help frame.
Reimplemented from wxHelpControllerBase.
|
virtual |
Tell it which browser to use.
The Netscape support will check whether Netscape is already running (by looking at the .netscape/lock file in the user's home directory) and tell it to load the page into the existing window.
viewer | The command to call a browser/html viewer. |
flags | Set this to wxHELP_NETSCAPE if the browser is some variant of Netscape. |
Reimplemented from wxHelpControllerBase.