From 36c5850bcf17593483042aa6253f68fd610ee72b Mon Sep 17 00:00:00 2001 From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= Date: Fri, 6 Sep 2013 17:09:07 +0000 Subject: [PATCH] Document wxWindowModalDialogEvent. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74772 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/dialog.h | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/interface/wx/dialog.h b/interface/wx/dialog.h index a34a0cdcaf..cf330bcc94 100644 --- a/interface/wx/dialog.h +++ b/interface/wx/dialog.h @@ -607,12 +607,15 @@ public: user from interacting with their parent frame only but not with the rest of the application. They also don't block the program execution but instead return immediately, as Show(), and generate a - wxEVT_WINDOW_MODAL_DIALOG_CLOSED event later when the dialog is closed. + wxEVT_WINDOW_MODAL_DIALOG_CLOSED event (wxWindowModalDialogEvent) + later when the dialog is closed. Currently this function is only fully implemented in wxOSX ports, under the other platforms it behaves like ShowModal() (but also sends the above mentioned event). + @see wxWindowModalDialogEvent + @since 2.9.0 */ void ShowWindowModal(); @@ -659,12 +662,23 @@ public: }; +/** + Event sent by wxDialog::ShowWindowModal() when the dialog closes. + + @since 2.9.0 + */ class wxWindowModalDialogEvent : public wxCommandEvent { public: + /// Constructor wxWindowModalDialogEvent (wxEventType commandType = wxEVT_NULL, int id = 0); + /// Return the corresponding dialog. wxDialog *GetDialog() const; + + /// Return the dialog's return code. int GetReturnCode() const; + + /// Clone the event. virtual wxEvent *Clone() const; }; -- 2.47.2