//----------------------------------------------------------------------
-enum {
- wxFRAME_EX_CONTEXTHELP,
- wxDIALOG_EX_CONTEXTHELP,
-};
%constant wxEventType wxEVT_HELP;
%constant wxEventType wxEVT_DETAILED_HELP;
class wxHelpEvent : public wxCommandEvent
{
public:
+ // how was this help event generated?
+ enum Origin
+ {
+ Origin_Unknown, // unrecognized event source
+ Origin_Keyboard, // event generated from F1 key press
+ Origin_HelpButton // event from [?] button on the title bar (Windows)
+ };
+
DocCtorStr(
wxHelpEvent(wxEventType type = wxEVT_NULL,
wxWindowID winid = 0,
- const wxPoint& pt = wxDefaultPosition),
+ const wxPoint& pt = wxDefaultPosition,
+ Origin origin = Origin_Unknown ),
"", "");
DocDeclStr(
void , SetTarget(const wxString& target),
"Set an optional target to display help in. E.g. a window specification", "");
+
+ // optional indication of the event source
+ DocDeclStr(
+ Origin , GetOrigin() const,
+ "Optiononal indication of the source of the event.", "");
+ DocDeclStr(
+ void , SetOrigin(Origin origin),
+ "", "");
+
};
//---------------------------------------------------------------------------
There are a couple of ways to invoke this behaviour implicitly:
- * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a dialog
+ * Use the wx.WS_EX_CONTEXTHELP extended style for a dialog or frame
(Windows only). This will put a question mark in the titlebar,
and Windows will put the application into context-sensitive help
mode automatically, with further programming.
* Create a `wx.ContextHelpButton`, whose predefined behaviour is
to create a context help object. Normally you will write your
application so that this button is only added to a dialog for
- non-Windows platforms (use ``wx.DIALOG_EX_CONTEXTHELP`` on
+ non-Windows platforms (use ``wx.WS_EX_CONTEXTHELP`` on
Windows).
:see: `wx.ContextHelpButton`
"Shows help for the given window. Uses GetHelp internally if
applicable. Returns True if it was done, or False if no help was
available for this window.", "");
+
+ DocDeclStr(
+ virtual bool , ShowHelpAtPoint(wxWindowBase *window,
+ const wxPoint& pt,
+ wxHelpEvent::Origin origin),
+ "Show help for the given window (uses window.GetHelpAtPoint()
+internally if applicable), return true if it was done or false if no
+help available for this window.", "");
+
+
DocDeclStr(
void , AddHelp(wxWindow *window, const wxString& text),