]>
Commit | Line | Data |
---|---|---|
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 | ||
72 | \membersection{wxAppTraits::GetStandardPaths}\label{wxapptraitsgetstandardpaths} | |
73 | ||
74 | \func{virtual wxStandardPaths \&}{GetStandardPaths}{\void} | |
75 | ||
76 | Returns the wxStandardPaths object for the application. | |
77 | It'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 | ||
83 | Returns the wxWidgets port ID used by the running program and eventually | |
84 | fills the given pointers with the values of the major and minor digits | |
85 | of the native toolkit currently used. | |
86 | ||
87 | E.g. if your program is using wxGTK port this function will return wxPORT\_GTK and | |
88 | put in given pointers the versions of the GTK library in use. | |
89 | ||
90 | See \helpref{wxPlatformInfo}{wxplatforminfo} for more details. | |
91 | ||
92 | ||
93 | \membersection{wxAppTraits::HasStderr}\label{wxapptraitshasstderr} | |
94 | ||
95 | \func{virtual bool}{HasStderr}{\void} | |
96 | ||
97 | Returns \true if {\tt fprintf(stderr)} goes somewhere, \false otherwise. | |
98 | ||
99 | ||
100 | \membersection{wxAppTraits::IsUsingUniversalWidgets}\label{wxapptraitsisusinguniversalwidgets} | |
101 | ||
102 | \constfunc{bool}{IsUsingUniversalWidgets}{\void} | |
103 | ||
104 | Returns \true if the library was built as wxUniversal. Always returns | |
105 | \false for wxBase-only apps. | |
106 | ||
107 | ||
108 | \membersection{wxAppTraits::ShowAssertDialog}\label{wxapptraitsshowassertdialog} | |
109 | ||
110 | \func{virtual bool}{ShowAssertDialog}{\param{const wxString \&}{ msg}} | |
111 | ||
112 | Shows the assert dialog with the specified message in GUI mode or just prints | |
113 | the string to stderr in console mode. | |
114 | ||
115 | Returns \true to suppress subsequent asserts, \false to continue as before. |