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 #if wxUSE_TOOLBAR && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
  26 class WXDLLEXPORT wxToolBar;
  27 #endif
  28
  29 // Dialog boxes
  30 class WXDLLEXPORT wxDialog : public wxDialogBase
  31 {
  32 public:
  33     wxDialog() { Init(); }
  34
  35     // full ctor
  36     wxDialog(wxWindow *parent, wxWindowID id,
  37              const wxString& title,
  38              const wxPoint& pos = wxDefaultPosition,
  39              const wxSize& size = wxDefaultSize,
  40              long style = wxDEFAULT_DIALOG_STYLE,
  41              const wxString& name = wxDialogNameStr)
  42     {
  43         Init();
  44
  45         (void)Create(parent, id, title, pos, size, style, name);
  46     }
  47
  48     bool Create(wxWindow *parent, wxWindowID id,
  49                 const wxString& title,
  50                 const wxPoint& pos = wxDefaultPosition,
  51                 const wxSize& size = wxDefaultSize,
  52                 long style = wxDEFAULT_DIALOG_STYLE,
  53                 const wxString& name = wxDialogNameStr);
  54
  55     virtual ~wxDialog();
  56
  57     // return true if we're showing the dialog modally
  58     virtual bool IsModal() const { return m_modalData != NULL; }
  59
  60     // show the dialog modally and return the value passed to EndModal()
  61     virtual int ShowModal();
  62
  63     // may be called to terminate the dialog with the given return code
  64     virtual void EndModal(int retCode);
  65
  66 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
  67     // create main toolbar by calling OnCreateToolBar()
  68     virtual wxToolBar* CreateToolBar(long style = -1,
  69                                      wxWindowID winid = wxID_ANY,
  70                                      const wxString& name = wxToolBarNameStr);
  71     // return a new toolbar
  72     virtual wxToolBar *OnCreateToolBar(long style,
  73                                        wxWindowID winid,
  74                                        const wxString& name );
  75
  76     // get the main toolbar
  77     wxToolBar *GetToolBar() const { return m_dialogToolBar; }
  78 #endif
  79
  80     // implementation only from now on
  81     // -------------------------------
  82
  83     // override some base class virtuals
  84     virtual bool Show(bool show = true);
  85
  86     virtual void Raise();
  87
  88     // event handlers
  89     void OnCharHook(wxKeyEvent& event);
  90     void OnCloseWindow(wxCloseEvent& event);
  91
  92     // Standard buttons
  93     void OnOK(wxCommandEvent& event);
  94     void OnApply(wxCommandEvent& event);
  95     void OnCancel(wxCommandEvent& event);
  96
  97     // Responds to colour changes
  98     void OnSysColourChanged(wxSysColourChangedEvent& event);
  99
 100 #ifdef __POCKETPC__
 101     // Responds to the OK button in a PocketPC titlebar. This
 102     // can be overridden, or you can change the id used for
 103     // sending the event with SetAffirmativeId. Returns false
 104     // if the event was not processed.
 105     virtual bool DoOK();
 106 #endif
 107
 108     // Windows callbacks
 109     WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 110
 111     // obsolete methods
 112     // ----------------
 113
 114     // use the other ctor
 115     wxDEPRECATED( wxDialog(wxWindow *parent,
 116              const wxString& title, bool modal,
 117              int x = wxDefaultCoord, int y = wxDefaultCoord, int width = 500, int height = 500,
 118              long style = wxDEFAULT_DIALOG_STYLE,
 119              const wxString& name = wxDialogNameStr) );
 120
 121     // just call Show() or ShowModal()
 122     wxDEPRECATED( void SetModal(bool flag) );
 123
 124     // use IsModal()
 125     wxDEPRECATED( bool IsModalShowing() const );
 126
 127 protected:
 128     // find the window to use as parent for this dialog if none has been
 129     // specified explicitly by the user
 130     //
 131     // may return NULL
 132     wxWindow *FindSuitableParent() const;
 133
 134     // common part of all ctors
 135     void Init();
 136
 137     // end either modal or modeless dialog
 138     void EndDialog(int rc);
 139
 140     // emulate click of a button with the given id if it's present in the dialog
 141     //
 142     // return true if button was "clicked" or false if we don't have it
 143     bool EmulateButtonClickIfPresent(int id);
 144
 145     // handle Escape here
 146     virtual bool MSWProcessMessage(WXMSG* pMsg);
 147
 148 private:
 149     wxWindow*   m_oldFocus;
 150     bool        m_endModalCalled; // allow for closing within InitDialog
 151
 152 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 153     wxToolBar*  m_dialogToolBar;
 154 #endif
 155
 156     // this pointer is non-NULL only while the modal event loop is running
 157     wxDialogModalData *m_modalData;
 158
 159     DECLARE_DYNAMIC_CLASS(wxDialog)
 160     DECLARE_EVENT_TABLE()
 161     DECLARE_NO_COPY_CLASS(wxDialog)
 162 };
 163
 164 #endif
 165     // _WX_DIALOG_H_