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),
+ "", "");
+
};
//---------------------------------------------------------------------------
// cycle thru the pages
void AdvanceSelection(bool forward = true);
+ DocDeclAStr(
+ virtual int, HitTest(const wxPoint& pt, long* OUTPUT) const,
+ "HitTest(Point pt) -> (tab, where)",
+ "Returns the page/tab which is hit, and flags indicating where using
+wx.NB_HITTEST flags.", "");
+
static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
};
// set the size of the tabs for wxNB_FIXEDWIDTH controls
virtual void SetTabSize(const wxSize& sz);
- // hit test, returns which tab is hit and, optionally, where (icon, label)
- // (not implemented on all platforms)
- DocDeclAStr(
- virtual int, HitTest(const wxPoint& pt, long* OUTPUT) const,
- "HitTest(Point pt) -> (tab, where)",
- "Returns the tab which is hit, and flags indicating where using
-wx.NB_HITTEST flags.", "");
-
// implement some base class functions
virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;