added default value for Show() argument
[wxWidgets.git] / 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 and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_DIALOG_H_
13 #define _WX_DIALOG_H_
14
15 #ifdef __GNUG__
16 #pragma interface "dialog.h"
17 #endif
18
19 #include "wx/panel.h"
20
21 WXDLLEXPORT_DATA(extern const wxChar*) wxDialogNameStr;
22
23 // Dialog boxes
24 class WXDLLEXPORT wxDialog : public wxDialogBase
25 {
26 public:
27 wxDialog() { Init(); }
28
29 // Constructor with a modal flag, but no window id - the old convention
30 wxDialog(wxWindow *parent,
31 const wxString& title, bool modal,
32 int x = -1, int y= -1, int width = 500, int height = 500,
33 long style = wxDEFAULT_DIALOG_STYLE,
34 const wxString& name = wxDialogNameStr)
35 {
36 long modalStyle = modal ? wxDIALOG_MODAL : wxDIALOG_MODELESS ;
37 Create(parent, -1, title, wxPoint(x, y), wxSize(width, height),
38 style | modalStyle, name);
39 }
40
41 // Constructor with no modal flag - the new convention.
42 wxDialog(wxWindow *parent, wxWindowID id,
43 const wxString& title,
44 const wxPoint& pos = wxDefaultPosition,
45 const wxSize& size = wxDefaultSize,
46 long style = wxDEFAULT_DIALOG_STYLE,
47 const wxString& name = wxDialogNameStr)
48 {
49 Create(parent, id, title, pos, size, style, name);
50 }
51
52 bool Create(wxWindow *parent, wxWindowID id,
53 const wxString& title,
54 const wxPoint& pos = wxDefaultPosition,
55 const wxSize& size = wxDefaultSize,
56 long style = wxDEFAULT_DIALOG_STYLE,
57 const wxString& name = wxDialogNameStr);
58
59 virtual ~wxDialog();
60
61 void SetModal(bool flag);
62 virtual bool IsModal() const;
63
64 // For now, same as Show(TRUE) but returns return code
65 virtual int ShowModal();
66
67 // may be called to terminate the dialog with the given return code
68 virtual void EndModal(int retCode);
69
70 // returns TRUE if we're in a modal loop
71 bool IsModalShowing() const;
72
73 // implementation only from now on
74 // -------------------------------
75
76 // override some base class virtuals
77 virtual bool Show(bool show = TRUE);
78
79 // event handlers
80 bool OnClose();
81 void OnCharHook(wxKeyEvent& event);
82 void OnCloseWindow(wxCloseEvent& event);
83
84 // Standard buttons
85 void OnOK(wxCommandEvent& event);
86 void OnApply(wxCommandEvent& event);
87 void OnCancel(wxCommandEvent& event);
88
89 // Responds to colour changes
90 void OnSysColourChanged(wxSysColourChangedEvent& event);
91
92 // Windows callbacks
93 long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
94
95 #if wxUSE_CTL3D
96 virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
97 WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
98 #endif // wxUSE_CTL3D
99
100 protected:
101 // show modal dialog and enter modal loop
102 void DoShowModal();
103
104 // common part of all ctors
105 void Init();
106
107 private:
108 wxWindow *m_oldFocus;
109
110 // while we are showing a modal dialog we disable the other windows using
111 // this object
112 class wxWindowDisabler *m_windowDisabler;
113
114 DECLARE_DYNAMIC_CLASS(wxDialog)
115 DECLARE_EVENT_TABLE()
116 };
117
118 #endif
119 // _WX_DIALOG_H_