]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/aboutdlg.h
Add missing interface items for Phoenix
[wxWidgets.git] / interface / wx / aboutdlg.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: aboutdlg.h
3 // Purpose: interface of wxAboutDialogInfo
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
8
9 /**
10 @class wxAboutDialogInfo
11
12 wxAboutDialogInfo contains information shown in the standard @e About
13 dialog displayed by the wxAboutBox() function.
14
15 This class contains the general information about the program, such as its
16 name, version, copyright and so on, as well as lists of the program developers,
17 documentation writers, artists and translators. The simple properties from the
18 former group are represented as a string with the exception of the program icon
19 and the program web site, while the lists from the latter group are stored as
20 wxArrayString and can be either set entirely at once using
21 wxAboutDialogInfo::SetDevelopers and similar functions or built one by one using
22 wxAboutDialogInfo::AddDeveloper etc.
23
24 Please also notice that while all the main platforms have the native
25 implementation of the about dialog, they are often more limited than the
26 generic version provided by wxWidgets and so the generic version is used if
27 wxAboutDialogInfo has any fields not supported by the native version. Currently
28 GTK+ version supports all the possible fields natively but MSW and Mac versions
29 don't support URLs, licence text nor custom icons in the about dialog and if
30 either of those is used, wxAboutBox() will automatically use the generic version
31 so you should avoid specifying these fields to achieve more native look and feel.
32
33 Example of usage:
34 @code
35 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
36 {
37 wxAboutDialogInfo aboutInfo;
38 aboutInfo.SetName("MyApp");
39 aboutInfo.SetVersion(MY_APP_VERSION_STRING);
40 aboutInfo.SetDescription(_("My wxWidgets-based application!"));
41 aboutInfo.SetCopyright("(C) 1992-2010");
42 aboutInfo.SetWebSite("http://myapp.org");
43 aboutInfo.AddDeveloper("My Self");
44
45 wxAboutBox(aboutInfo);
46 }
47 @endcode
48
49 @library{wxadv}
50 @category{cmndlg,data}
51
52 @see wxAboutDialogInfo::SetArtists
53 */
54 class wxAboutDialogInfo
55 {
56 public:
57 /**
58 Default constructor leaves all fields are initially uninitialized, in general
59 you should call at least SetVersion(), SetCopyright() and SetDescription().
60 */
61 wxAboutDialogInfo();
62
63 /**
64 Adds an artist name to be shown in the program credits.
65
66 @see SetArtists()
67 */
68 void AddArtist(const wxString& artist);
69
70 /**
71 Adds a developer name to be shown in the program credits.
72
73 @see SetDevelopers()
74 */
75 void AddDeveloper(const wxString& developer);
76
77 /**
78 Adds a documentation writer name to be shown in the program credits.
79
80 @see SetDocWriters()
81 */
82 void AddDocWriter(const wxString& docwriter);
83
84 /**
85 Adds a translator name to be shown in the program credits. Notice that if no
86 translator names are specified explicitly, wxAboutBox() will try to use the
87 translation of the string @c translator-credits from the currently used message
88 catalog -- this can be used to show just the name of the translator of the
89 program in the current language.
90
91 @see SetTranslators()
92 */
93 void AddTranslator(const wxString& translator);
94
95 /**
96 Get the name of the program.
97
98 @return Name of the program
99 @see SetName()
100 */
101 wxString GetName() const;
102
103 /**
104 Returns @true if a description string has been specified.
105
106 @see GetDescription()
107 */
108 bool HasDescription() const;
109
110 /**
111 Get the description string.
112
113 @return The description string, free-form.
114 */
115 const wxString& GetDescription();
116
117 /**
118 Returns @true if a copyright string has been specified.
119
120 @see GetCopyright()
121 */
122 bool HasCopyright() const;
123
124 /**
125 Get the copyright string.
126
127 @return The copyright string
128 */
129 const wxString& GetCopyright() const;
130
131 /**
132 Sets the list of artists to be shown in the program credits.
133
134 @see AddArtist()
135 */
136 void SetArtists(const wxArrayString& artists);
137
138 /**
139 Set the short string containing the program copyright information. Notice that
140 any occurrences of @c "(C)" in @a copyright will be replaced by the
141 copyright symbol (circled C) automatically, which means that you can avoid
142 using this symbol in the program source code which can be problematic,
143 */
144 void SetCopyright(const wxString& copyright);
145
146 /**
147 Set brief, but possibly multiline, description of the program.
148 */
149 void SetDescription(const wxString& desc);
150
151 /**
152 Set the list of developers of the program.
153
154 @see AddDeveloper()
155 */
156 void SetDevelopers(const wxArrayString& developers);
157
158 /**
159 Set the list of documentation writers.
160
161 @see AddDocWriter()
162 */
163 void SetDocWriters(const wxArrayString& docwriters);
164
165 /**
166 Set the icon to be shown in the dialog. By default the icon of the main frame
167 will be shown if the native about dialog supports custom icons. If it doesn't
168 but a valid icon is specified using this method, the generic about dialog is
169 used instead so you should avoid calling this function for maximally native
170 look and feel.
171 */
172 void SetIcon(const wxIcon& icon);
173
174 /**
175 Set the long, multiline string containing the text of the program licence.
176
177 Only GTK+ version supports showing the licence text in the native about dialog
178 currently so the generic version will be used under all the other platforms if
179 this method is called. To preserve the native look and feel it is advised that
180 you do not call this method but provide a separate menu item in the
181 @c "Help" menu for displaying the text of your program licence.
182 */
183 void SetLicence(const wxString& licence);
184
185 /**
186 This is the same as SetLicence().
187 */
188 void SetLicense(const wxString& licence);
189
190 /**
191 Set the name of the program. If this method is not called, the string returned
192 by wxApp::GetAppName will be shown in the dialog.
193 */
194 void SetName(const wxString& name);
195
196 /**
197 Set the list of translators. Please see AddTranslator() for additional
198 discussion.
199 */
200 void SetTranslators(const wxArrayString& translators);
201
202 /**
203 Set the version of the program. The word "version" shouldn't be included
204 in @a version. Example @a version values: "1.2" and "RC2". In about dialogs
205 with more space set aside for version information, @a longVersion is used.
206 Example @a longVersion values: "Version 1.2" and "Release Candidate 2".
207 If @a version is non-empty but @a longVersion is empty, a long version
208 is constructed automatically, using @a version (by simply prepending
209 "Version " to @a version).
210
211 The generic about dialog and native GTK+ dialog use @a version only,
212 as a suffix to the program name. The native MSW and OS X about dialogs
213 use the long version.
214 */
215 void SetVersion(const wxString& version, const wxString& longVersion = wxString());
216
217 /**
218 Set the web site for the program and its description (which defaults to @a url
219 itself if empty).
220
221 Please notice that only GTK+ version currently supports showing the link in the
222 native about dialog so if this method is called, the generic version will be
223 used under all the other platforms.
224 */
225 void SetWebSite(const wxString& url,
226 const wxString& desc = wxEmptyString);
227 };
228
229
230 // ============================================================================
231 // Global functions/macros
232 // ============================================================================
233
234 /** @addtogroup group_funcmacro_dialog */
235 //@{
236
237 /**
238 This function shows the standard about dialog containing the information
239 specified in @a info. If the current platform has a native about dialog
240 which is capable of showing all the fields in @a info, the native dialog is
241 used, otherwise the function falls back to the generic wxWidgets version of
242 the dialog, i.e. does the same thing as wxGenericAboutBox.
243
244 Here is an example of how this function may be used:
245
246 @code
247 void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event))
248 {
249 wxAboutDialogInfo info;
250 info.SetName(_("My Program"));
251 info.SetVersion(_("1.2.3 Beta"));
252 info.SetDescription(_("This program does something great."));
253 info.SetCopyright(wxT("(C) 2007 Me <my@email.addre.ss>"));
254
255 wxAboutBox(info);
256 }
257 @endcode
258
259 Please see the @ref page_samples_dialogs for more examples of using this
260 function and wxAboutDialogInfo for the description of the information which
261 can be shown in the about dialog.
262
263 @header{wx/aboutdlg.h}
264 */
265 void wxAboutBox(const wxAboutDialogInfo& info, wxWindow* parent = NULL);
266
267 /**
268 This function does the same thing as wxAboutBox() except that it always uses
269 the generic wxWidgets version of the dialog instead of the native one.
270
271 This is mainly useful if you need to customize the dialog by e.g. adding
272 custom controls to it (customizing the native dialog is not currently
273 supported).
274
275 See the @ref page_samples_dialogs for an example of about dialog
276 customization.
277
278 @see wxAboutDialogInfo
279
280 @header{wx/aboutdlg.h}
281 */
282 void wxGenericAboutBox(const wxAboutDialogInfo& info, wxWindow* parent = NULL);
283
284 //@}