interface/aboutdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        aboutdlg.h
   3 // Purpose:     documentation for wxAboutDialogInfo class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxAboutDialogInfo
  11     @wxheader{aboutdlg.h}
  12
  13     wxAboutDialogInfo contains information shown in the standard @e About
  14     dialog displayed by the wxAboutBox function.
  15
  16     This class contains the general information about the program, such as its
  17     name, version, copyright and so on, as well as lists of the program developers,
  18     documentation writers, artists and translators. The simple properties from the
  19     former group are represented as a string with the exception of the program icon
  20     and the program web site, while the lists from the latter group are stored as
  21     wxArrayString and can be either set entirely at once
  22     using wxAboutDialogInfo::SetDevelopers and similar
  23     functions or built one by one using wxAboutDialogInfo::AddDeveloper
  24     etc.
  25
  26     Please also notice that while all the main platforms have the native
  27     implementation of the about dialog, they are often more limited than the
  28     generic version provided by wxWidgets and so the generic version is used if
  29     wxAboutDialogInfo has any fields not supported by the native version. Currently
  30     GTK+ version supports all the possible fields natively but MSW and Mac versions
  31     don't support URLs, licence text nor custom icons in the about dialog and if
  32     either of those is used, wxAboutBox will automatically
  33     use the generic version so you should avoid specifying these fields to achieve
  34     more native look and feel.
  35
  36     @library{wxadv}
  37     @category{FIXME}
  38
  39     @seealso
  40     wxAboutDialogInfo::SetArtists
  41 */
  42 class wxAboutDialogInfo
  43 {
  44 public:
  45     /**
  46         Default constructor leaves all fields are initially uninitialized, in general
  47         you should call at least SetVersion(), SetCopyright() and SetDescription().
  48     */
  49     wxAboutDialogInfo();
  50
  51     /**
  52         Adds an artist name to be shown in the program credits.
  53
  54         @sa SetArtists()
  55     */
  56     void AddArtist(const wxString& artist);
  57
  58     /**
  59         Adds a developer name to be shown in the program credits.
  60
  61         @sa SetDevelopers()
  62     */
  63     void AddDeveloper(const wxString& developer);
  64
  65     /**
  66         Adds a documentation writer name to be shown in the program credits.
  67
  68         @sa SetDocWriters()
  69     */
  70     void AddDocWriter(const wxString& docwriter);
  71
  72     /**
  73         Adds a translator name to be shown in the program credits. Notice that if no
  74         translator names are specified explicitely, wxAboutBox will try to use the
  75         translation of the string @c translator-credits from the currently used message
  76         catalog -- this can be used to show just the name of the translator of the
  77         program in the current language.
  78
  79         @sa SetTranslators()
  80     */
  81     void AddTranslator(const wxString& translator);
  82
  83     /**
  84         Sets the the list of artists to be shown in the program credits.
  85
  86         @sa AddArtist()
  87     */
  88     void SetArtists(const wxArrayString& artists);
  89
  90     /**
  91         Set the short string containing the program copyright information. Notice
  92         that any occurrences of @c "(C)" in @e copyright will be replaced by the
  93         copyright symbol (circled C) automatically, which means that you can avoid
  94         using this symbol in the program source code which can be problematic,
  95     */
  96     void SetCopyright(const wxString& copyright);
  97
  98     /**
  99         Set brief, but possibly multiline, description of the program.
 100     */
 101     void SetDescription(const wxString& desc);
 102
 103     /**
 104         Set the list of developers of the program.
 105
 106         @sa AddDeveloper()
 107     */
 108     void SetDevelopers(const wxArrayString& developers);
 109
 110     /**
 111         Set the list of documentation writers.
 112
 113         @sa AddDocWriter()
 114     */
 115     void SetDocWriters(const wxArrayString& docwriters);
 116
 117     /**
 118         Set the icon to be shown in the dialog. By default the icon of the main frame
 119         will be shown if the native about dialog supports custom icons. If it doesn't
 120         but a valid icon is specified using this method, the generic about dialog is
 121         used instead so you should avoid calling this function for maximally native
 122         look and feel.
 123     */
 124     void SetIcon(const wxIcon& icon);
 125
 126     /**
 127         Set the long, multiline string containing the text of the program licence.
 128
 129         Only GTK+ version supports showing the licence text in the native about dialog
 130         currently so the generic version will be used under all the other platforms if
 131         this method is called. To preserve the native look and feel it is advised that
 132         you do not call this method but provide a separate menu item in the
 133         @c "Help" menu for displaying the text of your program licence.
 134     */
 135     void SetLicence(const wxString& licence);
 136
 137     /**
 138         This is the same as SetLicence().
 139     */
 140     void SetLicense(const wxString& licence);
 141
 142     /**
 143         Set the name of the program. If this method is not called, the string returned
 144         by wxApp::GetAppName will be shown in the dialog.
 145     */
 146     void SetName(const wxString& name);
 147
 148     /**
 149         Set the list of translators. Please see AddTranslator() for additional
 150         discussion.
 151     */
 152     void SetTranslators(const wxArrayString& translators);
 153
 154     /**
 155         Set the version of the program. The version is in free format, i.e. not
 156         necessarily in the @c x.y.z form but it shouldn't contain the "version" word.
 157     */
 158     void SetVersion(const wxString& version);
 159
 160     /**
 161         Set the web site for the program and its description (which defaults to URL
 162         itself if empty).
 163
 164         Please notice that only GTK+ version currently supports showing the link in the
 165         native about dialog so if this method is called, the generic version will be
 166         used under all the other platforms.
 167     */
 168     void SetWebSite(const wxString& url,
 169                     const wxString& desc = wxEmptyString);
 170 };
 171
 172
 173 // ============================================================================
 174 // Global functions/macros
 175 // ============================================================================
 176
 177 /**
 178     This function shows the standard about dialog containing the information
 179     specified in @e info. If the current platform has a native about dialog
 180     which is capable of showing all the fields in @e info, the native dialog is
 181     used, otherwise the function falls back to the generic wxWidgets version of the
 182     dialog, i.e. does the same thing as wxGenericAboutBox.
 183
 184     Here is an example of how this function may be used:
 185
 186     @code
 187     void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event))
 188     {
 189         wxAboutDialogInfo info;
 190         info.SetName(_("My Program"));
 191         info.SetVersion(_("1.2.3 Beta"));
 192         info.SetDescription(_("This program does something great."));
 193         info.SetCopyright(_T("(C) 2007 Me my@email.addre.ss"));
 194
 195         wxAboutBox(info);
 196     }
 197     @endcode
 198
 199     Please see the @ref overview_sampledialogs "dialogs sample" for more examples of
 200     using this function and wxAboutDialogInfo for the
 201     description of the information which can be shown in the about dialog.
 202 */
 203 void wxAboutBox(const wxAboutDialogInfo& info);
 204
 205 /**
 206     This function does the same thing as wxAboutBox except
 207     that it always uses the generic wxWidgets version of the dialog instead of the
 208     native one. This is mainly useful if you need to customize the dialog by e.g.
 209     adding custom controls to it (customizing the native dialog is not currently
 210     supported).
 211
 212     See the @ref overview_sampledialogs "dialogs sample" for an example of about
 213     dialog customization.
 214
 215     @sa wxAboutDialogInfo
 216 */
 217 void wxGenericAboutBox(const wxAboutDialogInfo& info);
 218