X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7b77d98836195b312bfd70b1aa37ed79acc9021f..1412e528f83fb6333085cb0cbe00f6a178b951cd:/wxPython/src/_event.i diff --git a/wxPython/src/_event.i b/wxPython/src/_event.i index 5331cb0fc8..cc7db9582c 100644 --- a/wxPython/src/_event.i +++ b/wxPython/src/_event.i @@ -99,8 +99,16 @@ wxEventType wxNewEventType(); %constant wxEventType wxEVT_NAVIGATION_KEY; %constant wxEventType wxEVT_KEY_DOWN; %constant wxEventType wxEVT_KEY_UP; + +%{ +#if ! wxUSE_HOTKEY +#define wxEVT_HOTKEY -9999 +#endif +%} + %constant wxEventType wxEVT_HOTKEY; - + + // Set cursor event %constant wxEventType wxEVT_SET_CURSOR; @@ -559,6 +567,32 @@ radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.", ""); + %extend { + DocStr(GetClientData, + "Returns the client data object for a listbox or choice selection event, (if any.)", ""); + PyObject* GetClientData() { + wxPyClientData* data = (wxPyClientData*)self->GetClientObject(); + if (data) { + Py_INCREF(data->m_obj); + return data->m_obj; + } else { + Py_INCREF(Py_None); + return Py_None; + } + } + + DocStr(SetClientData, + "Associate the given client data with the item at position n.", ""); + void SetClientData(PyObject* clientData) { + wxPyClientData* data = new wxPyClientData(clientData); + self->SetClientObject(data); + } + } + %pythoncode { + GetClientObject = GetClientData + SetClientObject = SetClientData + } + virtual wxEvent *Clone() const; }; @@ -1211,6 +1245,17 @@ public: * ", ""); + DocDeclStr( + int, GetModifiers() const, + "Returns a bitmask of the current modifier settings. Can be used to +check if the key event has exactly the given modifiers without having +to explicitly check that the other modifiers are not down. For +example:: + + if event.GetModifers() == wx.MOD_CONTROL: + DoSomething() +", ""); + DocDeclStr( bool , ControlDown() const, "Returns ``True`` if the Control key was down at the time of the event.", ""); @@ -1918,7 +1963,11 @@ public: DocDeclStr( bool , GetEnabled() const, "Returns ``True`` if the UI element should be enabled.", ""); - + + DocDeclStr( + bool , GetShown() const, + "Returns ``True`` if the UI element should be shown.", ""); + DocDeclStr( wxString , GetText() const, "Returns the text that should be set for the UI element.", ""); @@ -1938,7 +1987,11 @@ internal use only.", ""); "Returns ``True`` if the application has called `Enable`. For wxWidgets internal use only.", ""); - + DocDeclStr( + bool , GetSetShown() const, + "Returns ``True`` if the application has called `Show`. For wxWidgets +internal use only.", ""); + DocDeclStr( void , Check(bool check), @@ -1947,6 +2000,11 @@ internal use only.", ""); DocDeclStr( void , Enable(bool enable), "Enable or disable the UI element.", ""); + + DocDeclStr( + void , Show(bool show), + "Show or hide the UI element.", ""); + DocDeclStr( void , SetText(const wxString& text), @@ -2234,8 +2292,15 @@ public: DocStr(wxWindowDestroyEvent, - "The EVT_WINDOW_DESTROY event is sent right before the window is -destroyed.", ""); + "The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor +when the GUI window is destroyed. + +When a class derived from `wx.Window` is destroyed its destructor will +have already run by the time this event is sent. Therefore this event +will not usually be received at all by the window itself. Since it is +received after the destructor has run, an object should not try to +handle its own wx.WindowDestroyEvent, but it can be used to get +notification of the destruction of another window.", ""); class wxWindowDestroyEvent : public wxCommandEvent { public: