]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/apptraits.tex
Always use wxFULL_REPAINT_ON_RESIZE for generic status bar.
[wxWidgets.git] / docs / latex / wx / apptraits.tex
CommitLineData
afdf936c
VZ
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
14The {\bf wxAppTraits} class defines various configurable aspects of a \helpref{wxApp}{wxapp}.
15You can access it using \helpref{wxApp::GetTraits}{wxappgettraits} function and you can
16create your own \helpref{wxAppTraits}{wxapptraits} overriding the
17\helpref{wxApp::CreateTraits}{wxappcreatetraits} function.
18
19By 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
22applications.
23
24\wxheading{Derived from}
25
26None
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
b98bd6af 39\membersection{wxAppTraits::CreateFontMapper}\label{wxapptraitscreatefontmapper}
8bb6b2c0 40
b98bd6af 41\func{virtual wxFontMapper *}{CreateFontMapper}{\void}
8bb6b2c0 42
b98bd6af 43Creates the global font mapper object used for encodings/charset mapping.
8bb6b2c0 44
8bb6b2c0 45
afdf936c 46
b98bd6af 47\membersection{wxAppTraits::CreateLogTarget}\label{wxapptraitscreatelogtarget}
afdf936c 48
b98bd6af 49\func{virtual wxLog *}{CreateLogTarget}{\void}
afdf936c 50
b98bd6af 51Creates the default log target for the application.
afdf936c 52
afdf936c 53
b98bd6af 54\membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput}
afdf936c 55
b98bd6af 56\func{virtual wxMessageOutput *}{CreateMessageOutput}{\void}
afdf936c 57
b98bd6af 58Creates the global object used for printing out messages.
afdf936c 59
afdf936c 60
b98bd6af 61\membersection{wxAppTraits::CreateRenderer}\label{wxapptraitscreaterenderer}
afdf936c 62
b98bd6af 63\func{virtual wxRendererNative *}{CreateRenderer}{\void}
afdf936c 64
b98bd6af
VS
65Returns the renderer to use for drawing the generic controls (return value may be \NULL
66in which case the default renderer for the current platform is used);
67this is used in GUI mode only and always returns \NULL in console.
afdf936c 68
b98bd6af 69NOTE: returned pointer will be deleted by the caller.
afdf936c
VZ
70
71
72\membersection{wxAppTraits::GetStandardPaths}\label{wxapptraitsgetstandardpaths}
73
74\func{virtual wxStandardPaths \&}{GetStandardPaths}{\void}
75
76Returns the wxStandardPaths object for the application.
77It's normally the same for wxBase and wxGUI except in the case of wxMac and wxCocoa.
78
b98bd6af 79\membersection{wxAppTraits::GetToolkitVersion}\label{wxapptraitsgettoolkitversion}
afdf936c 80
b98bd6af 81\func{virtual wxPortId}{GetToolkitVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
afdf936c 82
b98bd6af
VS
83Returns the wxWidgets port ID used by the running program and eventually
84fills the given pointers with the values of the major and minor digits
85of the native toolkit currently used.
afdf936c 86
dabb05ac 87E.g. if your program is using wxGTK port this function will return wxPORT\_GTK and
b98bd6af 88put in given pointers the versions of the GTK library in use.
afdf936c 89
b98bd6af 90See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.
afdf936c 91
afdf936c 92
b98bd6af 93\membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr}
afdf936c 94
b98bd6af 95\func{virtual bool}{HasStderr}{\void}
afdf936c 96
b98bd6af 97Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise.
afdf936c 98
afdf936c 99
b98bd6af 100\membersection{wxAppTraits::IsUsingUniversalWidgets}\label{wxapptraitsisusinguniversalwidgets}
afdf936c 101
b98bd6af 102\constfunc{bool}{IsUsingUniversalWidgets}{\void}
afdf936c 103
b98bd6af
VS
104Returns \true if the library was built as wxUniversal. Always returns
105\false for wxBase-only apps.
afdf936c 106
afdf936c 107
b98bd6af 108\membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog}
afdf936c 109
b98bd6af 110\func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}}
afdf936c 111
b98bd6af
VS
112Shows the assert dialog with the specified message in GUI mode or just prints
113the string to stderr in console mode.
afdf936c 114
b98bd6af 115Returns \true to suppress subsequent asserts, \false to continue as before.