]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/aboutdlginfo.tex
test indeterminate wxGauge mode (part of patch 1551409)
[wxWidgets.git] / docs / latex / wx / aboutdlginfo.tex
CommitLineData
c2709a3d
VZ
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: aboutdlginfo.tex
3%% Purpose: wxAboutDialogInfo documentation
4%% Author: Vadim Zeitlin
5%% Created: 2006-10-08
6%% RCS-ID: $Id$
7%% Copyright: (c) Vadim Zeitlin
8%% License: wxWindows license
9%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10
11\section{\class{wxAboutDialogInfo}}\label{wxaboutdialoginfo}
12
13wxAboutDialogInfo contains information shown in the standard \textit{About}
14dialog displayed by the \helpref{wxAboutBox()}{wxaboutbox} function.
15
16This class contains the general information about the program, such as its
17name, version, copyright and so on, as well as lists of the program developers,
18documentation writers, artists and translators. The simple properties from the
19former group are represented as a string with the exception of the program icon
20and the program web site, while the lists from the latter group are stored as
21\helpref{wxArrayString}{wxarraystring} and can be either set entirely at once
22using \helpref{SetDevelopers}{wxaboutdialoginfosetdevelopers} and similar
23functions or built one by one using \helpref{AddDeveloper}{wxaboutdialoginfoadddeveloper}
24etc.
25
26Please also notice that while all the main platforms have the native
27implementation of the about dialog, they are often more limited than the
28generic version provided by wxWidgets and so the generic version is used if
29wxAboutDialogInfo has any fields not supported by the native version. Currently
30GTK+ version supports all the possible fields natively but MSW and Mac versions
31don't support URLs, licence text nor custom icons in the about dialog and if
32either of those is used, \helpref{wxAboutBox()}{wxaboutbox} will automatically
33use the generic version so you should avoid specifying these fields to achieve
34more native look and feel.
35
36\wxheading{Derived from}
37
38No base class
39
40\wxheading{Include files}
41
42<wx/aboutdlg.h>
43
44
45\latexignore{\rtfignore{\wxheading{Members}}}
46
47
48\membersection{wxAboutDialogInfo::wxAboutDialogInfo}\label{wxaboutdialoginfowxaboutdialoginfo}
49
50\func{}{wxAboutDialogInfo}{\void}
51
52Default constructor leaves all fields are initially uninitialized, in general
53you should call at least \helpref{SetVersion}{wxaboutdialoginfosetversion},
54\helpref{SetCopyright}{wxaboutdialoginfosetcopyright} and
55\helpref{SetDescription}{wxaboutdialoginfosetdescription}.
56
57
58\membersection{wxAboutDialogInfo::AddArtist}\label{wxaboutdialoginfoaddartist}
59
60\func{void}{AddArtist}{\param{const wxString\& }{artist}}
61
62Adds an artist name to be shown in the program credits.
63
64\wxheading{See also}
65
66\helpref{SetArtists}{wxaboutdialoginfosetartists}
67
68
69\membersection{wxAboutDialogInfo::AddDeveloper}\label{wxaboutdialoginfoadddeveloper}
70
71\func{void}{AddDeveloper}{\param{const wxString\& }{developer}}
72
73Adds a developer name to be shown in the program credits.
74
75\wxheading{See also}
76
77\helpref{SetDevelopers}{wxaboutdialoginfosetdevelopers}
78
79
80\membersection{wxAboutDialogInfo::AddDocWriter}\label{wxaboutdialoginfoadddocwriter}
81
82\func{void}{AddDocWriter}{\param{const wxString\& }{docwriter}}
83
84Adds a documentation writer name to be shown in the program credits.
85
86\wxheading{See also}
87
88\helpref{SetDocWriters}{wxaboutdialoginfosetdocwriters}
89
90
91\membersection{wxAboutDialogInfo::AddTranslator}\label{wxaboutdialoginfoaddtranslator}
92
93\func{void}{AddTranslator}{\param{const wxString\& }{translator}}
94
95Adds a translator name to be shown in the program credits. Notice that if no
96translator names are specified explicitely, \helpref{wxAboutBox()}{wxaboutbox}
97will try to use the translation of the string \texttt{translator-credits} from
98the currently used message catalog -- this can be used to show just the name of
99the translator of the program in the current language.
100
101\wxheading{See also}
102
103\helpref{SetTranslators}{wxaboutdialoginfosettranslators}
104
105
106\membersection{wxAboutDialogInfo::SetArtists}\label{wxaboutdialoginfosetartists}
107
108\func{void}{SetArtists}{\param{const wxArrayString\& }{artists}}
109
110Sets the the list of artists to be shown in the program credits.
111
112\wxheading{See also}
113
114\helpref{AddArtist}{wxaboutdialoginfoaddartist}
115
116
117\membersection{wxAboutDialogInfo::SetCopyright}\label{wxaboutdialoginfosetcopyright}
118
119\func{void}{SetCopyright}{\param{const wxString\& }{copyright}}
120
121Set the short string containing the program copyright information. Notice that
122any occurrences of \texttt{"(C)"} in \arg{copyright} will be replaced by the
123copyright symbol (circled C) automatically, which means that you can avoid
124using this symbol in the program source code which can be problematic,
125
126
127\membersection{wxAboutDialogInfo::SetDescription}\label{wxaboutdialoginfosetdescription}
128
129\func{void}{SetDescription}{\param{const wxString\& }{desc}}
130
131Set brief, but possibly multiline, description of the program.
132
133
134\membersection{wxAboutDialogInfo::SetDevelopers}\label{wxaboutdialoginfosetdevelopers}
135
136\func{void}{SetDevelopers}{\param{const wxArrayString\& }{developers}}
137
138Set the list of developers of the program.
139
140\wxheading{See also}
141
142\helpref{AddDeveloper}{wxaboutdialoginfoadddeveloper}
143
144
145\membersection{wxAboutDialogInfo::SetDocWriters}\label{wxaboutdialoginfosetdocwriters}
146
147\func{void}{SetDocWriters}{\param{const wxArrayString\& }{docwriters}}
148
149Set the list of documentation writers.
150
151\wxheading{See also}
152
153\helpref{AddDocWriter}{wxaboutdialoginfoadddocwriter}
154
155
156\membersection{wxAboutDialogInfo::SetIcon}\label{wxaboutdialoginfoseticon}
157
158\func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
159
160Set the icon to be shown in the dialog. By default the icon of the main frame
161will be shown if the native about dialog supports custom icons. If it doesn't
162but a valid icon is specified using this method, the generic about dialog is
163used instead so you should avoid calling this function for maximally native
164look and feel.
165
166
167\membersection{wxAboutDialogInfo::SetLicence}\label{wxaboutdialoginfosetlicence}
168
169\func{void}{SetLicence}{\param{const wxString\& }{licence}}
170
171Set the long, multiline string containing the text of the program licence.
172
173Only GTK+ version supports showing the licence text in the native about dialog
174currently so the generic version will be used under all the other platforms if
175this method is called. To preserve the native look and feel it is advised that
176you do not call this method but provide a separate menu item in the
177\texttt{"Help"} menu for displaying the text of your program licence.
178
179
180\membersection{wxAboutDialogInfo::SetLicense}\label{wxaboutdialoginfosetlicense}
181
182\func{void}{SetLicense}{\param{const wxString\& }{licence}}
183
184This is the same as \helpref{SetLicence}{wxaboutdialoginfosetlicence}.
185
186
187\membersection{wxAboutDialogInfo::SetName}\label{wxaboutdialoginfosetname}
188
189\func{void}{SetName}{\param{const wxString\& }{name}}
190
191Set the name of the program. If this method is not called, the string returned
192by \helpref{wxApp::GetAppName()}{wxappgetappname} will be shown in the dialog.
193
194
195\membersection{wxAboutDialogInfo::SetTranslators}\label{wxaboutdialoginfosettranslators}
196
197\func{void}{SetTranslators}{\param{const wxArrayString\& }{translators}}
198
199Set the list of translators. Please see
200\helpref{AddTranslator}{wxaboutdialoginfoaddtranslator} for additional
201discussion.
202
203
204\membersection{wxAboutDialogInfo::SetVersion}\label{wxaboutdialoginfosetversion}
205
206\func{void}{SetVersion}{\param{const wxString\& }{version}}
207
208Set the version of the program. The version is in free format, i.e. not
209necessarily in the \texttt{x.y.z} form but it shouldn't contain the "version"
210word.
211
212
213\membersection{wxAboutDialogInfo::SetWebSite}\label{wxaboutdialoginfosetwebsite}
214
215\func{void}{SetWebSite}{\param{const wxString\& }{url}, \param{const wxString\& }{desc = wxEmptyString}}
216
217Set the web site for the program and its description (which defaults to URL
218itself if empty).
219
220Please notice that only GTK+ version currently supports showing the link in the
221native about dialog so if this method is called, the generic version will be
222used under all the other platforms.
223
224