]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/apptraits.tex
cleanup (mainly wrapping lines to be < 80 chars); added IsExpanded()
[wxWidgets.git] / docs / latex / wx / apptraits.tex
... / ...
CommitLineData
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
39\membersection{wxAppTraits::CreateFontMapper}\label{wxapptraitscreatefontmapper}
40
41\func{virtual wxFontMapper *}{CreateFontMapper}{\void}
42
43Creates 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
51Creates the default log target for the application.
52
53
54\membersection{wxAppTraits::CreateMessageOutput}\label{wxapptraitscreatemessageoutput}
55
56\func{virtual wxMessageOutput *}{CreateMessageOutput}{\void}
57
58Creates the global object used for printing out messages.
59
60
61\membersection{wxAppTraits::CreateRenderer}\label{wxapptraitscreaterenderer}
62
63\func{virtual wxRendererNative *}{CreateRenderer}{\void}
64
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.
68
69NOTE: returned pointer will be deleted by the caller.
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
79\membersection{wxAppTraits::GetToolkitVersion}\label{wxapptraitsgettoolkitversion}
80
81\func{virtual wxPortId}{GetToolkitVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
82
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.
86The version numbers returned are thus detected at run-time and not compile-time
87(except when this is not possible e.g. wxMotif).
88
89E.g. if your program is using wxGTK port this function will return wxPORT\_GTK and
90put in given pointers the versions of the GTK library in use.
91
92See \helpref{wxPlatformInfo}{wxplatforminfo} for more details.
93
94
95\membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr}
96
97\func{virtual bool}{HasStderr}{\void}
98
99Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise.
100
101
102\membersection{wxAppTraits::IsUsingUniversalWidgets}\label{wxapptraitsisusinguniversalwidgets}
103
104\constfunc{bool}{IsUsingUniversalWidgets}{\void}
105
106Returns \true if the library was built as wxUniversal. Always returns
107\false for wxBase-only apps.
108
109
110\membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog}
111
112\func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}}
113
114Shows the assert dialog with the specified message in GUI mode or just prints
115the string to stderr in console mode.
116
117Returns \true to suppress subsequent asserts, \false to continue as before.
118