moving common code

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

diff --git a/include/wx/dialog.h b/include/wx/dialog.h
index ae621112ef68d49948a9c9fce3b170e232be399a..271c0c32bef77506d6ea914880b21d651647fb15 100644 (file)
--- a/include/wx/dialog.h
+++ b/include/wx/dialog.h
@@ -13,11 +13,10 @@
 #define _WX_DIALOG_H_BASE_
 
 #include "wx/defs.h"
 #define _WX_DIALOG_H_BASE_
 
 #include "wx/defs.h"

-#include "wx/containr.h"

 #include "wx/toplevel.h"
 
 #include "wx/toplevel.h"
 

-class WXDLLEXPORT wxSizer;
-class WXDLLEXPORT wxStdDialogButtonSizer;
+class WXDLLIMPEXP_FWD_CORE wxSizer;
+class WXDLLIMPEXP_FWD_CORE wxStdDialogButtonSizer;

 
 #define wxDIALOG_NO_PARENT      0x0001  // Don't make owned by apps top window
 
 
 #define wxDIALOG_NO_PARENT      0x0001  // Don't make owned by apps top window
 


@@ -27,7 +26,7 @@ class WXDLLEXPORT wxStdDialogButtonSizer;
 #define wxDEFAULT_DIALOG_STYLE  (wxCAPTION | wxSYSTEM_MENU | wxCLOSE_BOX)
 #endif
 
 #define wxDEFAULT_DIALOG_STYLE  (wxCAPTION | wxSYSTEM_MENU | wxCLOSE_BOX)
 #endif
 

-extern WXDLLEXPORT_DATA(const wxChar) wxDialogNameStr[];
+extern WXDLLEXPORT_DATA(const char) wxDialogNameStr[];

 
 class WXDLLEXPORT wxDialogBase : public wxTopLevelWindow
 {
 
 class WXDLLEXPORT wxDialogBase : public wxTopLevelWindow
 {


@@ -41,31 +40,51 @@ 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; }
 
     int GetEscapeId() const { return m_escapeId; }
 

+    // Returns the parent to use for modal dialogs if the user did not specify it
+    // explicitly
+    wxWindow *GetParentForModalDialog(wxWindow *parent = NULL) const;
+

 #if wxUSE_STATTEXT // && wxUSE_TEXTCTRL
     // splits text up at newlines and places the
     // lines into a vertical wxBoxSizer
     wxSizer *CreateTextSizer( const wxString &message );
 #endif // wxUSE_STATTEXT // && wxUSE_TEXTCTRL
 
 #if wxUSE_STATTEXT // && wxUSE_TEXTCTRL
     // splits text up at newlines and places the
     // lines into a vertical wxBoxSizer
     wxSizer *CreateTextSizer( const wxString &message );
 #endif // wxUSE_STATTEXT // && wxUSE_TEXTCTRL
 

-    // places buttons into a horizontal wxBoxSizer
-    wxSizer *CreateButtonSizer( long flags,
-                                bool separated = false,
-                                wxCoord distance = 0 );
+    // returns a horizontal wxBoxSizer containing the given buttons
+    //
+    // notice that the returned sizer can be NULL if no buttons are put in the
+    // sizer (this mostly happens under smart phones and other atypical
+    // platforms which have hardware buttons replacing OK/Cancel and such)
+    wxSizer *CreateButtonSizer(long flags);
+
+    // returns the sizer containing CreateButtonSizer() below a separating
+    // static line for the platforms which use static lines for items
+    // separation (i.e. not Mac)
+    wxSizer *CreateSeparatedButtonSizer(long flags);
+

 #if wxUSE_BUTTON
     wxStdDialogButtonSizer *CreateStdDialogButtonSizer( long flags );
 #endif // wxUSE_BUTTON
 #if wxUSE_BUTTON
     wxStdDialogButtonSizer *CreateStdDialogButtonSizer( long flags );
 #endif // wxUSE_BUTTON


@@ -84,6 +103,14 @@ protected:
     // could do something different if needed
     virtual bool IsEscapeKey(const wxKeyEvent& event);
 
     // 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;


@@ -95,12 +122,24 @@ protected:
     int m_escapeId;
 
 private:
     int m_escapeId;
 
 private:

+    // common part of all ctors
+    void Init();
+

     // handle Esc key presses
     void OnCharHook(wxKeyEvent& event);
 
     // 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()
     DECLARE_NO_COPY_CLASS(wxDialogBase)
     DECLARE_EVENT_TABLE()

-    WX_DECLARE_CONTROL_CONTAINER();

 };
 
 
 };