// Author: Vadim Zeitlin
// Modified by:
// Created: 19.06.2003
-// RCS-ID: $Id$
// Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#define _WX_APPTRAIT_H_
#include "wx/string.h"
+#include "wx/platinfo.h"
-class WXDLLIMPEXP_BASE wxObject;
-class WXDLLEXPORT wxAppTraits;
+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 WXDLLIMPEXP_BASE wxLog;
-class WXDLLIMPEXP_BASE wxMessageOutput;
-class WXDLLEXPORT wxRendererNative;
-class WXDLLIMPEXP_BASE wxString;
+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 GSocketGUIFunctionsTable;
-
-// ----------------------------------------------------------------------------
-// toolkit information
-// ----------------------------------------------------------------------------
-
-// Information about the toolkit that the app is running under (e.g. wxMSW):
-struct WXDLLIMPEXP_BASE wxToolkitInfo
-{
- // Short name of the toolkit (e.g. "msw" or "mswuniv"); empty for console:
- wxString shortName;
- // Descriptive name of the toolkit, human readable (e.g. "wxMSW" or
- // "wxMSW/Universal"); "wxBase" for console apps:
- wxString name;
- // Version of the underlying toolkit or of the OS for console apps:
- int versionMajor, versionMinor;
- // OS mnenomics, e.g. wxGTK or wxMSW:
- int os;
-};
+class wxSocketManager;
// ----------------------------------------------------------------------------
// wxAppTraits: this class defines various configurable aspects of wxApp
// ----------------------------------------------------------------------------
-class WXDLLIMPEXP_BASE wxStandardPathsBase;
-
class WXDLLIMPEXP_BASE wxAppTraitsBase
{
public:
- // hooks for creating the global objects, may be overridden by the user
+ // needed since this class declares virtual members
+ virtual ~wxAppTraitsBase() { }
+
+ // 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;
// wxStandardPaths object is normally the same for wxBase and wxGUI
// except in the case of wxMac and wxCocoa
-#ifndef __WXPALMOS__
- virtual wxStandardPathsBase& GetStandardPaths();
-#endif
+ virtual wxStandardPaths& GetStandardPaths();
+
// 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
//
//
// 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_SOCKETS
- // return table of GUI callbacks for GSocket code or NULL in wxBase. This
- // is needed because networking classes are in their own library and so
- // they can't directly call GUI functions (the same net library can be
- // used in both GUI and base apps). To complicate it further, GUI library
- // ("wxCore") doesn't depend on networking library and so only a functions
- // table can be passed around
- virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0;
+#if wxUSE_TIMER
+ // return platform and toolkit dependent wxTimer implementation
+ virtual wxTimerImpl *CreateTimerImpl(wxTimer *timer) = 0;
+#endif
+
+#if wxUSE_THREADS
+ virtual void MutexGuiEnter();
+ virtual void MutexGuiLeave();
#endif
+ // 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;
+ }
+
- // return information about what toolkit is running; we need for two things
- // that are both contained in wxBase:
- // - 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
- // - wxDynamicLibrary::CanonicalizePluginName() must embed toolkit
- // signature in DLL name
- virtual wxToolkitInfo& GetToolkitInfo() = 0;
+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
// ----------------------------------------------------------------------------
-// NB: test for __UNIX__ before __WXMAC__ as under Darwin we want to use the
-// Unix code (and otherwise __UNIX__ wouldn't be defined)
-#if defined(__WXPALMOS__)
- #include "wx/palmos/apptbase.h"
-#elif 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__) && !defined(__EMX__)
#include "wx/unix/apptbase.h"
-#elif defined(__WXMAC__)
- #include "wx/mac/apptbase.h"
#elif defined(__OS2__)
#include "wx/os2/apptbase.h"
#else // no platform-specific methods to add to 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
virtual wxFontMapper *CreateFontMapper();
#endif // wxUSE_FONTMAP
virtual wxRendererNative *CreateRenderer();
-#if wxUSE_SOCKETS
- virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
-#endif
-#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; }
};
// ----------------------------------------------------------------------------
#if wxUSE_GUI
-class WXDLLEXPORT wxGUIAppTraitsBase : public wxAppTraits
+class WXDLLIMPEXP_CORE wxGUIAppTraitsBase : public wxAppTraits
{
public:
#if wxUSE_LOG
virtual wxFontMapper *CreateFontMapper();
#endif // wxUSE_FONTMAP
virtual wxRendererNative *CreateRenderer();
-#if wxUSE_SOCKETS
- virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
-#endif
-#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
// include the platform-specific version of the classes above
// ----------------------------------------------------------------------------
-#if defined(__WXPALMOS__)
- #include "wx/palmos/apptrait.h"
-#elif 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(__UNIX__) && !defined(__EMX__)
- #include "wx/unix/apptrait.h"
-#elif defined(__WXMAC__)
- #include "wx/mac/apptrait.h"
-#elif defined(__WXPM__)
+#elif defined(__OS2__)
#include "wx/os2/apptrait.h"
+#elif defined(__UNIX__)
+ #include "wx/unix/apptrait.h"
+#elif defined(__DOS__)
+ #include "wx/msdos/apptrait.h"
#else
- // at least, we need an implementation of GetToolkitInfo !
#if wxUSE_GUI
class wxGUIAppTraits : public wxGUIAppTraitsBase
{
- virtual wxToolkitInfo& GetToolkitInfo();
};
#endif // wxUSE_GUI
class wxConsoleAppTraits: public wxConsoleAppTraitsBase
{
- virtual wxToolkitInfo& GetToolkitInfo();
};
#endif // platform
projects / wxWidgets.git / blobdiff