Correct decoding of 4-byte integers in png2c script.

[wxWidgets.git] / interface / wx / aboutdlg.h

diff --git a/interface/wx/aboutdlg.h b/interface/wx/aboutdlg.h
index 6db5903b8a8a1bd7ecb1858778e289911bb2f9b4..ce1ae9d7ad3c53800cd47c7b06627eef01d80764 100644 (file)
--- a/interface/wx/aboutdlg.h
+++ b/interface/wx/aboutdlg.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxAboutDialogInfo
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -29,6 +29,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}
@@ -76,6 +92,42 @@ public:
     */
     void AddTranslator(const wxString& translator);
 
+    /**
+        Get the name of the program.
+
+        @return Name of the program
+        @see SetName()
+    */
+    const 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 the list of artists to be shown in the program credits.