added and documented SetEscapeId()
[wxWidgets.git] / 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 wxDialogBase() { Init(); }
36 virtual ~wxDialogBase() { }
37
38 void Init();
39
40 // Modal dialogs have a return code - usually the id of the last
41 // pressed button
42 void SetReturnCode(int returnCode) { m_returnCode = returnCode; }
43 int GetReturnCode() const { return m_returnCode; }
44
45 // The identifier for the affirmative button
46 void SetAffirmativeId(int affirmativeId) { m_affirmativeId = affirmativeId; }
47 int GetAffirmativeId() const { return m_affirmativeId; }
48
49 // Identifier for Esc key translation
50 void SetEscapeId(int escapeId) { m_escapeId = escapeId; }
51 int GetEscapeId() const { return m_escapeId; }
52
53 #if wxUSE_STATTEXT // && wxUSE_TEXTCTRL
54 // splits text up at newlines and places the
55 // lines into a vertical wxBoxSizer
56 wxSizer *CreateTextSizer( const wxString &message );
57 #endif // wxUSE_STATTEXT // && wxUSE_TEXTCTRL
58
59 #if wxUSE_BUTTON
60 // places buttons into a horizontal wxBoxSizer
61 wxSizer *CreateButtonSizer( long flags );
62 wxStdDialogButtonSizer *CreateStdDialogButtonSizer( long flags );
63 #endif // wxUSE_BUTTON
64
65 protected:
66 // The return code from modal dialog
67 int m_returnCode;
68
69 // The identifier for the affirmative button (usually wxID_OK)
70 int m_affirmativeId;
71
72 // The identifier for cancel button (usually wxID_CANCEL)
73 int m_escapeId;
74
75 DECLARE_NO_COPY_CLASS(wxDialogBase)
76 DECLARE_EVENT_TABLE()
77 WX_DECLARE_CONTROL_CONTAINER();
78 };
79
80
81 #if defined(__WXUNIVERSAL__) && !defined(__WXMICROWIN__)
82 #include "wx/univ/dialog.h"
83 #else
84 #if defined(__WXPALMOS__)
85 #include "wx/palmos/dialog.h"
86 #elif defined(__WXMSW__)
87 #include "wx/msw/dialog.h"
88 #elif defined(__WXMOTIF__)
89 #include "wx/motif/dialog.h"
90 #elif defined(__WXGTK__)
91 #include "wx/gtk/dialog.h"
92 #elif defined(__WXMAC__)
93 #include "wx/mac/dialog.h"
94 #elif defined(__WXCOCOA__)
95 #include "wx/cocoa/dialog.h"
96 #elif defined(__WXPM__)
97 #include "wx/os2/dialog.h"
98 #endif
99 #endif
100
101 #endif
102 // _WX_DIALOG_H_BASE_