include/wx/dialog.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/dialog.h
   3 // Purpose:     wxDialogBase class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     29.06.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DIALOG_H_BASE_
  13 #define _WX_DIALOG_H_BASE_
  14
  15 #include "wx/defs.h"
  16 #include "wx/containr.h"
  17 #include "wx/toplevel.h"
  18
  19 class WXDLLEXPORT wxSizer;
  20 class WXDLLEXPORT wxStdDialogButtonSizer;
  21
  22 #define wxDIALOG_NO_PARENT      0x0001  // Don't make owned by apps top window
  23
  24 #ifdef __WXWINCE__
  25 #define wxDEFAULT_DIALOG_STYLE  (wxCAPTION | wxMAXIMIZE | wxCLOSE_BOX | wxNO_BORDER)
  26 #else
  27 #define wxDEFAULT_DIALOG_STYLE  (wxCAPTION | wxSYSTEM_MENU | wxCLOSE_BOX)
  28 #endif
  29
  30 extern WXDLLEXPORT_DATA(const wxChar) wxDialogNameStr[];
  31
  32 class WXDLLEXPORT wxDialogBase : public wxTopLevelWindow
  33 {
  34 public:
  35     enum
  36     {
  37         // all flags allowed in wxDialogBase::CreateButtonSizer()
  38         ButtonSizerFlags = wxOK|wxCANCEL|wxYES|wxNO|wxHELP|wxNO_DEFAULT
  39     };
  40
  41     wxDialogBase() { Init(); }
  42     virtual ~wxDialogBase() { }
  43
  44     // define public wxDialog methods to be implemented by the derived classes
  45     virtual int ShowModal() = 0;
  46     virtual void EndModal(int retCode) = 0;
  47     virtual bool IsModal() const = 0;
  48
  49
  50     // Modal dialogs have a return code - usually the id of the last
  51     // pressed button
  52     void SetReturnCode(int returnCode) { m_returnCode = returnCode; }
  53     int GetReturnCode() const { return m_returnCode; }
  54
  55     // Set the identifier for the affirmative button: this button will close
  56     // the dialog after validating data and calling TransferDataFromWindow()
  57     void SetAffirmativeId(int affirmativeId);
  58     int GetAffirmativeId() const { return m_affirmativeId; }
  59
  60     // Set identifier for Esc key translation: the button with this id will
  61     // close the dialog without doing anything else; special value wxID_NONE
  62     // means to not handle Esc at all while wxID_ANY means to map Esc to
  63     // wxID_CANCEL if present and GetAffirmativeId() otherwise
  64     void SetEscapeId(int escapeId);
  65     int GetEscapeId() const { return m_escapeId; }
  66
  67     // Returns the parent to use for modal dialogs if the user did not specify it
  68     // explicitly
  69     wxWindow *GetParentForModalDialog(wxWindow *parent = NULL) const;
  70
  71 #if wxUSE_STATTEXT // && wxUSE_TEXTCTRL
  72     // splits text up at newlines and places the
  73     // lines into a vertical wxBoxSizer
  74     wxSizer *CreateTextSizer( const wxString &message );
  75 #endif // wxUSE_STATTEXT // && wxUSE_TEXTCTRL
  76
  77     // returns a horizontal wxBoxSizer containing the given buttons
  78     //
  79     // notice that the returned sizer can be NULL if no buttons are put in the
  80     // sizer (this mostly happens under smart phones and other atypical
  81     // platforms which have hardware buttons replacing OK/Cancel and such)
  82     wxSizer *CreateButtonSizer(long flags);
  83
  84     // returns the sizer containing CreateButtonSizer() below a separating
  85     // static line for the platforms which use static lines for items
  86     // separation (i.e. not Mac)
  87     wxSizer *CreateSeparatedButtonSizer(long flags);
  88
  89 #if wxUSE_BUTTON
  90     wxStdDialogButtonSizer *CreateStdDialogButtonSizer( long flags );
  91 #endif // wxUSE_BUTTON
  92
  93 protected:
  94     // emulate click of a button with the given id if it's present in the dialog
  95     //
  96     // return true if button was "clicked" or false if we don't have it
  97     bool EmulateButtonClickIfPresent(int id);
  98
  99     // this function is used by OnCharHook() to decide whether the given key
 100     // should close the dialog
 101     //
 102     // for most platforms the default implementation (which just checks for
 103     // Esc) is sufficient, but Mac port also adds Cmd-. here and other ports
 104     // could do something different if needed
 105     virtual bool IsEscapeKey(const wxKeyEvent& event);
 106
 107     // end either modal or modeless dialog, for the modal dialog rc is used as
 108     // the dialog return code
 109     void EndDialog(int rc);
 110
 111     // call Validate() and TransferDataFromWindow() and close dialog with
 112     // wxID_OK return code
 113     void AcceptAndClose();
 114
 115
 116     // The return code from modal dialog
 117     int m_returnCode;
 118
 119     // The identifier for the affirmative button (usually wxID_OK)
 120     int m_affirmativeId;
 121
 122     // The identifier for cancel button (usually wxID_CANCEL)
 123     int m_escapeId;
 124
 125 private:
 126     // common part of all ctors
 127     void Init();
 128
 129     // handle Esc key presses
 130     void OnCharHook(wxKeyEvent& event);
 131
 132     // handle closing the dialog window
 133     void OnCloseWindow(wxCloseEvent& event);
 134
 135     // handle the standard buttons
 136     void OnButton(wxCommandEvent& event);
 137
 138     // update the background colour
 139     void OnSysColourChanged(wxSysColourChangedEvent& event);
 140
 141
 142     DECLARE_NO_COPY_CLASS(wxDialogBase)
 143     DECLARE_EVENT_TABLE()
 144     WX_DECLARE_CONTROL_CONTAINER();
 145 };
 146
 147
 148 #if defined(__WXUNIVERSAL__) && !defined(__WXMICROWIN__)
 149     #include "wx/univ/dialog.h"
 150 #else
 151     #if defined(__WXPALMOS__)
 152         #include "wx/palmos/dialog.h"
 153     #elif defined(__WXMSW__)
 154         #include "wx/msw/dialog.h"
 155     #elif defined(__WXMOTIF__)
 156         #include "wx/motif/dialog.h"
 157     #elif defined(__WXGTK20__)
 158         #include "wx/gtk/dialog.h"
 159     #elif defined(__WXGTK__)
 160         #include "wx/gtk1/dialog.h"
 161     #elif defined(__WXMAC__)
 162         #include "wx/mac/dialog.h"
 163     #elif defined(__WXCOCOA__)
 164         #include "wx/cocoa/dialog.h"
 165     #elif defined(__WXPM__)
 166         #include "wx/os2/dialog.h"
 167     #endif
 168 #endif
 169
 170 #endif
 171     // _WX_DIALOG_H_BASE_