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