]> git.saurik.com Git - wxWidgets.git/blame - include/wx/apptrait.h
fix from Francesco for the latest version of wxPresets
[wxWidgets.git] / include / wx / apptrait.h
CommitLineData
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 17
df57f6be 18class WXDLLIMPEXP_BASE wxArrayString;
84281b92 19class WXDLLIMPEXP_BASE wxConfigBase;
2ddff00c 20class WXDLLIMPEXP_BASE wxEventLoopBase;
e2478fde
VZ
21#if wxUSE_FONTMAP
22 class WXDLLEXPORT wxFontMapper;
23#endif // wxUSE_FONTMAP
a8eaaeb2
VS
24class WXDLLIMPEXP_BASE wxLog;
25class WXDLLIMPEXP_BASE wxMessageOutput;
84281b92 26class WXDLLIMPEXP_BASE wxObject;
f0244295 27class WXDLLEXPORT wxRendererNative;
84281b92 28class WXDLLIMPEXP_BASE wxStandardPathsBase;
a8eaaeb2 29class WXDLLIMPEXP_BASE wxString;
c2ca375c
VZ
30class WXDLLIMPEXP_BASE wxTimer;
31class WXDLLIMPEXP_BASE wxTimerImpl;
a8eaaeb2 32
3e1400ac 33class GSocketGUIFunctionsTable;
38bb138f 34
e2478fde
VZ
35
36// ----------------------------------------------------------------------------
37// wxAppTraits: this class defines various configurable aspects of wxApp
38// ----------------------------------------------------------------------------
39
7af1b539 40class WXDLLIMPEXP_BASE wxAppTraitsBase
e2478fde
VZ
41{
42public:
ed62f740
VZ
43 // needed since this class declares virtual members
44 virtual ~wxAppTraitsBase() { }
45
d774f916 46 // hooks for working with the global objects, may be overridden by the user
e2478fde
VZ
47 // ------------------------------------------------------------------------
48
84281b92
VZ
49#if wxUSE_CONFIG
50 // create the default configuration object (base class version is
51 // implemented in config.cpp and creates wxRegConfig for wxMSW and
52 // wxFileConfig for all the other platforms)
53 virtual wxConfigBase *CreateConfig();
54#endif // wxUSE_CONFIG
55
e2478fde
VZ
56#if wxUSE_LOG
57 // create the default log target
58 virtual wxLog *CreateLogTarget() = 0;
59#endif // wxUSE_LOG
60
61 // create the global object used for printing out messages
62 virtual wxMessageOutput *CreateMessageOutput() = 0;
63
64#if wxUSE_FONTMAP
65 // create the global font mapper object used for encodings/charset mapping
66 virtual wxFontMapper *CreateFontMapper() = 0;
67#endif // wxUSE_FONTMAP
68
f0244295
VZ
69 // get the renderer to use for drawing the generic controls (return value
70 // may be NULL in which case the default renderer for the current platform
71 // is used); this is used in GUI only and always returns NULL in console
72 //
73 // NB: returned pointer will be deleted by the caller
74 virtual wxRendererNative *CreateRenderer() = 0;
75
fc480dc1
DE
76 // wxStandardPaths object is normally the same for wxBase and wxGUI
77 // except in the case of wxMac and wxCocoa
78 virtual wxStandardPathsBase& GetStandardPaths();
e2478fde 79
d774f916
VZ
80#if wxUSE_INTL
81 // called during wxApp initialization to set the locale to correspond to
82 // the user default (i.e. system locale under Windows, LC_ALL under Unix)
83 virtual void SetLocale();
84#endif // wxUSE_INTL
85
86
e2478fde
VZ
87 // functions abstracting differences between GUI and console modes
88 // ------------------------------------------------------------------------
89
90#ifdef __WXDEBUG__
91 // show the assert dialog with the specified message in GUI or just print
92 // the string to stderr in console mode
93 //
94 // base class version has an implementation (in spite of being pure
95 // virtual) in base/appbase.cpp which can be called as last resort.
96 //
97 // return true to suppress subsequent asserts, false to continue as before
98 virtual bool ShowAssertDialog(const wxString& msg) = 0;
99#endif // __WXDEBUG__
100
101 // return true if fprintf(stderr) goes somewhere, false otherwise
102 virtual bool HasStderr() = 0;
103
104 // managing "pending delete" list: in GUI mode we can't immediately delete
105 // some objects because there may be unprocessed events for them and so we
106 // only do it during the next idle loop iteration while this is, of course,
107 // unnecessary in wxBase, so we have a few functions to abstract these
108 // operations
109
110 // add the object to the pending delete list in GUI, delete it immediately
111 // in wxBase
112 virtual void ScheduleForDestroy(wxObject *object) = 0;
113
114 // remove this object from the pending delete list in GUI, do nothing in
115 // wxBase
116 virtual void RemoveFromPendingDelete(wxObject *object) = 0;
2739d4f0 117
38bb138f 118#if wxUSE_SOCKETS
321b8029 119 // return table of GUI callbacks for GSocket code or NULL in wxBase. This
4629016d 120 // is needed because networking classes are in their own library and so
321b8029
VS
121 // they can't directly call GUI functions (the same net library can be
122 // used in both GUI and base apps). To complicate it further, GUI library
123 // ("wxCore") doesn't depend on networking library and so only a functions
124 // table can be passed around
38bb138f
VS
125 virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0;
126#endif
127
b46b1d59 128 // create a new, port specific, instance of the event loop used by wxApp
2ddff00c 129 virtual wxEventLoopBase *CreateEventLoop() = 0;
b46b1d59 130
c2ca375c
VZ
131#if wxUSE_TIMER
132 // return platform and toolkit dependent wxTimer implementation
133 virtual wxTimerImpl *CreateTimerImpl(wxTimer *timer) = 0;
134#endif
d774f916
VZ
135
136 // functions returning port-specific information
137 // ------------------------------------------------------------------------
138
449090b5
VZ
139 // return information about the (native) toolkit currently used and its
140 // runtime (not compile-time) version.
8bb6b2c0
VZ
141 // returns wxPORT_BASE for console applications and one of the remaining
142 // wxPORT_* values for GUI applications.
143 virtual wxPortId GetToolkitVersion(int *majVer, int *minVer) const = 0;
b98bd6af
VS
144
145 // return true if the port is using wxUniversal for the GUI, false if not
146 virtual bool IsUsingUniversalWidgets() const = 0;
db9febdf
RR
147
148 // return the name of the Desktop Environment such as
88bbc332 149 // "KDE" or "GNOME". May return an empty string.
d3a0a0ee
VZ
150 virtual wxString GetDesktopEnvironment() const = 0;
151
152 // returns a short string to identify the block of the standard command
153 // line options parsed automatically by current port: if this string is
154 // empty, there are no such options, otherwise the function also fills
155 // passed arrays with the names and the descriptions of those options.
156 virtual wxString GetStandardCmdLineOptions(wxArrayString& names,
157 wxArrayString& desc) const
158 {
159 wxUnusedVar(names);
160 wxUnusedVar(desc);
161
162 return wxEmptyString;
163 }
164
db9febdf
RR
165
166protected:
167#if wxUSE_STACKWALKER && defined( __WXDEBUG__ )
168 // utility function: returns the stack frame as a plain wxString
169 virtual wxString GetAssertStackTrace();
170#endif
e2478fde
VZ
171};
172
173// ----------------------------------------------------------------------------
174// include the platform-specific version of the class
175// ----------------------------------------------------------------------------
176
532d575b
WS
177// NB: test for __UNIX__ before __WXMAC__ as under Darwin we want to use the
178// Unix code (and otherwise __UNIX__ wouldn't be defined)
179// ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port
4055ed82 180#if defined(__WXPALMOS__)
ffecfa5a 181 #include "wx/palmos/apptbase.h"
532d575b 182#elif defined(__WIN32__)
e2478fde 183 #include "wx/msw/apptbase.h"
621ccd8a 184#elif defined(__UNIX__) && !defined(__EMX__)
2d2d4fc7 185 #include "wx/unix/apptbase.h"
29c99ad3
VZ
186#elif defined(__WXMAC__)
187 #include "wx/mac/apptbase.h"
9fc852b7
SN
188#elif defined(__OS2__)
189 #include "wx/os2/apptbase.h"
46446cc2 190#else // no platform-specific methods to add to wxAppTraits
e2478fde 191 // wxAppTraits must be a class because it was forward declared as class
bb24c68f 192 class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase
e2478fde
VZ
193 {
194 };
195#endif // platform
196
197// ============================================================================
198// standard traits for console and GUI applications
199// ============================================================================
200
201// ----------------------------------------------------------------------------
202// wxConsoleAppTraitsBase: wxAppTraits implementation for the console apps
203// ----------------------------------------------------------------------------
204
7af1b539 205class WXDLLIMPEXP_BASE wxConsoleAppTraitsBase : public wxAppTraits
e2478fde
VZ
206{
207public:
208#if wxUSE_LOG
209 virtual wxLog *CreateLogTarget();
210#endif // wxUSE_LOG
211 virtual wxMessageOutput *CreateMessageOutput();
212#if wxUSE_FONTMAP
213 virtual wxFontMapper *CreateFontMapper();
214#endif // wxUSE_FONTMAP
f0244295 215 virtual wxRendererNative *CreateRenderer();
38bb138f
VS
216#if wxUSE_SOCKETS
217 virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
218#endif
e2478fde
VZ
219
220#ifdef __WXDEBUG__
221 virtual bool ShowAssertDialog(const wxString& msg);
222#endif // __WXDEBUG__
223 virtual bool HasStderr();
224
225 virtual void ScheduleForDestroy(wxObject *object);
226 virtual void RemoveFromPendingDelete(wxObject *object);
8bb6b2c0
VZ
227
228 // the GetToolkitVersion for console application is always the same
b98bd6af 229 virtual wxPortId GetToolkitVersion(int *verMaj, int *verMin) const
8bb6b2c0
VZ
230 {
231 // no toolkits (wxBase is for console applications without GUI support)
232 // NB: zero means "no toolkit", -1 means "not initialized yet"
233 // so we must use zero here!
234 if (verMaj) *verMaj = 0;
235 if (verMin) *verMin = 0;
236 return wxPORT_BASE;
237 }
b98bd6af
VS
238
239 virtual bool IsUsingUniversalWidgets() const { return false; }
d3a0a0ee 240 virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
e2478fde
VZ
241};
242
243// ----------------------------------------------------------------------------
244// wxGUIAppTraitsBase: wxAppTraits implementation for the GUI apps
245// ----------------------------------------------------------------------------
246
247#if wxUSE_GUI
248
94826170 249class WXDLLEXPORT wxGUIAppTraitsBase : public wxAppTraits
e2478fde
VZ
250{
251public:
252#if wxUSE_LOG
253 virtual wxLog *CreateLogTarget();
254#endif // wxUSE_LOG
255 virtual wxMessageOutput *CreateMessageOutput();
256#if wxUSE_FONTMAP
257 virtual wxFontMapper *CreateFontMapper();
258#endif // wxUSE_FONTMAP
f0244295 259 virtual wxRendererNative *CreateRenderer();
38bb138f
VS
260#if wxUSE_SOCKETS
261 virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
262#endif
e2478fde
VZ
263
264#ifdef __WXDEBUG__
265 virtual bool ShowAssertDialog(const wxString& msg);
266#endif // __WXDEBUG__
267 virtual bool HasStderr();
268
269 virtual void ScheduleForDestroy(wxObject *object);
270 virtual void RemoveFromPendingDelete(wxObject *object);
b98bd6af
VS
271
272 virtual bool IsUsingUniversalWidgets() const
273 {
274 #ifdef __WXUNIVERSAL__
275 return true;
276 #else
277 return false;
278 #endif
279 }
d3a0a0ee
VZ
280
281 virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
e2478fde
VZ
282};
283
284#endif // wxUSE_GUI
285
286// ----------------------------------------------------------------------------
287// include the platform-specific version of the classes above
288// ----------------------------------------------------------------------------
289
532d575b 290// ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port
4055ed82 291#if defined(__WXPALMOS__)
ffecfa5a 292 #include "wx/palmos/apptrait.h"
532d575b 293#elif defined(__WIN32__)
e2478fde 294 #include "wx/msw/apptrait.h"
21d3d342
SN
295#elif defined(__OS2__)
296 #include "wx/os2/apptrait.h"
297#elif defined(__UNIX__)
2d2d4fc7 298 #include "wx/unix/apptrait.h"
29c99ad3
VZ
299#elif defined(__WXMAC__)
300 #include "wx/mac/apptrait.h"
9aecec9a
MW
301#elif defined(__DOS__)
302 #include "wx/msdos/apptrait.h"
4629016d 303#else
e2478fde 304 #if wxUSE_GUI
621ccd8a
SN
305 class wxGUIAppTraits : public wxGUIAppTraitsBase
306 {
621ccd8a 307 };
e2478fde 308 #endif // wxUSE_GUI
4629016d 309 class wxConsoleAppTraits: public wxConsoleAppTraitsBase
621ccd8a 310 {
621ccd8a 311 };
e2478fde
VZ
312#endif // platform
313
314#endif // _WX_APPTRAIT_H_
315