#define _WX_DIALOG_H_BASE_
#include "wx/defs.h"
-#include "wx/containr.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 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
{
wxDialogBase() { Init(); }
virtual ~wxDialogBase() { }
- // public wxDialog API, to be implemented by the derived classes
+ // 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;
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; }
- // 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; }
+ // 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
- // 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
// 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;
void OnCloseWindow(wxCloseEvent& event);
// handle the standard buttons
- void OnOK(wxCommandEvent& event);
- void OnApply(wxCommandEvent& event);
- void OnCancel(wxCommandEvent& event);
+ void OnButton(wxCommandEvent& event);
// update the background colour
void OnSysColourChanged(wxSysColourChangedEvent& event);
DECLARE_NO_COPY_CLASS(wxDialogBase)
DECLARE_EVENT_TABLE()
- WX_DECLARE_CONTROL_CONTAINER();
};