]>
Commit | Line | Data |
---|---|---|
e2478fde VZ |
1 | /////////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/apptrait.h | |
3 | // Purpose: declaration of wxAppTraits and derived classes | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 19.06.2003 | |
7 | // RCS-ID: $Id$ | |
77ffb593 | 8 | // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org> |
65571936 | 9 | // Licence: wxWindows licence |
e2478fde VZ |
10 | /////////////////////////////////////////////////////////////////////////////// |
11 | ||
12 | #ifndef _WX_APPTRAIT_H_ | |
13 | #define _WX_APPTRAIT_H_ | |
14 | ||
a8eaaeb2 | 15 | #include "wx/string.h" |
8bb6b2c0 | 16 | #include "wx/platinfo.h" |
a8eaaeb2 VS |
17 | |
18 | class WXDLLIMPEXP_BASE wxObject; | |
e2478fde VZ |
19 | class WXDLLEXPORT wxAppTraits; |
20 | #if wxUSE_FONTMAP | |
21 | class WXDLLEXPORT wxFontMapper; | |
22 | #endif // wxUSE_FONTMAP | |
a8eaaeb2 VS |
23 | class WXDLLIMPEXP_BASE wxLog; |
24 | class WXDLLIMPEXP_BASE wxMessageOutput; | |
f0244295 | 25 | class WXDLLEXPORT wxRendererNative; |
a8eaaeb2 | 26 | class WXDLLIMPEXP_BASE wxString; |
a8eaaeb2 | 27 | |
3e1400ac | 28 | class GSocketGUIFunctionsTable; |
38bb138f | 29 | |
e2478fde VZ |
30 | |
31 | // ---------------------------------------------------------------------------- | |
32 | // wxAppTraits: this class defines various configurable aspects of wxApp | |
33 | // ---------------------------------------------------------------------------- | |
34 | ||
fc480dc1 DE |
35 | class WXDLLIMPEXP_BASE wxStandardPathsBase; |
36 | ||
7af1b539 | 37 | class WXDLLIMPEXP_BASE wxAppTraitsBase |
e2478fde VZ |
38 | { |
39 | public: | |
ed62f740 VZ |
40 | // needed since this class declares virtual members |
41 | virtual ~wxAppTraitsBase() { } | |
42 | ||
e2478fde VZ |
43 | // hooks for creating the global objects, may be overridden by the user |
44 | // ------------------------------------------------------------------------ | |
45 | ||
46 | #if wxUSE_LOG | |
47 | // create the default log target | |
48 | virtual wxLog *CreateLogTarget() = 0; | |
49 | #endif // wxUSE_LOG | |
50 | ||
51 | // create the global object used for printing out messages | |
52 | virtual wxMessageOutput *CreateMessageOutput() = 0; | |
53 | ||
54 | #if wxUSE_FONTMAP | |
55 | // create the global font mapper object used for encodings/charset mapping | |
56 | virtual wxFontMapper *CreateFontMapper() = 0; | |
57 | #endif // wxUSE_FONTMAP | |
58 | ||
f0244295 VZ |
59 | // get the renderer to use for drawing the generic controls (return value |
60 | // may be NULL in which case the default renderer for the current platform | |
61 | // is used); this is used in GUI only and always returns NULL in console | |
62 | // | |
63 | // NB: returned pointer will be deleted by the caller | |
64 | virtual wxRendererNative *CreateRenderer() = 0; | |
65 | ||
07158944 | 66 | #if wxUSE_STDPATHS |
fc480dc1 DE |
67 | // wxStandardPaths object is normally the same for wxBase and wxGUI |
68 | // except in the case of wxMac and wxCocoa | |
69 | virtual wxStandardPathsBase& GetStandardPaths(); | |
07158944 | 70 | #endif // wxUSE_STDPATHS |
e2478fde VZ |
71 | |
72 | // functions abstracting differences between GUI and console modes | |
73 | // ------------------------------------------------------------------------ | |
74 | ||
75 | #ifdef __WXDEBUG__ | |
76 | // show the assert dialog with the specified message in GUI or just print | |
77 | // the string to stderr in console mode | |
78 | // | |
79 | // base class version has an implementation (in spite of being pure | |
80 | // virtual) in base/appbase.cpp which can be called as last resort. | |
81 | // | |
82 | // return true to suppress subsequent asserts, false to continue as before | |
83 | virtual bool ShowAssertDialog(const wxString& msg) = 0; | |
84 | #endif // __WXDEBUG__ | |
85 | ||
86 | // return true if fprintf(stderr) goes somewhere, false otherwise | |
87 | virtual bool HasStderr() = 0; | |
88 | ||
89 | // managing "pending delete" list: in GUI mode we can't immediately delete | |
90 | // some objects because there may be unprocessed events for them and so we | |
91 | // only do it during the next idle loop iteration while this is, of course, | |
92 | // unnecessary in wxBase, so we have a few functions to abstract these | |
93 | // operations | |
94 | ||
95 | // add the object to the pending delete list in GUI, delete it immediately | |
96 | // in wxBase | |
97 | virtual void ScheduleForDestroy(wxObject *object) = 0; | |
98 | ||
99 | // remove this object from the pending delete list in GUI, do nothing in | |
100 | // wxBase | |
101 | virtual void RemoveFromPendingDelete(wxObject *object) = 0; | |
2739d4f0 | 102 | |
38bb138f | 103 | #if wxUSE_SOCKETS |
321b8029 | 104 | // return table of GUI callbacks for GSocket code or NULL in wxBase. This |
4629016d | 105 | // is needed because networking classes are in their own library and so |
321b8029 VS |
106 | // they can't directly call GUI functions (the same net library can be |
107 | // used in both GUI and base apps). To complicate it further, GUI library | |
108 | // ("wxCore") doesn't depend on networking library and so only a functions | |
109 | // table can be passed around | |
38bb138f VS |
110 | virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0; |
111 | #endif | |
112 | ||
449090b5 VZ |
113 | // return information about the (native) toolkit currently used and its |
114 | // runtime (not compile-time) version. | |
8bb6b2c0 VZ |
115 | // returns wxPORT_BASE for console applications and one of the remaining |
116 | // wxPORT_* values for GUI applications. | |
117 | virtual wxPortId GetToolkitVersion(int *majVer, int *minVer) const = 0; | |
b98bd6af VS |
118 | |
119 | // return true if the port is using wxUniversal for the GUI, false if not | |
120 | virtual bool IsUsingUniversalWidgets() const = 0; | |
e2478fde VZ |
121 | }; |
122 | ||
123 | // ---------------------------------------------------------------------------- | |
124 | // include the platform-specific version of the class | |
125 | // ---------------------------------------------------------------------------- | |
126 | ||
532d575b WS |
127 | // NB: test for __UNIX__ before __WXMAC__ as under Darwin we want to use the |
128 | // Unix code (and otherwise __UNIX__ wouldn't be defined) | |
129 | // ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port | |
4055ed82 | 130 | #if defined(__WXPALMOS__) |
ffecfa5a | 131 | #include "wx/palmos/apptbase.h" |
532d575b | 132 | #elif defined(__WIN32__) |
e2478fde | 133 | #include "wx/msw/apptbase.h" |
621ccd8a | 134 | #elif defined(__UNIX__) && !defined(__EMX__) |
2d2d4fc7 | 135 | #include "wx/unix/apptbase.h" |
29c99ad3 VZ |
136 | #elif defined(__WXMAC__) |
137 | #include "wx/mac/apptbase.h" | |
9fc852b7 SN |
138 | #elif defined(__OS2__) |
139 | #include "wx/os2/apptbase.h" | |
46446cc2 | 140 | #else // no platform-specific methods to add to wxAppTraits |
e2478fde | 141 | // wxAppTraits must be a class because it was forward declared as class |
bb24c68f | 142 | class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase |
e2478fde VZ |
143 | { |
144 | }; | |
145 | #endif // platform | |
146 | ||
147 | // ============================================================================ | |
148 | // standard traits for console and GUI applications | |
149 | // ============================================================================ | |
150 | ||
151 | // ---------------------------------------------------------------------------- | |
152 | // wxConsoleAppTraitsBase: wxAppTraits implementation for the console apps | |
153 | // ---------------------------------------------------------------------------- | |
154 | ||
7af1b539 | 155 | class WXDLLIMPEXP_BASE wxConsoleAppTraitsBase : public wxAppTraits |
e2478fde VZ |
156 | { |
157 | public: | |
158 | #if wxUSE_LOG | |
159 | virtual wxLog *CreateLogTarget(); | |
160 | #endif // wxUSE_LOG | |
161 | virtual wxMessageOutput *CreateMessageOutput(); | |
162 | #if wxUSE_FONTMAP | |
163 | virtual wxFontMapper *CreateFontMapper(); | |
164 | #endif // wxUSE_FONTMAP | |
f0244295 | 165 | virtual wxRendererNative *CreateRenderer(); |
38bb138f VS |
166 | #if wxUSE_SOCKETS |
167 | virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable(); | |
168 | #endif | |
e2478fde VZ |
169 | |
170 | #ifdef __WXDEBUG__ | |
171 | virtual bool ShowAssertDialog(const wxString& msg); | |
172 | #endif // __WXDEBUG__ | |
173 | virtual bool HasStderr(); | |
174 | ||
175 | virtual void ScheduleForDestroy(wxObject *object); | |
176 | virtual void RemoveFromPendingDelete(wxObject *object); | |
8bb6b2c0 VZ |
177 | |
178 | // the GetToolkitVersion for console application is always the same | |
b98bd6af | 179 | virtual wxPortId GetToolkitVersion(int *verMaj, int *verMin) const |
8bb6b2c0 VZ |
180 | { |
181 | // no toolkits (wxBase is for console applications without GUI support) | |
182 | // NB: zero means "no toolkit", -1 means "not initialized yet" | |
183 | // so we must use zero here! | |
184 | if (verMaj) *verMaj = 0; | |
185 | if (verMin) *verMin = 0; | |
186 | return wxPORT_BASE; | |
187 | } | |
b98bd6af VS |
188 | |
189 | virtual bool IsUsingUniversalWidgets() const { return false; } | |
e2478fde VZ |
190 | }; |
191 | ||
192 | // ---------------------------------------------------------------------------- | |
193 | // wxGUIAppTraitsBase: wxAppTraits implementation for the GUI apps | |
194 | // ---------------------------------------------------------------------------- | |
195 | ||
196 | #if wxUSE_GUI | |
197 | ||
94826170 | 198 | class WXDLLEXPORT wxGUIAppTraitsBase : public wxAppTraits |
e2478fde VZ |
199 | { |
200 | public: | |
201 | #if wxUSE_LOG | |
202 | virtual wxLog *CreateLogTarget(); | |
203 | #endif // wxUSE_LOG | |
204 | virtual wxMessageOutput *CreateMessageOutput(); | |
205 | #if wxUSE_FONTMAP | |
206 | virtual wxFontMapper *CreateFontMapper(); | |
207 | #endif // wxUSE_FONTMAP | |
f0244295 | 208 | virtual wxRendererNative *CreateRenderer(); |
38bb138f VS |
209 | #if wxUSE_SOCKETS |
210 | virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable(); | |
211 | #endif | |
e2478fde VZ |
212 | |
213 | #ifdef __WXDEBUG__ | |
214 | virtual bool ShowAssertDialog(const wxString& msg); | |
215 | #endif // __WXDEBUG__ | |
216 | virtual bool HasStderr(); | |
217 | ||
218 | virtual void ScheduleForDestroy(wxObject *object); | |
219 | virtual void RemoveFromPendingDelete(wxObject *object); | |
b98bd6af VS |
220 | |
221 | virtual bool IsUsingUniversalWidgets() const | |
222 | { | |
223 | #ifdef __WXUNIVERSAL__ | |
224 | return true; | |
225 | #else | |
226 | return false; | |
227 | #endif | |
228 | } | |
e2478fde VZ |
229 | }; |
230 | ||
231 | #endif // wxUSE_GUI | |
232 | ||
233 | // ---------------------------------------------------------------------------- | |
234 | // include the platform-specific version of the classes above | |
235 | // ---------------------------------------------------------------------------- | |
236 | ||
532d575b | 237 | // ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port |
4055ed82 | 238 | #if defined(__WXPALMOS__) |
ffecfa5a | 239 | #include "wx/palmos/apptrait.h" |
532d575b | 240 | #elif defined(__WIN32__) |
e2478fde | 241 | #include "wx/msw/apptrait.h" |
621ccd8a | 242 | #elif defined(__UNIX__) && !defined(__EMX__) |
2d2d4fc7 | 243 | #include "wx/unix/apptrait.h" |
29c99ad3 VZ |
244 | #elif defined(__WXMAC__) |
245 | #include "wx/mac/apptrait.h" | |
7332d96b | 246 | #elif defined(__WXPM__) |
a637417c | 247 | #include "wx/os2/apptrait.h" |
9aecec9a MW |
248 | #elif defined(__DOS__) |
249 | #include "wx/msdos/apptrait.h" | |
4629016d | 250 | #else |
e2478fde | 251 | #if wxUSE_GUI |
621ccd8a SN |
252 | class wxGUIAppTraits : public wxGUIAppTraitsBase |
253 | { | |
621ccd8a | 254 | }; |
e2478fde | 255 | #endif // wxUSE_GUI |
4629016d | 256 | class wxConsoleAppTraits: public wxConsoleAppTraitsBase |
621ccd8a | 257 | { |
621ccd8a | 258 | }; |
e2478fde VZ |
259 | #endif // platform |
260 | ||
261 | #endif // _WX_APPTRAIT_H_ | |
262 |