X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/af49c4b8a2d3553e733e71c7dd3911881f4c1a2a..31ad423e4fb556ec225a63b161154d3bf3445c1b:/include/wx/helpbase.h diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index 9ac23f2e9f..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,14 +28,19 @@ // 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 { - DECLARE_CLASS(wxHelpControllerBase) - public: inline wxHelpControllerBase() {} - inline ~wxHelpControllerBase() {}; + inline ~wxHelpControllerBase() {} // Must call this to set the filename and server name. // server is only required when implementing TCP/IP-based @@ -47,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 = "") = 0; + virtual bool LoadFile(const wxString& file = wxEmptyString) = 0; // Displays the contents virtual bool DisplayContents(void) = 0; @@ -59,13 +64,14 @@ public: virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; }; // Display the text in a popup, if possible - virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; }; + virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; } // By default, uses KeywordSection to display a topic. Implementations // may override this for more specific behaviour. - virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }; + 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), @@ -80,11 +86,14 @@ public: wxPoint *WXUNUSED(pos) = NULL, bool *WXUNUSED(newFrameEachTime) = NULL) { - return (wxFrame*) NULL;// does nothing by default + return (wxFrame*) NULL; // does nothing by default } - virtual bool Quit(void) = 0; - virtual void OnQuit(void) {}; + virtual bool Quit() = 0; + virtual void OnQuit() {} + +private: + DECLARE_CLASS(wxHelpControllerBase) }; #endif // wxUSE_HELP