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 9d19a3f2fe455e7d9ac61917ed5a356c9e2a1b8f..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$
 // 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.
     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}
 
     @library{wxadv}
     @category{cmndlg,data}


@@ -76,6 +92,42 @@ public:
     */
     void AddTranslator(const wxString& translator);
 
     */
     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.
 
     /**
         Sets the the list of artists to be shown in the program credits.
 


@@ -148,10 +200,19 @@ public:
     void SetTranslators(const wxArrayString& translators);
 
     /**
     void SetTranslators(const wxArrayString& translators);
 
     /**

-        Set the version of the program. The version is in free format, i.e. not
-        necessarily in the @c x.y.z form but it shouldn't contain the "version" word.
+        Set the version of the program. The word "version" shouldn't be included
+        in @a version. Example @a version values: "1.2" and "RC2". In about dialogs
+        with more space set aside for version information, @a longVersion is used.
+        Example @a longVersion values: "Version 1.2" and "Release Candidate 2".
+        If @a version is non-empty but @a longVersion is empty, a long version
+        is constructed automatically, using @a version (by simply prepending
+        "Version " to @a version).
+
+        The generic about dialog and native GTK+ dialog use @a version only,
+        as a suffix to the program name. The native MSW and OS X about dialogs
+        use the long version.

     */
     */

-    void SetVersion(const wxString& version);
+    void SetVersion(const wxString& version, const wxString& longVersion = wxString());

 
     /**
         Set the web site for the program and its description (which defaults to @a url
 
     /**
         Set the web site for the program and its description (which defaults to @a url


@@ -189,7 +250,7 @@ public:
         info.SetName(_("My Program"));
         info.SetVersion(_("1.2.3 Beta"));
         info.SetDescription(_("This program does something great."));
         info.SetName(_("My Program"));
         info.SetVersion(_("1.2.3 Beta"));
         info.SetDescription(_("This program does something great."));

-        info.SetCopyright(_T("(C) 2007 Me <my@email.addre.ss>"));
+        info.SetCopyright(wxT("(C) 2007 Me <my@email.addre.ss>"));

 
         wxAboutBox(info);
     }
 
         wxAboutBox(info);
     }