X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fda7962d029672a5f4c718a3c6b2559856f4cd95..8e77fd8bca165aab9709649d79a7cbc6a172d4e1:/include/wx/helpbase.h?ds=sidebyside diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index 2dad25c4e8..f16eafdead 100644 --- a/include/wx/helpbase.h +++ b/include/wx/helpbase.h @@ -1,21 +1,17 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: helpbase.h +// Name: wx/helpbase.h // Purpose: Help system base classes // Author: Julian Smart // Modified by: // Created: 04/01/98 // RCS-ID: $Id$ // Copyright: (c) Julian Smart -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_HELPBASEH__ #define _WX_HELPBASEH__ -#if defined(__GNUG__) && !defined(__APPLE__) -#pragma interface "helpbase.h" -#endif - #include "wx/defs.h" #if wxUSE_HELP @@ -28,18 +24,25 @@ // 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 +class WXDLLIMPEXP_CORE wxHelpControllerBase: public wxObject { public: - inline wxHelpControllerBase() {} + inline wxHelpControllerBase(wxWindow* parentWindow = NULL) { m_parentWindow = parentWindow; } inline ~wxHelpControllerBase() {} // Must call this to set the filename and server name. // server is only required when implementing TCP/IP-based // help controllers. - virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; } - virtual bool Initialize(const wxString& WXUNUSED(file)) { return FALSE; } + virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return false; } + virtual bool Initialize(const wxString& WXUNUSED(file)) { return false; } // Set viewer: only relevant to some kinds of controller virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {} @@ -54,21 +57,22 @@ public: virtual bool DisplaySection(int sectionNo) = 0; // Display the section using a context id - virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; }; + 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 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), const wxPoint& WXUNUSED(pos) = wxDefaultPosition, - bool WXUNUSED(newFrameEachTime) = FALSE) + bool WXUNUSED(newFrameEachTime) = false) { // does nothing by default } @@ -78,12 +82,20 @@ public: wxPoint *WXUNUSED(pos) = NULL, bool *WXUNUSED(newFrameEachTime) = NULL) { - return (wxFrame*) NULL; // does nothing by default + return NULL; // does nothing by default } virtual bool Quit() = 0; virtual void OnQuit() {} - + + /// Set the window that can optionally be used for the help window's parent. + virtual void SetParentWindow(wxWindow* win) { m_parentWindow = win; } + + /// Get the window that can optionally be used for the help window's parent. + virtual wxWindow* GetParentWindow() const { return m_parentWindow; } + +protected: + wxWindow* m_parentWindow; private: DECLARE_CLASS(wxHelpControllerBase) };