docs/latex/wx/apptraits.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        apptraits.tex
   3 %% Purpose:     wxAppTraits
   4 %% Author:      Francesco Montorsi
   5 %% Modified by:
   6 %% Created:     5-7-2006
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWidgets Team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxAppTraits}}\label{wxapptraits}
  13
  14 The {\bf wxAppTraits} class defines various configurable aspects of a \helpref{wxApp}{wxapp}.
  15 You can access it using \helpref{wxApp::GetTraits}{wxappgettraits} function and you can
  16 create your own \helpref{wxAppTraits}{wxapptraits} overriding the
  17 \helpref{wxApp::CreateTraits}{wxappcreatetraits} function.
  18
  19 By default, wxWidgets creates a {\tt wxConsoleAppTraits} object for console applications
  20 (i.e. those applications linked against wxBase library only - see the
  21 \helpref{Libraries list}{librarieslist} page) and a {\tt wxGUIAppTraits} object for GUI
  22 applications.
  23
  24 \wxheading{Derived from}
  25
  26 None
  27
  28 \wxheading{Include files}
  29
  30 <wx/apptrait.h>
  31
  32 \wxheading{See also}
  33
  34 \helpref{wxApp overview}{wxappoverview}, \helpref{wxApp}{wxapp}
  35
  36 \latexignore{\rtfignore{\wxheading{Members}}}
  37
  38
  39 \membersection{wxAppTraits::CreateFontMapper}\label{wxapptraitscreatefontmapper}
  40
  41 \func{virtual wxFontMapper *}{CreateFontMapper}{\void}
  42
  43 Creates the global font mapper object used for encodings/charset mapping.
  44
  45
  46
  47 \membersection{wxAppTraits::CreateLogTarget}\label{wxapptraitscreatelogtarget}
  48
  49 \func{virtual wxLog *}{CreateLogTarget}{\void}
  50
  51 Creates the default log target for the application.
  52
  53
  54 \membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput}
  55
  56 \func{virtual wxMessageOutput *}{CreateMessageOutput}{\void}
  57
  58 Creates the global object used for printing out messages.
  59
  60
  61 \membersection{wxAppTraits::CreateRenderer}\label{wxapptraitscreaterenderer}
  62
  63 \func{virtual wxRendererNative *}{CreateRenderer}{\void}
  64
  65 Returns the renderer to use for drawing the generic controls (return value may be \NULL
  66 in which case the default renderer for the current platform is used);
  67 this is used in GUI mode only and always returns \NULL in console.
  68
  69 NOTE: returned pointer will be deleted by the caller.
  70
  71 \membersection{wxAppTraits::GetDesktopEnvironment}\label{wxapptraitsgetdesktopenvironment}
  72
  73 \constfunc{virtual wxString}{GetDesktopEnvironment}{\void}
  74
  75 This method returns the name of the desktop environment currently
  76 running in a Unix desktop. Currently only "KDE" or "GNOME" are
  77 supported and the code uses the X11 session protocol vendor name
  78 to figure out, which desktop environment is running. The method
  79 returns an empty string otherwise and on all other platforms.
  80
  81 \membersection{wxAppTraits::GetStandardPaths}\label{wxapptraitsgetstandardpaths}
  82
  83 \func{virtual wxStandardPaths \&}{GetStandardPaths}{\void}
  84
  85 Returns the wxStandardPaths object for the application.
  86 It's normally the same for wxBase and wxGUI except in the case of wxMac and wxCocoa.
  87
  88 \membersection{wxAppTraits::GetToolkitVersion}\label{wxapptraitsgettoolkitversion}
  89
  90 \func{virtual wxPortId}{GetToolkitVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
  91
  92 Returns the wxWidgets port ID used by the running program and eventually
  93 fills the given pointers with the values of the major and minor digits
  94 of the native toolkit currently used.
  95 The version numbers returned are thus detected at run-time and not compile-time
  96 (except when this is not possible e.g. wxMotif).
  97
  98 E.g. if your program is using wxGTK port this function will return wxPORT\_GTK and
  99 put in given pointers the versions of the GTK library in use.
 100
 101 See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.
 102
 103
 104 \membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr}
 105
 106 \func{virtual bool}{HasStderr}{\void}
 107
 108 Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise.
 109
 110
 111 \membersection{wxAppTraits::IsUsingUniversalWidgets}\label{wxapptraitsisusinguniversalwidgets}
 112
 113 \constfunc{bool}{IsUsingUniversalWidgets}{\void}
 114
 115 Returns \true if the library was built as wxUniversal. Always returns
 116 \false for wxBase-only apps.
 117
 118
 119 \membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog}
 120
 121 \func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}}
 122
 123 Shows the assert dialog with the specified message in GUI mode or just prints
 124 the string to stderr in console mode.
 125
 126 Returns \true to suppress subsequent asserts, \false to continue as before.
 127