X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9482617091b084d4ee006679a450176715d465e0..303f0be79e904523d3b2e912ab1a5c7ab812d2b6:/include/wx/apptrait.h diff --git a/include/wx/apptrait.h b/include/wx/apptrait.h index dff9f3fdfc..944f574768 100644 --- a/include/wx/apptrait.h +++ b/include/wx/apptrait.h @@ -5,38 +5,54 @@ // Modified by: // Created: 19.06.2003 // RCS-ID: $Id$ -// Copyright: (c) 2003 Vadim Zeitlin +// Copyright: (c) 2003 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_APPTRAIT_H_ #define _WX_APPTRAIT_H_ -class WXDLLEXPORT wxAppTraits; +#include "wx/string.h" +#include "wx/platinfo.h" + +class WXDLLIMPEXP_FWD_BASE wxArrayString; +class WXDLLIMPEXP_FWD_BASE wxConfigBase; +class WXDLLIMPEXP_FWD_BASE wxEventLoopBase; #if wxUSE_FONTMAP - class WXDLLEXPORT wxFontMapper; + class WXDLLIMPEXP_FWD_CORE wxFontMapper; #endif // wxUSE_FONTMAP -class WXDLLEXPORT wxLog; -class WXDLLEXPORT wxMessageOutput; +class WXDLLIMPEXP_FWD_BASE wxLog; +class WXDLLIMPEXP_FWD_BASE wxMessageOutput; +class WXDLLIMPEXP_FWD_BASE wxObject; +class WXDLLIMPEXP_FWD_CORE wxRendererNative; +class WXDLLIMPEXP_FWD_BASE wxStandardPaths; +class WXDLLIMPEXP_FWD_BASE wxString; +class WXDLLIMPEXP_FWD_BASE wxTimer; +class WXDLLIMPEXP_FWD_BASE wxTimerImpl; + +class wxSocketManager; + // ---------------------------------------------------------------------------- // wxAppTraits: this class defines various configurable aspects of wxApp // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxAppTraitsBase +class WXDLLIMPEXP_BASE wxAppTraitsBase { public: - // wxAppTraits is an ABC, but we also provide 2 standard implementations of - // it, one for the console apps and the other for the GUI ones - static wxAppTraits *CreateConsole(); -#if wxUSE_GUI - static wxAppTraits *CreateGUI(); -#endif // wxUSE_GUI - + // needed since this class declares virtual members + virtual ~wxAppTraitsBase() { } - // hooks for creating the global objects, may be overridden by the user + // hooks for working with the global objects, may be overridden by the user // ------------------------------------------------------------------------ +#if wxUSE_CONFIG + // create the default configuration object (base class version is + // implemented in config.cpp and creates wxRegConfig for wxMSW and + // wxFileConfig for all the other platforms) + virtual wxConfigBase *CreateConfig(); +#endif // wxUSE_CONFIG + #if wxUSE_LOG // create the default log target virtual wxLog *CreateLogTarget() = 0; @@ -50,11 +66,27 @@ public: virtual wxFontMapper *CreateFontMapper() = 0; #endif // wxUSE_FONTMAP + // get the renderer to use for drawing the generic controls (return value + // may be NULL in which case the default renderer for the current platform + // is used); this is used in GUI only and always returns NULL in console + // + // NB: returned pointer will be deleted by the caller + virtual wxRendererNative *CreateRenderer() = 0; + + // wxStandardPaths object is normally the same for wxBase and wxGUI + // except in the case of wxMac and wxCocoa + virtual wxStandardPaths& GetStandardPaths(); + +#if wxUSE_INTL + // called during wxApp initialization to set the locale to correspond to + // the user default (i.e. system locale under Windows, LC_ALL under Unix) + virtual void SetLocale(); +#endif // wxUSE_INTL + // functions abstracting differences between GUI and console modes // ------------------------------------------------------------------------ -#ifdef __WXDEBUG__ // show the assert dialog with the specified message in GUI or just print // the string to stderr in console mode // @@ -63,47 +95,97 @@ public: // // return true to suppress subsequent asserts, false to continue as before virtual bool ShowAssertDialog(const wxString& msg) = 0; -#endif // __WXDEBUG__ // return true if fprintf(stderr) goes somewhere, false otherwise virtual bool HasStderr() = 0; - // managing "pending delete" list: in GUI mode we can't immediately delete - // some objects because there may be unprocessed events for them and so we - // only do it during the next idle loop iteration while this is, of course, - // unnecessary in wxBase, so we have a few functions to abstract these - // operations +#if wxUSE_SOCKETS + // this function is used by wxNet library to set the default socket manager + // to use: doing it like this allows us to keep all socket-related code in + // wxNet instead of having to pull it in wxBase itself as we'd have to do + // if we really implemented wxSocketManager here + // + // we don't take ownership of this pointer, it should have a lifetime + // greater than that of any socket (e.g. be a pointer to a static object) + static void SetDefaultSocketManager(wxSocketManager *manager) + { + ms_manager = manager; + } - // add the object to the pending delete list in GUI, delete it immediately - // in wxBase - virtual void ScheduleForDestroy(wxObject *object) = 0; + // return socket manager: this is usually different for console and GUI + // applications (although some ports use the same implementation for both) + virtual wxSocketManager *GetSocketManager() { return ms_manager; } +#endif - // remove this object from the pending delete list in GUI, do nothing in - // wxBase - virtual void RemoveFromPendingDelete(wxObject *object) = 0; + // create a new, port specific, instance of the event loop used by wxApp + virtual wxEventLoopBase *CreateEventLoop() = 0; +#if wxUSE_TIMER + // return platform and toolkit dependent wxTimer implementation + virtual wxTimerImpl *CreateTimerImpl(wxTimer *timer) = 0; +#endif - // other miscellaneous helpers - // --------------------------- +#if wxUSE_THREADS + virtual void MutexGuiEnter(); + virtual void MutexGuiLeave(); +#endif - // wxGetOsVersion() behaves differently in GUI and non-GUI builds under - // Unix: in the former case it returns the information about the toolkit - // and in the latter -- about the OS, so we need to virtualize it - virtual int GetOSVersion(int *verMaj, int *verMin) = 0; + // functions returning port-specific information + // ------------------------------------------------------------------------ + + // return information about the (native) toolkit currently used and its + // runtime (not compile-time) version. + // returns wxPORT_BASE for console applications and one of the remaining + // wxPORT_* values for GUI applications. + virtual wxPortId GetToolkitVersion(int *majVer = NULL, int *minVer = NULL) const = 0; + + // return true if the port is using wxUniversal for the GUI, false if not + virtual bool IsUsingUniversalWidgets() const = 0; + + // return the name of the Desktop Environment such as + // "KDE" or "GNOME". May return an empty string. + virtual wxString GetDesktopEnvironment() const = 0; + + // returns a short string to identify the block of the standard command + // line options parsed automatically by current port: if this string is + // empty, there are no such options, otherwise the function also fills + // passed arrays with the names and the descriptions of those options. + virtual wxString GetStandardCmdLineOptions(wxArrayString& names, + wxArrayString& desc) const + { + wxUnusedVar(names); + wxUnusedVar(desc); + + return wxEmptyString; + } + + +protected: +#if wxUSE_STACKWALKER + // utility function: returns the stack frame as a plain wxString + virtual wxString GetAssertStackTrace(); +#endif + +private: + static wxSocketManager *ms_manager; }; // ---------------------------------------------------------------------------- // include the platform-specific version of the class // ---------------------------------------------------------------------------- -#if defined(__WXMSW__) +// NB: test for __UNIX__ before __WXMAC__ as under Darwin we want to use the +// Unix code (and otherwise __UNIX__ wouldn't be defined) +// ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port +#if defined(__WIN32__) #include "wx/msw/apptbase.h" -#elif defined(__UNIX__) +#elif defined(__UNIX__) && !defined(__EMX__) #include "wx/unix/apptbase.h" +#elif defined(__OS2__) + #include "wx/os2/apptbase.h" #else // no platform-specific methods to add to wxAppTraits - typedef // wxAppTraits must be a class because it was forward declared as class - class WXDLLEXPORT wxAppTraits : public wxAppTraitsBase + class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase { }; #endif // platform @@ -116,9 +198,13 @@ public: // wxConsoleAppTraitsBase: wxAppTraits implementation for the console apps // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxConsoleAppTraitsBase : public wxAppTraits +class WXDLLIMPEXP_BASE wxConsoleAppTraitsBase : public wxAppTraits { public: +#if !wxUSE_CONSOLE_EVENTLOOP + virtual wxEventLoopBase *CreateEventLoop() { return NULL; } +#endif // !wxUSE_CONSOLE_EVENTLOOP + #if wxUSE_LOG virtual wxLog *CreateLogTarget(); #endif // wxUSE_LOG @@ -126,14 +212,24 @@ public: #if wxUSE_FONTMAP virtual wxFontMapper *CreateFontMapper(); #endif // wxUSE_FONTMAP + virtual wxRendererNative *CreateRenderer(); -#ifdef __WXDEBUG__ virtual bool ShowAssertDialog(const wxString& msg); -#endif // __WXDEBUG__ virtual bool HasStderr(); - virtual void ScheduleForDestroy(wxObject *object); - virtual void RemoveFromPendingDelete(wxObject *object); + // the GetToolkitVersion for console application is always the same + virtual wxPortId GetToolkitVersion(int *verMaj = NULL, int *verMin = NULL) const + { + // no toolkits (wxBase is for console applications without GUI support) + // NB: zero means "no toolkit", -1 means "not initialized yet" + // so we must use zero here! + if (verMaj) *verMaj = 0; + if (verMin) *verMin = 0; + return wxPORT_BASE; + } + + virtual bool IsUsingUniversalWidgets() const { return false; } + virtual wxString GetDesktopEnvironment() const { return wxEmptyString; } }; // ---------------------------------------------------------------------------- @@ -142,7 +238,7 @@ public: #if wxUSE_GUI -class WXDLLEXPORT wxGUIAppTraitsBase : public wxAppTraits +class WXDLLIMPEXP_CORE wxGUIAppTraitsBase : public wxAppTraits { public: #if wxUSE_LOG @@ -152,14 +248,21 @@ public: #if wxUSE_FONTMAP virtual wxFontMapper *CreateFontMapper(); #endif // wxUSE_FONTMAP + virtual wxRendererNative *CreateRenderer(); -#ifdef __WXDEBUG__ virtual bool ShowAssertDialog(const wxString& msg); -#endif // __WXDEBUG__ virtual bool HasStderr(); - virtual void ScheduleForDestroy(wxObject *object); - virtual void RemoveFromPendingDelete(wxObject *object); + virtual bool IsUsingUniversalWidgets() const + { + #ifdef __WXUNIVERSAL__ + return true; + #else + return false; + #endif + } + + virtual wxString GetDesktopEnvironment() const { return wxEmptyString; } }; #endif // wxUSE_GUI @@ -168,15 +271,24 @@ public: // include the platform-specific version of the classes above // ---------------------------------------------------------------------------- -#if defined(__WXMSW__) +// ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port +#if defined(__WIN32__) #include "wx/msw/apptrait.h" +#elif defined(__OS2__) + #include "wx/os2/apptrait.h" #elif defined(__UNIX__) #include "wx/unix/apptrait.h" -#else // no platform-specific methods to add to wxAppTraits +#elif defined(__DOS__) + #include "wx/msdos/apptrait.h" +#else #if wxUSE_GUI - typedef wxGUIAppTraitsBase wxGUIAppTraits; + class wxGUIAppTraits : public wxGUIAppTraitsBase + { + }; #endif // wxUSE_GUI - typedef wxConsoleAppTraitsBase wxConsoleAppTraits; + class wxConsoleAppTraits: public wxConsoleAppTraitsBase + { + }; #endif // platform #endif // _WX_APPTRAIT_H_