X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ca7adbf8bc5df4932deebb653060dc220ff4c06e..4f2511d706e5274a34e1521e11c1b95fed735b42:/include/wx/aboutdlg.h diff --git a/include/wx/aboutdlg.h b/include/wx/aboutdlg.h index 2f7419e42b..9c8946d193 100644 --- a/include/wx/aboutdlg.h +++ b/include/wx/aboutdlg.h @@ -22,7 +22,7 @@ // wxAboutDialogInfo: information shown by the standard "About" dialog // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_CORE wxAboutDialogInfo +class WXDLLIMPEXP_ADV wxAboutDialogInfo { public: // all fields are initially uninitialized @@ -31,36 +31,36 @@ public: // accessors for various simply fields // ----------------------------------- - // name of the program, if not used defaults wxApp::GetAppName() + // name of the program, if not used defaults to wxApp::GetAppDisplayName() void SetName(const wxString& name) { m_name = name; } wxString GetName() const - { return m_name.empty() ? wxTheApp->GetAppName() : m_name; } + { return m_name.empty() ? wxTheApp->GetAppDisplayName() : m_name; } // version of the program, in free format (but without "version" word) void SetVersion(const wxString& version) { m_version = version; } bool HasVersion() const { return !m_version.empty(); } - wxString GetVersion() const { return m_version; } + const wxString& GetVersion() const { return m_version; } // brief, but possibly multiline, description of the program void SetDescription(const wxString& desc) { m_description = desc; } bool HasDescription() const { return !m_description.empty(); } - wxString GetDescription() const { return m_description; } + const wxString& GetDescription() const { return m_description; } // short string containing the program copyright information void SetCopyright(const wxString& copyright) { m_copyright = copyright; } bool HasCopyright() const { return !m_copyright.empty(); } - wxString GetCopyright() const { return m_copyright; } + const wxString& GetCopyright() const { return m_copyright; } // long, multiline string containing the text of the program licence void SetLicence(const wxString& licence) { m_licence = licence; } void SetLicense(const wxString& licence) { m_licence = licence; } bool HasLicence() const { return !m_licence.empty(); } - wxString GetLicence() const { return m_licence; } + const wxString& GetLicence() const { return m_licence; } // icon to be shown in the dialog, defaults to the main frame icon void SetIcon(const wxIcon& icon) { m_icon = icon; } bool HasIcon() const { return m_icon.Ok(); } - wxIcon GetIcon() const { return m_icon; } + wxIcon GetIcon() const; // web site for the program and its description (defaults to URL itself if // empty) @@ -72,8 +72,8 @@ public: bool HasWebSite() const { return !m_url.empty(); } - wxString GetWebSiteURL() const { return m_url; } - wxString GetWebSiteDescription() const { return m_urlDesc; } + const wxString& GetWebSiteURL() const { return m_url; } + const wxString& GetWebSiteDescription() const { return m_urlDesc; } // accessors for the arrays // ------------------------ @@ -114,6 +114,20 @@ public: bool HasTranslators() const { return !m_translators.empty(); } const wxArrayString& GetTranslators() const { return m_translators; } + + // implementation only + // ------------------- + + // "simple" about dialog shows only textual information (with possibly + // default icon but without hyperlink nor any long texts such as the + // licence text) + bool IsSimple() const + { return !HasWebSite() && !HasIcon() && !HasLicence(); } + + // get the description and credits (i.e. all of developers, doc writers, + // artists and translators) as a one long multiline string + wxString GetDescriptionAndCredits() const; + private: wxString m_name, m_version, @@ -133,7 +147,7 @@ private: }; // functions to show the about dialog box -WXDLLIMPEXP_CORE void wxAboutBox(const wxAboutDialogInfo& info); +WXDLLIMPEXP_ADV void wxAboutBox(const wxAboutDialogInfo& info); #endif // wxUSE_ABOUTDLG