void SetEventObject(wxObject *obj);
long GetTimestamp() const;
void SetTimestamp(long ts = 0);
- int GetId() const;
+ int GetId() const;
void SetId(int Id);
bool IsCommandEvent() const;
- // Can instruct event processor that we wish to ignore this event
- // (treat as if the event table entry had not been found): this must be done
- // to allow the event processing by the base classes (calling event.Skip()
- // is the analog of calling the base class verstion of a virtual function)
- void Skip(bool skip = True);
+ DocDeclStr(
+ void , Skip(bool skip = true),
+ "Called by an event handler, it controls whether additional event
+handlers bound to this event will be called after the current event
+handler returns. Skip(false) (the default setting) will prevent
+additional event handlers from being called and control will be
+returned to the sender of the event immediately after the current
+handler has finished. Skip(True) will cause the event processing
+system to continue searching for a handler function for this event.
+", "");
+
bool GetSkipped() const;
// Determine if this event should be propagating to the parent window.
bool AltDown() const;
bool ShiftDown() const;
+ DocDeclStr(
+ bool , CmdDown() const,
+ "\"Cmd\" is a pseudo key which is the same as Control for PC and Unix
+platforms but the special \"Apple\" (a.k.a as \"Command\") key on
+Macs: it makes often sense to use it instead of, say, `ControlDown`
+because Cmd key is used for the same thing under Mac as Ctrl
+elsewhere. The Ctrl still exists, it's just not used for this
+purpose. So for non-Mac platforms this is the same as `ControlDown`
+and Macs this is the same as `MetaDown`.", "");
+
// Find which event was just generated
bool LeftDown() const;
bool MiddleDown() const;
DocStr(GetPosition, // sets the docstring for both
- "Returns the position of the mouse in window coordinates when the event happened.");
+ "Returns the position of the mouse in window coordinates when the event
+happened.", "");
wxPoint GetPosition();
DocDeclAName(
bool MetaDown() const;
bool AltDown() const;
bool ShiftDown() const;
+
+ DocDeclStr(
+ bool , CmdDown() const,
+ "\"Cmd\" is a pseudo key which is the same as Control for PC and Unix
+platforms but the special \"Apple\" (a.k.a as \"Command\") key on
+Macs: it makes often sense to use it instead of, say, `ControlDown`
+because Cmd key is used for the same thing under Mac as Ctrl
+elsewhere. The Ctrl still exists, it's just not used for this
+purpose. So for non-Mac platforms this is the same as `ControlDown`
+and Macs this is the same as `MetaDown`.", "");
+
+
// exclude MetaDown() from HasModifiers() because NumLock under X is often
// configured as mod2 modifier, yet the key events even when it is pressed
%pythoncode { KeyCode = GetKeyCode }
%extend {
- int GetUniChar() {
+ int GetUnicodeKey() {
%#if wxUSE_UNICODE
- return self->m_uniChar;
+ return self->GetUnicodeKey();
%#else
return 0;
%#endif
}
}
+ %pythoncode { GetUniChar = GetUnicodeKey }
+
// get the raw key code (platform-dependent)
wxUint32 GetRawKeyCode() const;
DocStr(GetPosition, // sets the docstring for both
- "Find the position of the event.");
+ "Find the position of the event.", "");
wxPoint GetPosition();
DocDeclAName(
wxPoint GetPosition() const;
wxRect GetRect() const;
- void SetRect(wxRect rect);
- %extend {
- void SetPosition(wxPoint pos) {
- self->m_pos = pos;
- }
- }
+ void SetRect(const wxRect& rect);
+ void SetPosition(const wxPoint& pos);
- wxPoint m_pos;
- wxRect m_rect;
+ %pythoncode {
+ m_pos = property(GetPosition, SetPosition)
+ m_rect = property(GetRect, SetRect)
+ }
};
//---------------------------------------------------------------------------
class wxActivateEvent : public wxEvent
{
public:
- wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = True, int Id = 0);
+ wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0);
bool GetActive() const;
};
void SetLoggingOff(bool logOff);
bool GetLoggingOff() const;
- void Veto(bool veto = True);
+ void Veto(bool veto = true);
void SetCanVeto(bool canVeto);
bool CanVeto() const;
class wxShowEvent : public wxEvent
{
public:
- wxShowEvent(int winid = 0, bool show = False);
+ wxShowEvent(int winid = 0, bool show = false);
void SetShow(bool show);
bool GetShow() const;
class wxIconizeEvent: public wxEvent
{
public:
- wxIconizeEvent(int id = 0, bool iconized = True);
+ wxIconizeEvent(int id = 0, bool iconized = true);
bool Iconized();
};
// direction: forward (True) or backward (False)
bool GetDirection() const;
- void SetDirection(bool bForward);
+ void SetDirection(bool forward);
// it may be a window change event (MDI, notebook pages...) or a control
// change event
bool IsWindowChange() const;
- void SetWindowChange(bool bIs);
+ void SetWindowChange(bool ischange);
+ void SetFlags(long flags);
+
// the child which has the focus currently (may be NULL - use
// wxWindow::FindFocus then)
wxWindow* GetCurrentFocus() const;
void SetCurrentFocus(wxWindow *win);
+
+ enum {
+ IsBackward,
+ IsForward,
+ WinChange
+ };
};
public:
wxIdleEvent();
- void RequestMore(bool needMore = True);
+ void RequestMore(bool needMore = true);
bool MoreRequested() const;
// Specify how wxWindows will send idle events: to
class wxPyEvent : public wxEvent {
public:
- %addtofunc wxPyEvent "self.SetSelf(self)"
+ %pythonAppend wxPyEvent "self.SetSelf(self)"
wxPyEvent(int winid=0, wxEventType commandType = wxEVT_NULL );
~wxPyEvent();
class wxPyCommandEvent : public wxCommandEvent {
public:
- %addtofunc wxPyCommandEvent "self.SetSelf(self)"
+ %pythonAppend wxPyCommandEvent "self.SetSelf(self)"
wxPyCommandEvent(wxEventType commandType = wxEVT_NULL, int id=0);
~wxPyCommandEvent();
//---------------------------------------------------------------------------
+class wxDateEvent : public wxCommandEvent
+{
+public:
+ wxDateEvent(wxWindow *win, const wxDateTime& dt, wxEventType type);
+
+ const wxDateTime& GetDate() const;
+ void SetDate(const wxDateTime &date);
+
+};
+
+%constant wxEventType wxEVT_DATE_CHANGED;
+
+%pythoncode {
+ EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
+}
+
+
+//---------------------------------------------------------------------------