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::GetPlatformInfo}\label{wxapptraitsgetplatforminfo}
  40
  41 \func{virtual wxPlatformInfo \&}{GetPlatformInfo}{\void}
  42
  43 Returns information about which platform is the program running on.
  44 See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.
  45
  46
  47 \membersection{wxAppTraits::GetToolkitVersion}\label{wxapptraitsgettoolkitversion}
  48
  49 \func{virtual wxPortId}{GetToolkitVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
  50
  51 Returns the wxWidgets port ID used by the running program and eventually
  52 fills the given pointers with the values of the major and minor digits
  53 of the native toolkit currently used.
  54
  55 E.g. if your program is using wxGTK port this function will return wxPORT_GTK and
  56 put in given pointers the versions of the GTK library in use.
  57
  58 See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.
  59
  60
  61
  62 \membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr}
  63
  64 \func{virtual bool}{HasStderr}{\void}
  65
  66 Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise.
  67
  68
  69
  70 \membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog}
  71
  72 \func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}}
  73
  74 Shows the assert dialog with the specified message in GUI mode or just prints
  75 the string to stderr in console mode.
  76
  77 Returns \true to suppress subsequent asserts, \false to continue as before.
  78
  79
  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
  89
  90 \membersection{wxAppTraits::CreateRenderer}\label{wxapptraitscreaterenderer}
  91
  92 \func{virtual wxRendererNative *}{CreateRenderer}{\void}
  93
  94 Returns the renderer to use for drawing the generic controls (return value may be \NULL
  95 in which case the default renderer for the current platform is used);
  96 this is used in GUI mode only and always returns \NULL in console.
  97
  98 NOTE: returned pointer will be deleted by the caller.
  99
 100
 101
 102 \membersection{wxAppTraits::CreateLogTarget}\label{wxapptraitscreatelogtarget}
 103
 104 \func{virtual wxLog *}{CreateLogTarget}{\void}
 105
 106 Creates the default log target for the application.
 107
 108
 109
 110 \membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput}
 111
 112 \func{virtual wxMessageOutput *}{CreateMessageOutput}{\void}
 113
 114 Creates the global object used for printing out messages.
 115
 116
 117
 118 \membersection{wxAppTraits::CreateFontMapper}\label{wxapptraitscreatefontmapper}
 119
 120 \func{virtual wxFontMapper *}{CreateFontMapper}{\void}
 121
 122 Creates the global font mapper object used for encodings/charset mapping.
 123
 124