X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77ffb5937e89927b621128789401db8921fe580f..3da9cffc79cd41b5f1d0c517c8c945596751e86f:/include/wx/helpbase.h diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index 6c8563f014..47af76dd34 100644 --- a/include/wx/helpbase.h +++ b/include/wx/helpbase.h @@ -6,16 +6,12 @@ // Created: 04/01/98 // RCS-ID: $Id$ // Copyright: (c) Julian Smart -// Licence: wxWidgets licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_HELPBASEH__ #define _WX_HELPBASEH__ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "helpbase.h" -#endif - #include "wx/defs.h" #if wxUSE_HELP @@ -36,17 +32,17 @@ enum wxHelpSearchMode }; // 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) {} @@ -61,10 +57,10 @@ 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. @@ -76,7 +72,7 @@ public: 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 } @@ -86,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) };