/////////////////////////////////////////////////////////////////////////////
-// 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
/////////////////////////////////////////////////////////////////////////////
#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
};
// 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.
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; }
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)
};