docs/latex/wx/aboutdlginfo.tex

   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
  13 wxAboutDialogInfo contains information shown in the standard \textit{About}
  14 dialog displayed by the \helpref{wxAboutBox()}{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 \helpref{wxArrayString}{wxarraystring} and can be either set entirely at once
  22 using \helpref{SetDevelopers}{wxaboutdialoginfosetdevelopers} and similar
  23 functions or built one by one using \helpref{AddDeveloper}{wxaboutdialoginfoadddeveloper}
  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, \helpref{wxAboutBox()}{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 \wxheading{Derived from}
  37
  38 No base class
  39
  40 \wxheading{Include files}
  41
  42 <wx/aboutdlg.h>
  43
  44 \wxheading{Library}
  45
  46 \helpref{wxAdv}{librarieslist}
  47
  48
  49 \latexignore{\rtfignore{\wxheading{Members}}}
  50
  51
  52 \membersection{wxAboutDialogInfo::wxAboutDialogInfo}\label{wxaboutdialoginfowxaboutdialoginfo}
  53
  54 \func{}{wxAboutDialogInfo}{\void}
  55
  56 Default constructor leaves all fields are initially uninitialized, in general
  57 you should call at least \helpref{SetVersion}{wxaboutdialoginfosetversion},
  58 \helpref{SetCopyright}{wxaboutdialoginfosetcopyright} and
  59 \helpref{SetDescription}{wxaboutdialoginfosetdescription}.
  60
  61
  62 \membersection{wxAboutDialogInfo::AddArtist}\label{wxaboutdialoginfoaddartist}
  63
  64 \func{void}{AddArtist}{\param{const wxString\& }{artist}}
  65
  66 Adds an artist name to be shown in the program credits.
  67
  68 \wxheading{See also}
  69
  70 \helpref{SetArtists}{wxaboutdialoginfosetartists}
  71
  72
  73 \membersection{wxAboutDialogInfo::AddDeveloper}\label{wxaboutdialoginfoadddeveloper}
  74
  75 \func{void}{AddDeveloper}{\param{const wxString\& }{developer}}
  76
  77 Adds a developer name to be shown in the program credits.
  78
  79 \wxheading{See also}
  80
  81 \helpref{SetDevelopers}{wxaboutdialoginfosetdevelopers}
  82
  83
  84 \membersection{wxAboutDialogInfo::AddDocWriter}\label{wxaboutdialoginfoadddocwriter}
  85
  86 \func{void}{AddDocWriter}{\param{const wxString\& }{docwriter}}
  87
  88 Adds a documentation writer name to be shown in the program credits.
  89
  90 \wxheading{See also}
  91
  92 \helpref{SetDocWriters}{wxaboutdialoginfosetdocwriters}
  93
  94
  95 \membersection{wxAboutDialogInfo::AddTranslator}\label{wxaboutdialoginfoaddtranslator}
  96
  97 \func{void}{AddTranslator}{\param{const wxString\& }{translator}}
  98
  99 Adds a translator name to be shown in the program credits. Notice that if no
 100 translator names are specified explicitely, \helpref{wxAboutBox()}{wxaboutbox}
 101 will try to use the translation of the string \texttt{translator-credits} from
 102 the currently used message catalog -- this can be used to show just the name of
 103 the translator of the program in the current language.
 104
 105 \wxheading{See also}
 106
 107 \helpref{SetTranslators}{wxaboutdialoginfosettranslators}
 108
 109
 110 \membersection{wxAboutDialogInfo::SetArtists}\label{wxaboutdialoginfosetartists}
 111
 112 \func{void}{SetArtists}{\param{const wxArrayString\& }{artists}}
 113
 114 Sets the the list of artists to be shown in the program credits.
 115
 116 \wxheading{See also}
 117
 118 \helpref{AddArtist}{wxaboutdialoginfoaddartist}
 119
 120
 121 \membersection{wxAboutDialogInfo::SetCopyright}\label{wxaboutdialoginfosetcopyright}
 122
 123 \func{void}{SetCopyright}{\param{const wxString\& }{copyright}}
 124
 125 Set the short string containing the program copyright information. Notice that
 126 any occurrences of \texttt{"(C)"} in \arg{copyright} will be replaced by the
 127 copyright symbol (circled C) automatically, which means that you can avoid
 128 using this symbol in the program source code which can be problematic,
 129
 130
 131 \membersection{wxAboutDialogInfo::SetDescription}\label{wxaboutdialoginfosetdescription}
 132
 133 \func{void}{SetDescription}{\param{const wxString\& }{desc}}
 134
 135 Set brief, but possibly multiline, description of the program.
 136
 137
 138 \membersection{wxAboutDialogInfo::SetDevelopers}\label{wxaboutdialoginfosetdevelopers}
 139
 140 \func{void}{SetDevelopers}{\param{const wxArrayString\& }{developers}}
 141
 142 Set the list of developers of the program.
 143
 144 \wxheading{See also}
 145
 146 \helpref{AddDeveloper}{wxaboutdialoginfoadddeveloper}
 147
 148
 149 \membersection{wxAboutDialogInfo::SetDocWriters}\label{wxaboutdialoginfosetdocwriters}
 150
 151 \func{void}{SetDocWriters}{\param{const wxArrayString\& }{docwriters}}
 152
 153 Set the list of documentation writers.
 154
 155 \wxheading{See also}
 156
 157 \helpref{AddDocWriter}{wxaboutdialoginfoadddocwriter}
 158
 159
 160 \membersection{wxAboutDialogInfo::SetIcon}\label{wxaboutdialoginfoseticon}
 161
 162 \func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
 163
 164 Set the icon to be shown in the dialog. By default the icon of the main frame
 165 will be shown if the native about dialog supports custom icons. If it doesn't
 166 but a valid icon is specified using this method, the generic about dialog is
 167 used instead so you should avoid calling this function for maximally native
 168 look and feel.
 169
 170
 171 \membersection{wxAboutDialogInfo::SetLicence}\label{wxaboutdialoginfosetlicence}
 172
 173 \func{void}{SetLicence}{\param{const wxString\& }{licence}}
 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 \texttt{"Help"} menu for displaying the text of your program licence.
 182
 183
 184 \membersection{wxAboutDialogInfo::SetLicense}\label{wxaboutdialoginfosetlicense}
 185
 186 \func{void}{SetLicense}{\param{const wxString\& }{licence}}
 187
 188 This is the same as \helpref{SetLicence}{wxaboutdialoginfosetlicence}.
 189
 190
 191 \membersection{wxAboutDialogInfo::SetName}\label{wxaboutdialoginfosetname}
 192
 193 \func{void}{SetName}{\param{const wxString\& }{name}}
 194
 195 Set the name of the program. If this method is not called, the string returned
 196 by \helpref{wxApp::GetAppName()}{wxappgetappname} will be shown in the dialog.
 197
 198
 199 \membersection{wxAboutDialogInfo::SetTranslators}\label{wxaboutdialoginfosettranslators}
 200
 201 \func{void}{SetTranslators}{\param{const wxArrayString\& }{translators}}
 202
 203 Set the list of translators. Please see
 204 \helpref{AddTranslator}{wxaboutdialoginfoaddtranslator} for additional
 205 discussion.
 206
 207
 208 \membersection{wxAboutDialogInfo::SetVersion}\label{wxaboutdialoginfosetversion}
 209
 210 \func{void}{SetVersion}{\param{const wxString\& }{version}}
 211
 212 Set the version of the program. The version is in free format, i.e. not
 213 necessarily in the \texttt{x.y.z} form but it shouldn't contain the "version"
 214 word.
 215
 216
 217 \membersection{wxAboutDialogInfo::SetWebSite}\label{wxaboutdialoginfosetwebsite}
 218
 219 \func{void}{SetWebSite}{\param{const wxString\& }{url}, \param{const wxString\& }{desc = wxEmptyString}}
 220
 221 Set the web site for the program and its description (which defaults to URL
 222 itself if empty).
 223
 224 Please notice that only GTK+ version currently supports showing the link in the
 225 native about dialog so if this method is called, the generic version will be
 226 used under all the other platforms.
 227
 228