X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..960b193e59a7700570cfcae914ef2f698e6ba3b8:/include/wx/helpbase.h diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index 95a1562e7a..dc7da84c07 100644 --- a/include/wx/helpbase.h +++ b/include/wx/helpbase.h @@ -5,14 +5,14 @@ // Modified by: // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_HELPBASEH__ #define _WX_HELPBASEH__ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "helpbase.h" #endif @@ -28,6 +28,13 @@ // Flags for SetViewer #define wxHELP_NETSCAPE 1 +// Search modes: +enum wxHelpSearchMode +{ + wxHELP_SEARCH_INDEX, + wxHELP_SEARCH_ALL +}; + // Defines the API for help controllers class WXDLLEXPORT wxHelpControllerBase: public wxObject { @@ -45,7 +52,7 @@ public: virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {} // If file is "", reloads file given in Initialize - virtual bool LoadFile(const wxString& file = wxT("")) = 0; + virtual bool LoadFile(const wxString& file = wxEmptyString) = 0; // Displays the contents virtual bool DisplayContents(void) = 0; @@ -63,7 +70,8 @@ public: // may override this for more specific behaviour. virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); } virtual bool DisplayBlock(long blockNo) = 0; - virtual bool KeywordSearch(const wxString& k) = 0; + virtual bool KeywordSearch(const wxString& k, + wxHelpSearchMode mode = wxHELP_SEARCH_ALL) = 0; /// Allows one to override the default settings for the help frame. virtual void SetFrameParameters(const wxString& WXUNUSED(title), const wxSize& WXUNUSED(size),