include/wx/apptrait.h

   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$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_APPTRAIT_H_
  13 #define _WX_APPTRAIT_H_
  14
  15 #include "wx/string.h"
  16 #include "wx/platinfo.h"
  17
  18 class WXDLLIMPEXP_BASE wxObject;
  19 class WXDLLEXPORT wxAppTraits;
  20 #if wxUSE_FONTMAP
  21     class WXDLLEXPORT wxFontMapper;
  22 #endif // wxUSE_FONTMAP
  23 class WXDLLIMPEXP_BASE wxLog;
  24 class WXDLLIMPEXP_BASE wxMessageOutput;
  25 class WXDLLEXPORT wxRendererNative;
  26 class WXDLLIMPEXP_BASE wxString;
  27
  28 class GSocketGUIFunctionsTable;
  29
  30
  31 // ----------------------------------------------------------------------------
  32 // wxAppTraits: this class defines various configurable aspects of wxApp
  33 // ----------------------------------------------------------------------------
  34
  35 class WXDLLIMPEXP_BASE wxStandardPathsBase;
  36
  37 class WXDLLIMPEXP_BASE wxAppTraitsBase
  38 {
  39 public:
  40     // needed since this class declares virtual members
  41     virtual ~wxAppTraitsBase() { }
  42
  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
  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
  66 #if wxUSE_STDPATHS
  67     // wxStandardPaths object is normally the same for wxBase and wxGUI
  68     // except in the case of wxMac and wxCocoa
  69     virtual wxStandardPathsBase& GetStandardPaths();
  70 #endif // wxUSE_STDPATHS
  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;
 102
 103 #if wxUSE_SOCKETS
 104     // return table of GUI callbacks for GSocket code or NULL in wxBase. This
 105     // is needed because networking classes are in their own library and so
 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
 110     virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable() = 0;
 111 #endif
 112
 113     // return information about the (native) toolkit currently used and its
 114     // runtime (not compile-time) version.
 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;
 118
 119     // return true if the port is using wxUniversal for the GUI, false if not
 120     virtual bool IsUsingUniversalWidgets() const = 0;
 121
 122     // return the name of the Desktop Environment such as
 123     // "KDE" or "GNOME". May return an empty string.
 124     virtual wxString GetDesktopEnvironment() const { return wxEmptyString; }
 125 };
 126
 127 // ----------------------------------------------------------------------------
 128 // include the platform-specific version of the class
 129 // ----------------------------------------------------------------------------
 130
 131 // NB:  test for __UNIX__ before __WXMAC__ as under Darwin we want to use the
 132 //      Unix code (and otherwise __UNIX__ wouldn't be defined)
 133 // ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port
 134 #if defined(__WXPALMOS__)
 135     #include "wx/palmos/apptbase.h"
 136 #elif defined(__WIN32__)
 137     #include "wx/msw/apptbase.h"
 138 #elif defined(__UNIX__) && !defined(__EMX__)
 139     #include "wx/unix/apptbase.h"
 140 #elif defined(__WXMAC__)
 141     #include "wx/mac/apptbase.h"
 142 #elif defined(__OS2__)
 143     #include "wx/os2/apptbase.h"
 144 #else // no platform-specific methods to add to wxAppTraits
 145     // wxAppTraits must be a class because it was forward declared as class
 146     class WXDLLIMPEXP_BASE wxAppTraits : public wxAppTraitsBase
 147     {
 148     };
 149 #endif // platform
 150
 151 // ============================================================================
 152 // standard traits for console and GUI applications
 153 // ============================================================================
 154
 155 // ----------------------------------------------------------------------------
 156 // wxConsoleAppTraitsBase: wxAppTraits implementation for the console apps
 157 // ----------------------------------------------------------------------------
 158
 159 class WXDLLIMPEXP_BASE wxConsoleAppTraitsBase : public wxAppTraits
 160 {
 161 public:
 162 #if wxUSE_LOG
 163     virtual wxLog *CreateLogTarget();
 164 #endif // wxUSE_LOG
 165     virtual wxMessageOutput *CreateMessageOutput();
 166 #if wxUSE_FONTMAP
 167     virtual wxFontMapper *CreateFontMapper();
 168 #endif // wxUSE_FONTMAP
 169     virtual wxRendererNative *CreateRenderer();
 170 #if wxUSE_SOCKETS
 171     virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
 172 #endif
 173
 174 #ifdef __WXDEBUG__
 175     virtual bool ShowAssertDialog(const wxString& msg);
 176 #endif // __WXDEBUG__
 177     virtual bool HasStderr();
 178
 179     virtual void ScheduleForDestroy(wxObject *object);
 180     virtual void RemoveFromPendingDelete(wxObject *object);
 181
 182     // the GetToolkitVersion for console application is always the same
 183     virtual wxPortId GetToolkitVersion(int *verMaj, int *verMin) const
 184     {
 185         // no toolkits (wxBase is for console applications without GUI support)
 186         // NB: zero means "no toolkit", -1 means "not initialized yet"
 187         //     so we must use zero here!
 188         if (verMaj) *verMaj = 0;
 189         if (verMin) *verMin = 0;
 190         return wxPORT_BASE;
 191     }
 192
 193     virtual bool IsUsingUniversalWidgets() const { return false; }
 194 };
 195
 196 // ----------------------------------------------------------------------------
 197 // wxGUIAppTraitsBase: wxAppTraits implementation for the GUI apps
 198 // ----------------------------------------------------------------------------
 199
 200 #if wxUSE_GUI
 201
 202 class WXDLLEXPORT wxGUIAppTraitsBase : public wxAppTraits
 203 {
 204 public:
 205 #if wxUSE_LOG
 206     virtual wxLog *CreateLogTarget();
 207 #endif // wxUSE_LOG
 208     virtual wxMessageOutput *CreateMessageOutput();
 209 #if wxUSE_FONTMAP
 210     virtual wxFontMapper *CreateFontMapper();
 211 #endif // wxUSE_FONTMAP
 212     virtual wxRendererNative *CreateRenderer();
 213 #if wxUSE_SOCKETS
 214     virtual GSocketGUIFunctionsTable* GetSocketGUIFunctionsTable();
 215 #endif
 216
 217 #ifdef __WXDEBUG__
 218     virtual bool ShowAssertDialog(const wxString& msg);
 219 #endif // __WXDEBUG__
 220     virtual bool HasStderr();
 221
 222     virtual void ScheduleForDestroy(wxObject *object);
 223     virtual void RemoveFromPendingDelete(wxObject *object);
 224
 225     virtual bool IsUsingUniversalWidgets() const
 226     {
 227     #ifdef __WXUNIVERSAL__
 228         return true;
 229     #else
 230         return false;
 231     #endif
 232     }
 233 };
 234
 235 #endif // wxUSE_GUI
 236
 237 // ----------------------------------------------------------------------------
 238 // include the platform-specific version of the classes above
 239 // ----------------------------------------------------------------------------
 240
 241 // ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port
 242 #if defined(__WXPALMOS__)
 243     #include "wx/palmos/apptrait.h"
 244 #elif defined(__WIN32__)
 245     #include "wx/msw/apptrait.h"
 246 #elif defined(__UNIX__) && !defined(__EMX__)
 247     #include "wx/unix/apptrait.h"
 248 #elif defined(__WXMAC__)
 249     #include "wx/mac/apptrait.h"
 250 #elif defined(__WXPM__)
 251     #include "wx/os2/apptrait.h"
 252 #elif defined(__DOS__)
 253     #include "wx/msdos/apptrait.h"
 254 #else
 255     #if wxUSE_GUI
 256         class wxGUIAppTraits : public wxGUIAppTraitsBase
 257         {
 258         };
 259     #endif // wxUSE_GUI
 260     class wxConsoleAppTraits: public wxConsoleAppTraitsBase
 261     {
 262     };
 263 #endif // platform
 264
 265 #endif // _WX_APPTRAIT_H_
 266