]> git.saurik.com Git - wxWidgets.git/blob - include/wx/os2/dialog.h
Use wxWebKitCtrlNameStr to adhere to the convention used by other wx classes.
[wxWidgets.git] / include / wx / os2 / dialog.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/os2/dialog.h
3 // Purpose: wxDialog class
4 // Author: David Webster
5 // Modified by:
6 // Created: 10/14/99
7 // RCS-ID: $Id$
8 // Copyright: (c) David Webster
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_DIALOG_H_
13 #define _WX_DIALOG_H_
14
15 #include "wx/panel.h"
16
17 WXDLLIMPEXP_DATA_CORE(extern const char) wxDialogNameStr[];
18
19 class WXDLLIMPEXP_FWD_CORE wxDialogModalData;
20
21 //
22 // Dialog boxes
23 //
24 class WXDLLIMPEXP_CORE wxDialog: public wxDialogBase
25 {
26 public:
27
28 inline wxDialog() { Init(); }
29
30 // full ctor
31 wxDialog(wxWindow *parent, wxWindowID id,
32 const wxString& title,
33 const wxPoint& pos = wxDefaultPosition,
34 const wxSize& size = wxDefaultSize,
35 long style = wxDEFAULT_DIALOG_STYLE,
36 const wxString& name = wxDialogNameStr)
37 {
38 Init();
39
40 (void)Create(parent, id, title, pos, size, style, name);
41 }
42
43 bool Create( wxWindow* pParent
44 ,wxWindowID vId
45 ,const wxString& rsTitle
46 ,const wxPoint& rPos = wxDefaultPosition
47 ,const wxSize& rSize = wxDefaultSize
48 ,long lStyle = wxDEFAULT_DIALOG_STYLE
49 ,const wxString& rsName = 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 //
69 // Callbacks
70 //
71 virtual MRESULT OS2WindowProc( WXUINT uMessage
72 ,WXWPARAM wParam
73 ,WXLPARAM lParam
74 );
75 #if WXWIN_COMPATIBILITY_2_6
76
77 // Constructor with a modal flag, but no window id - the old convention
78 wxDEPRECATED( wxDialog( wxWindow* pParent
79 ,const wxString& rsTitle
80 ,bool bModal
81 ,int nX = -1
82 ,int nY = -1
83 ,int nWidth = 500
84 ,int nHeight = 500
85 ,long lStyle = wxDEFAULT_DIALOG_STYLE
86 ,const wxString& rsName = wxDialogNameStr
87 ) );
88
89 // just call Show() or ShowModal()
90 wxDEPRECATED( void SetModal(bool bFlag) );
91
92 // use IsModal()
93 wxDEPRECATED( bool IsModalShowing() const );
94
95 #endif // WXWIN_COMPATIBILITY_2_6
96
97 protected:
98 //
99 // Common part of all ctors
100 //
101 void Init(void);
102
103 private:
104 wxWindow* m_pOldFocus;
105 bool m_endModalCalled; // allow for closing within InitDialog
106
107 // this pointer is non-NULL only while the modal event loop is running
108 wxDialogModalData *m_modalData;
109
110 //
111 // While we are showing a modal dialog we disable the other windows using
112 // this object
113 //
114 class wxWindowDisabler* m_pWindowDisabler;
115
116 DECLARE_DYNAMIC_CLASS(wxDialog)
117 wxDECLARE_NO_COPY_CLASS(wxDialog);
118 }; // end of CLASS wxDialog
119
120 #endif // _WX_DIALOG_H_