X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/704006b381ff98a16a8ce122dd0ae30cad7a6fca..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/aboutdlg.h?ds=sidebyside

diff --git a/interface/wx/aboutdlg.h b/interface/wx/aboutdlg.h
index 6db5903b8a..23ffb172a0 100644
--- a/interface/wx/aboutdlg.h
+++ b/interface/wx/aboutdlg.h
@@ -2,8 +2,7 @@
 // Name:        aboutdlg.h
 // Purpose:     interface of wxAboutDialogInfo
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -29,6 +28,22 @@
     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.
+    
+    Example of usage:
+    @code
+    void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
+    {
+        wxAboutDialogInfo aboutInfo;
+        aboutInfo.SetName("MyApp");
+        aboutInfo.SetVersion(MY_APP_VERSION_STRING);
+        aboutInfo.SetDescription(_("My wxWidgets-based application!"));
+        aboutInfo.SetCopyright("(C) 1992-2010");
+        aboutInfo.SetWebSite("http://myapp.org");
+        aboutInfo.AddDeveloper("My Self");
+
+        wxAboutBox(aboutInfo);
+    }
+    @endcode
 
     @library{wxadv}
     @category{cmndlg,data}
@@ -67,7 +82,7 @@ public:
 
     /**
         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 explicitly, 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.
@@ -77,7 +92,43 @@ public:
     void AddTranslator(const wxString& translator);
 
     /**
-        Sets the the list of artists to be shown in the program credits.
+        Get the name of the program.
+
+        @return Name of the program
+        @see SetName()
+    */
+    wxString GetName() const;
+
+    /**
+        Returns @true if a description string has been specified.
+
+        @see GetDescription()
+    */
+    bool HasDescription() const;
+
+    /**
+        Get the description string.
+
+        @return The description string, free-form.
+    */
+    const wxString& GetDescription();
+
+    /**
+        Returns @true if a copyright string has been specified.
+
+        @see GetCopyright()
+    */
+    bool HasCopyright() const;
+
+    /**
+        Get the copyright string.
+
+        @return The copyright string
+    */
+    const wxString& GetCopyright() const;
+
+    /**
+        Sets the list of artists to be shown in the program credits.
 
         @see AddArtist()
     */