fixed typo in previous commit

[wxWidgets.git] / include / wx / dialog.h

diff --git a/include/wx/dialog.h b/include/wx/dialog.h
index e56f985490bb188eef2d2110cab1856b244aa5f4..1dd7535bc098429fdc03b7c09f86b279a42cb368 100644 (file)
--- a/include/wx/dialog.h
+++ b/include/wx/dialog.h
@@ -32,7 +32,6 @@ extern WXDLLEXPORT_DATA(const wxChar) wxDialogNameStr[];
 class WXDLLEXPORT wxDialogBase : public wxTopLevelWindow
 {
 public:
 class WXDLLEXPORT wxDialogBase : public wxTopLevelWindow
 {
 public:

-

     enum
     {
         // all flags allowed in wxDialogBase::CreateButtonSizer()
     enum
     {
         // all flags allowed in wxDialogBase::CreateButtonSizer()


@@ -42,19 +41,27 @@ public:
     wxDialogBase() { Init(); }
     virtual ~wxDialogBase() { }
 
     wxDialogBase() { Init(); }
     virtual ~wxDialogBase() { }
 

-    void Init();
+    // define public wxDialog methods to be implemented by the derived classes
+    virtual int ShowModal() = 0;
+    virtual void EndModal(int retCode) = 0;
+    virtual bool IsModal() const = 0;
+

 
     // Modal dialogs have a return code - usually the id of the last
     // pressed button
     void SetReturnCode(int returnCode) { m_returnCode = returnCode; }
     int GetReturnCode() const { return m_returnCode; }
 
 
     // Modal dialogs have a return code - usually the id of the last
     // pressed button
     void SetReturnCode(int returnCode) { m_returnCode = returnCode; }
     int GetReturnCode() const { return m_returnCode; }
 

-    // The identifier for the affirmative button
-    void SetAffirmativeId(int affirmativeId) { m_affirmativeId = affirmativeId; }
+    // Set the identifier for the affirmative button: this button will close
+    // the dialog after validating data and calling TransferDataFromWindow()
+    void SetAffirmativeId(int affirmativeId);

     int GetAffirmativeId() const { return m_affirmativeId; }
 
     int GetAffirmativeId() const { return m_affirmativeId; }
 

-    // Identifier for Esc key translation
-    void SetEscapeId(int escapeId) { m_escapeId = escapeId; }
+    // Set identifier for Esc key translation: the button with this id will
+    // close the dialog without doing anything else; special value wxID_NONE
+    // means to not handle Esc at all while wxID_ANY means to map Esc to
+    // wxID_CANCEL if present and GetAffirmativeId() otherwise
+    void SetEscapeId(int escapeId);

     int GetEscapeId() const { return m_escapeId; }
 
 #if wxUSE_STATTEXT // && wxUSE_TEXTCTRL
     int GetEscapeId() const { return m_escapeId; }
 
 #if wxUSE_STATTEXT // && wxUSE_TEXTCTRL


@@ -72,6 +79,28 @@ public:
 #endif // wxUSE_BUTTON
 
 protected:
 #endif // wxUSE_BUTTON
 
 protected:

+    // emulate click of a button with the given id if it's present in the dialog
+    //
+    // return true if button was "clicked" or false if we don't have it
+    bool EmulateButtonClickIfPresent(int id);
+
+    // this function is used by OnCharHook() to decide whether the given key
+    // should close the dialog
+    //
+    // for most platforms the default implementation (which just checks for
+    // Esc) is sufficient, but Mac port also adds Cmd-. here and other ports
+    // could do something different if needed
+    virtual bool IsEscapeKey(const wxKeyEvent& event);
+
+    // end either modal or modeless dialog, for the modal dialog rc is used as
+    // the dialog return code
+    void EndDialog(int rc);
+
+    // call Validate() and TransferDataFromWindow() and close dialog with
+    // wxID_OK return code
+    void AcceptAndClose();
+
+

     // The return code from modal dialog
     int m_returnCode;
 
     // The return code from modal dialog
     int m_returnCode;
 


@@ -81,6 +110,23 @@ protected:
     // The identifier for cancel button (usually wxID_CANCEL)
     int m_escapeId;
 
     // The identifier for cancel button (usually wxID_CANCEL)
     int m_escapeId;
 

+private:
+    // common part of all ctors
+    void Init();
+
+    // handle Esc key presses
+    void OnCharHook(wxKeyEvent& event);
+
+    // handle closing the dialog window
+    void OnCloseWindow(wxCloseEvent& event);
+
+    // handle the standard buttons
+    void OnButton(wxCommandEvent& event);
+
+    // update the background colour
+    void OnSysColourChanged(wxSysColourChangedEvent& event);
+
+

     DECLARE_NO_COPY_CLASS(wxDialogBase)
     DECLARE_EVENT_TABLE()
     WX_DECLARE_CONTROL_CONTAINER();
     DECLARE_NO_COPY_CLASS(wxDialogBase)
     DECLARE_EVENT_TABLE()
     WX_DECLARE_CONTROL_CONTAINER();


@@ -96,8 +142,10 @@ protected:
         #include "wx/msw/dialog.h"
     #elif defined(__WXMOTIF__)
         #include "wx/motif/dialog.h"
         #include "wx/msw/dialog.h"
     #elif defined(__WXMOTIF__)
         #include "wx/motif/dialog.h"

-    #elif defined(__WXGTK__)
+    #elif defined(__WXGTK20__)

         #include "wx/gtk/dialog.h"
         #include "wx/gtk/dialog.h"

+    #elif defined(__WXGTK__)
+        #include "wx/gtk1/dialog.h"

     #elif defined(__WXMAC__)
         #include "wx/mac/dialog.h"
     #elif defined(__WXCOCOA__)
     #elif defined(__WXMAC__)
         #include "wx/mac/dialog.h"
     #elif defined(__WXCOCOA__)