/////////////////////////////////////////////////////////////////////////////
// Name: aboutdlg.h
-// Purpose: documentation for wxAboutDialogInfo class
+// Purpose: interface of wxAboutDialogInfo
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@wxheader{aboutdlg.h}
wxAboutDialogInfo contains information shown in the standard @e About
- dialog displayed by the wxAboutBox function.
+ dialog displayed by the wxAboutBox() function.
This class contains the general information about the program, such as its
name, version, copyright and so on, as well as lists of the program developers,
documentation writers, artists and translators. The simple properties from the
former group are represented as a string with the exception of the program icon
and the program web site, while the lists from the latter group are stored as
- wxArrayString and can be either set entirely at once
- using wxAboutDialogInfo::SetDevelopers and similar
- functions or built one by one using wxAboutDialogInfo::AddDeveloper
- etc.
+ wxArrayString and can be either set entirely at once using
+ wxAboutDialogInfo::SetDevelopers and similar functions or built one by one using
+ wxAboutDialogInfo::AddDeveloper etc.
Please also notice that while all the main platforms have the native
implementation of the about dialog, they are often more limited than the
wxAboutDialogInfo has any fields not supported by the native version. Currently
GTK+ version supports all the possible fields natively but MSW and Mac versions
don't support URLs, licence text nor custom icons in the about dialog and if
- either of those is used, wxAboutBox will automatically
- use the generic version so you should avoid specifying these fields to achieve
- more native look and feel.
+ either of those is used, wxAboutBox() will automatically use the generic version
+ so you should avoid specifying these fields to achieve more native look and feel.
@library{wxadv}
- @category{FIXME}
+ @category{misc}
- @seealso
- wxAboutDialogInfo::SetArtists
+ @see wxAboutDialogInfo::SetArtists
*/
class wxAboutDialogInfo
{
/**
Adds an artist name to be shown in the program credits.
- @sa SetArtists()
+ @see SetArtists()
*/
void AddArtist(const wxString& artist);
/**
Adds a developer name to be shown in the program credits.
- @sa SetDevelopers()
+ @see SetDevelopers()
*/
void AddDeveloper(const wxString& developer);
/**
Adds a documentation writer name to be shown in the program credits.
- @sa SetDocWriters()
+ @see SetDocWriters()
*/
void AddDocWriter(const wxString& docwriter);
/**
Adds a translator name to be shown in the program credits. Notice that if no
- translator names are specified explicitely, wxAboutBox will try to use the
+ translator names are specified explicitely, wxAboutBox() will try to use the
translation of the string @c translator-credits from the currently used message
catalog -- this can be used to show just the name of the translator of the
program in the current language.
- @sa SetTranslators()
+ @see SetTranslators()
*/
void AddTranslator(const wxString& translator);
/**
Sets the the list of artists to be shown in the program credits.
- @sa AddArtist()
+ @see AddArtist()
*/
void SetArtists(const wxArrayString& artists);
/**
- Set the short string containing the program copyright information. Notice
- that any occurrences of @c "(C)" in @e copyright will be replaced by the
+ Set the short string containing the program copyright information. Notice that
+ any occurrences of @c "(C)" in @a copyright will be replaced by the
copyright symbol (circled C) automatically, which means that you can avoid
using this symbol in the program source code which can be problematic,
*/
/**
Set the list of developers of the program.
- @sa AddDeveloper()
+ @see AddDeveloper()
*/
void SetDevelopers(const wxArrayString& developers);
/**
Set the list of documentation writers.
- @sa AddDocWriter()
+ @see AddDocWriter()
*/
void SetDocWriters(const wxArrayString& docwriters);
/**
Set the long, multiline string containing the text of the program licence.
-
+
Only GTK+ version supports showing the licence text in the native about dialog
currently so the generic version will be used under all the other platforms if
this method is called. To preserve the native look and feel it is advised that
void SetVersion(const wxString& version);
/**
- Set the web site for the program and its description (which defaults to URL
+ Set the web site for the program and its description (which defaults to @a url
itself if empty).
-
+
Please notice that only GTK+ version currently supports showing the link in the
native about dialog so if this method is called, the generic version will be
used under all the other platforms.
/**
This function shows the standard about dialog containing the information
- specified in @e info. If the current platform has a native about dialog
- which is capable of showing all the fields in @e info, the native dialog is
- used, otherwise the function falls back to the generic wxWidgets version of the
- dialog, i.e. does the same thing as wxGenericAboutBox.
+ specified in @a info. If the current platform has a native about dialog
+ which is capable of showing all the fields in @a info, the native dialog is
+ used, otherwise the function falls back to the generic wxWidgets version of
+ the dialog, i.e. does the same thing as wxGenericAboutBox.
Here is an example of how this function may be used:
}
@endcode
- Please see the @ref overview_sampledialogs "dialogs sample" for more examples of
- using this function and wxAboutDialogInfo for the
- description of the information which can be shown in the about dialog.
+ Please see the @ref page_utils_samples_dialogs for more examples of
+ using this function and wxAboutDialogInfo for the description of the
+ information which can be shown in the about dialog.
*/
void wxAboutBox(const wxAboutDialogInfo& info);
/**
- This function does the same thing as wxAboutBox except
- that it always uses the generic wxWidgets version of the dialog instead of the
- native one. This is mainly useful if you need to customize the dialog by e.g.
- adding custom controls to it (customizing the native dialog is not currently
+ This function does the same thing as wxAboutBox() except that it always uses
+ the generic wxWidgets version of the dialog instead of the native one.
+
+ This is mainly useful if you need to customize the dialog by e.g. adding
+ custom controls to it (customizing the native dialog is not currently
supported).
- See the @ref overview_sampledialogs "dialogs sample" for an example of about
- dialog customization.
+ See the @ref page_utils_samples_dialogs for an example of about dialog
+ customization.
- @sa wxAboutDialogInfo
+ @see wxAboutDialogInfo
*/
void wxGenericAboutBox(const wxAboutDialogInfo& info);
projects / wxWidgets.git / blobdiff