Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document wxHelpSearchMode enum and its values.

Browse Source 
Closes #14090.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70875 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-03-11 23:41:13 +00:00
parent 2ccd2adc16
commit 662ba87479
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
interface/wx/help.h
View File

@@ -6,6 +6,15 @@
// Licence: wxWindows licence // Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/**
Help search modes for wxHelpController::KeywordSearch().
*/
enum wxHelpSearchMode
{
wxHELP_SEARCH_INDEX, ///< Search the index only.
wxHELP_SEARCH_ALL ///< Search all entries.
};
/** /**
@class wxHelpController @class wxHelpController
@@ -182,8 +191,8 @@ public:
/** /**
If the help viewer is not running, runs it, and searches for sections matching If the help viewer is not running, runs it, and searches for sections matching
the given keyword. If one match is found, the file is displayed at this section. the given keyword. If one match is found, the file is displayed at this section.
The optional parameter allows the search the index (wxHELP_SEARCH_INDEX) The optional parameter allows to search the index (wxHELP_SEARCH_INDEX)
but this currently only supported by the wxHtmlHelpController. but this currently is only supported by the wxHtmlHelpController.
- @e WinHelp, MS HTML Help: - @e WinHelp, MS HTML Help:
If more than one match is found, the first topic is displayed. If more than one match is found, the first topic is displayed.