include/wx/msw/dialog.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/dialog.h
   3 // Purpose:     wxDialog class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DIALOG_H_
  13 #define _WX_DIALOG_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "dialog.h"
  17 #endif
  18
  19 #include "wx/panel.h"
  20
  21 extern WXDLLEXPORT_DATA(const wxChar*) wxDialogNameStr;
  22
  23 class WXDLLEXPORT wxDialogModalData;
  24
  25 // Dialog boxes
  26 class WXDLLEXPORT wxDialog : public wxDialogBase
  27 {
  28 public:
  29     wxDialog() { Init(); }
  30
  31     // full ctor
  32     wxDialog(wxWindow *parent, wxWindowID id,
  33              const wxString& title,
  34              const wxPoint& pos = wxDefaultPosition,
  35              const wxSize& size = wxDefaultSize,
  36              long style = wxDEFAULT_DIALOG_STYLE,
  37              const wxString& name = wxDialogNameStr)
  38     {
  39         Init();
  40
  41         (void)Create(parent, id, title, pos, size, style, name);
  42     }
  43
  44     bool Create(wxWindow *parent, wxWindowID id,
  45                 const wxString& title,
  46                 const wxPoint& pos = wxDefaultPosition,
  47                 const wxSize& size = wxDefaultSize,
  48                 long style = wxDEFAULT_DIALOG_STYLE,
  49                 const wxString& name = wxDialogNameStr);
  50
  51     virtual ~wxDialog();
  52
  53     // return true if we're showing the dialog modally
  54     virtual bool IsModal() const { return m_modalData != NULL; }
  55
  56     // show the dialog modally and return the value passed to EndModal()
  57     virtual int ShowModal();
  58
  59     // may be called to terminate the dialog with the given return code
  60     virtual void EndModal(int retCode);
  61
  62     // implementation only from now on
  63     // -------------------------------
  64
  65     // override some base class virtuals
  66     virtual bool Show(bool show = true);
  67
  68     virtual void Raise();
  69
  70     // event handlers
  71     void OnCharHook(wxKeyEvent& event);
  72     void OnCloseWindow(wxCloseEvent& event);
  73
  74     // Standard buttons
  75     void OnOK(wxCommandEvent& event);
  76     void OnApply(wxCommandEvent& event);
  77     void OnCancel(wxCommandEvent& event);
  78
  79     // Responds to colour changes
  80     void OnSysColourChanged(wxSysColourChangedEvent& event);
  81
  82 #ifdef __POCKETPC__
  83     // Responds to the OK button in a PocketPC titlebar. This
  84     // can be overridden, or you can change the id used for
  85     // sending the event with SetAffirmativeId. Returns false
  86     // if the event was not processed.
  87     virtual bool DoOK();
  88 #endif
  89
  90     // Windows callbacks
  91     WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
  92
  93     // obsolete methods
  94     // ----------------
  95
  96     // use the other ctor
  97     wxDEPRECATED( wxDialog(wxWindow *parent,
  98              const wxString& title, bool modal,
  99              int x = wxDefaultCoord, int y = wxDefaultCoord, int width = 500, int height = 500,
 100              long style = wxDEFAULT_DIALOG_STYLE,
 101              const wxString& name = wxDialogNameStr) );
 102
 103     // just call Show() or ShowModal()
 104     wxDEPRECATED( void SetModal(bool flag) );
 105
 106     // use IsModal()
 107     wxDEPRECATED( bool IsModalShowing() const );
 108
 109 protected:
 110     // find the window to use as parent for this dialog if none has been
 111     // specified explicitly by the user
 112     //
 113     // may return NULL
 114     wxWindow *FindSuitableParent() const;
 115
 116     // common part of all ctors
 117     void Init();
 118
 119     // end either modal or modeless dialog
 120     void EndDialog(int rc);
 121
 122 private:
 123     wxWindow*   m_oldFocus;
 124     bool        m_endModalCalled; // allow for closing within InitDialog
 125
 126     // this pointer is non-NULL only while the modal event loop is running
 127     wxDialogModalData *m_modalData;
 128
 129
 130     DECLARE_DYNAMIC_CLASS(wxDialog)
 131     DECLARE_EVENT_TABLE()
 132     DECLARE_NO_COPY_CLASS(wxDialog)
 133 };
 134
 135 #endif
 136     // _WX_DIALOG_H_