Add backend descriptions for all backends to the documentation.

[wxWidgets.git] / src / generic / aboutdlgg.cpp

diff --git a/src/generic/aboutdlgg.cpp b/src/generic/aboutdlgg.cpp
index 2bd702fe67e03d7c2c5d03f9107e2b5d74167987..fc38c186d6725ee7742a39ea137421e5f8cab5af 100644 (file)
--- a/src/generic/aboutdlgg.cpp
+++ b/src/generic/aboutdlgg.cpp
@@ -27,30 +27,125 @@
 
 #ifndef WX_PRECOMP
     #include "wx/sizer.h"
 
 #ifndef WX_PRECOMP
     #include "wx/sizer.h"

-

     #include "wx/statbmp.h"
     #include "wx/stattext.h"
     #include "wx/statbmp.h"
     #include "wx/stattext.h"

+    #include "wx/button.h"

 #endif //WX_PRECOMP
 
 #include "wx/aboutdlg.h"
 #include "wx/generic/aboutdlgg.h"
 
 #include "wx/hyperlink.h"
 #endif //WX_PRECOMP
 
 #include "wx/aboutdlg.h"
 #include "wx/generic/aboutdlgg.h"
 
 #include "wx/hyperlink.h"

+#include "wx/collpane.h"

 
 // ============================================================================
 
 // ============================================================================

-// wxAboutDialog implementation
+// implementation

 // ============================================================================
 
 // ============================================================================
 

-bool wxAboutDialog::Create(const wxAboutDialogInfo& info)
+// helper function: returns all array elements in a single comma-separated and
+// newline-terminated string
+static wxString AllAsString(const wxArrayString& a)
+{
+    wxString s;
+    const size_t count = a.size();
+    s.reserve(20*count);
+    for ( size_t n = 0; n < count; n++ )
+    {
+        s << a[n] << (n == count - 1 ? wxT("\n") : wxT(", "));
+    }
+
+    return s;
+}
+
+// ----------------------------------------------------------------------------
+// wxAboutDialogInfo
+// ----------------------------------------------------------------------------
+
+wxString wxAboutDialogInfo::GetDescriptionAndCredits() const
+{
+    wxString s = GetDescription();
+    if ( !s.empty() )
+        s << wxT('\n');
+
+    if ( HasDevelopers() )
+        s << wxT('\n') << _("Developed by ") << AllAsString(GetDevelopers());
+
+    if ( HasDocWriters() )
+        s << wxT('\n') << _("Documentation by ") << AllAsString(GetDocWriters());
+
+    if ( HasArtists() )
+        s << wxT('\n') << _("Graphics art by ") << AllAsString(GetArtists());
+
+    if ( HasTranslators() )
+        s << wxT('\n') << _("Translations by ") << AllAsString(GetTranslators());
+
+    return s;
+}
+
+wxIcon wxAboutDialogInfo::GetIcon() const
+{
+    wxIcon icon = m_icon;
+    if ( !icon.IsOk() && wxTheApp )
+    {
+        const wxTopLevelWindow * const
+            tlw = wxDynamicCast(wxTheApp->GetTopWindow(), wxTopLevelWindow);
+        if ( tlw )
+            icon = tlw->GetIcon();
+    }
+
+    return icon;
+}
+
+wxString wxAboutDialogInfo::GetCopyrightToDisplay() const

 {
 {

-    // TODO: should we use main frame as parent by default here?
-    if ( !wxDialog::Create(NULL, wxID_ANY, _("About ") + info.GetName()) )
+    wxString ret = m_copyright;
+
+#if wxUSE_UNICODE
+    const wxString copyrightSign = wxString::FromUTF8("\xc2\xa9");
+    ret.Replace("(c)", copyrightSign);
+    ret.Replace("(C)", copyrightSign);
+#endif // wxUSE_UNICODE
+
+    return ret;
+}
+
+void wxAboutDialogInfo::SetVersion(const wxString& version,
+                                   const wxString& longVersion)
+{
+    if ( version.empty() )
+    {
+        m_version.clear();
+
+        wxASSERT_MSG( longVersion.empty(),
+                      "long version should be empty if version is");
+
+        m_longVersion.clear();
+    }
+    else // setting valid version
+    {
+        m_version = version;
+
+        if ( longVersion.empty() )
+            m_longVersion = _("Version ") + m_version;
+        else
+            m_longVersion = longVersion;
+    }
+}
+
+// ----------------------------------------------------------------------------
+// wxGenericAboutDialog
+// ----------------------------------------------------------------------------
+
+bool wxGenericAboutDialog::Create(const wxAboutDialogInfo& info, wxWindow* parent)
+{
+    if ( !wxDialog::Create(parent, wxID_ANY, _("About ") + info.GetName(),
+                           wxDefaultPosition, wxDefaultSize, wxRESIZE_BORDER|wxDEFAULT_DIALOG_STYLE) )

         return false;
 
     m_sizerText = new wxBoxSizer(wxVERTICAL);
     wxString nameAndVersion = info.GetName();
     if ( info.HasVersion() )
         return false;
 
     m_sizerText = new wxBoxSizer(wxVERTICAL);
     wxString nameAndVersion = info.GetName();
     if ( info.HasVersion() )

-        nameAndVersion << _T(' ') << info.GetVersion();
+        nameAndVersion << wxT(' ') << info.GetVersion();

     wxStaticText *label = new wxStaticText(this, wxID_ANY, nameAndVersion);
     wxFont fontBig(*wxNORMAL_FONT);
     fontBig.SetPointSize(fontBig.GetPointSize() + 2);
     wxStaticText *label = new wxStaticText(this, wxID_ANY, nameAndVersion);
     wxFont fontBig(*wxNORMAL_FONT);
     fontBig.SetPointSize(fontBig.GetPointSize() + 2);


@@ -60,7 +155,7 @@ bool wxAboutDialog::Create(const wxAboutDialogInfo& info)
     m_sizerText->Add(label, wxSizerFlags().Centre().Border());
     m_sizerText->AddSpacer(5);
 
     m_sizerText->Add(label, wxSizerFlags().Centre().Border());
     m_sizerText->AddSpacer(5);
 

-    AddText(info.GetCopyright());
+    AddText(info.GetCopyrightToDisplay());

     AddText(info.GetDescription());
 
     if ( info.HasWebSite() )
     AddText(info.GetDescription());
 
     if ( info.HasWebSite() )


@@ -74,23 +169,34 @@ bool wxAboutDialog::Create(const wxAboutDialogInfo& info)
 #endif // wxUSE_HYPERLINKCTRL/!wxUSE_HYPERLINKCTRL
     }
 
 #endif // wxUSE_HYPERLINKCTRL/!wxUSE_HYPERLINKCTRL
     }
 

-    // TODO: add licence
+#if wxUSE_COLLPANE
+    if ( info.HasLicence() )
+        AddCollapsiblePane(_("License"), info.GetLicence());
+
+    if ( info.HasDevelopers() )
+        AddCollapsiblePane(_("Developers"),
+                           AllAsString(info.GetDevelopers()));
+
+    if ( info.HasDocWriters() )
+        AddCollapsiblePane(_("Documentation writers"),
+                           AllAsString(info.GetDocWriters()));

 
 

-    // TODO: add credits (developers, artists, doc writers, translators)
+    if ( info.HasArtists() )
+        AddCollapsiblePane(_("Artists"),
+                           AllAsString(info.GetArtists()));
+
+    if ( info.HasTranslators() )
+        AddCollapsiblePane(_("Translators"),
+                           AllAsString(info.GetTranslators()));
+#endif // wxUSE_COLLPANE
+
+    DoAddCustomControls();

 
 
     wxSizer *sizerIconAndText = new wxBoxSizer(wxHORIZONTAL);
 #if wxUSE_STATBMP
     wxIcon icon = info.GetIcon();
 
 
     wxSizer *sizerIconAndText = new wxBoxSizer(wxHORIZONTAL);
 #if wxUSE_STATBMP
     wxIcon icon = info.GetIcon();

-    if ( !icon.Ok() && wxTheApp )
-    {
-        const wxTopLevelWindow * const
-            tlw = wxDynamicCast(wxTheApp->GetTopWindow(), wxTopLevelWindow);
-        if ( tlw )
-            icon = tlw->GetIcon();
-    }
-
-    if ( icon.Ok() )
+    if ( icon.IsOk() )

     {
         sizerIconAndText->Add(new wxStaticBitmap(this, wxID_ANY, icon),
                                 wxSizerFlags().Border(wxRIGHT));
     {
         sizerIconAndText->Add(new wxStaticBitmap(this, wxID_ANY, icon),
                                 wxSizerFlags().Border(wxRIGHT));


@@ -100,45 +206,87 @@ bool wxAboutDialog::Create(const wxAboutDialogInfo& info)
 
     wxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
     sizerTop->Add(sizerIconAndText, wxSizerFlags(1).Expand().Border());
 
     wxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
     sizerTop->Add(sizerIconAndText, wxSizerFlags(1).Expand().Border());

-    sizerTop->Add(new wxButton(this, wxID_OK), wxSizerFlags().Right().Border());
+
+// Mac typically doesn't use OK buttons just for dismissing dialogs.
+#if !defined(__WXMAC__)
+    wxSizer *sizerBtns = CreateButtonSizer(wxOK);
+    if ( sizerBtns )
+    {
+        sizerTop->Add(sizerBtns, wxSizerFlags().Expand().Border());
+    }
+#endif
+

     SetSizerAndFit(sizerTop);
 
     SetSizerAndFit(sizerTop);
 

-    CentreOnScreen();
+    CentreOnParent();
+

     return true;
 }
 
     return true;
 }
 

-void wxAboutDialog::AddControl(wxWindow *win)
+void wxGenericAboutDialog::AddControl(wxWindow *win, const wxSizerFlags& flags)

 {
 {

-    wxCHECK_RET( m_sizerText, _T("can only be called after Create()") );
-    wxASSERT_MSG( win, _T("can't add NULL window to about dialog") );
+    wxCHECK_RET( m_sizerText, wxT("can only be called after Create()") );
+    wxASSERT_MSG( win, wxT("can't add NULL window to about dialog") );
+
+    m_sizerText->Add(win, flags);
+}

 
 

-    m_sizerText->Add(win, wxSizerFlags().Border(wxDOWN).Centre());
+void wxGenericAboutDialog::AddControl(wxWindow *win)
+{
+    AddControl(win, wxSizerFlags().Border(wxDOWN).Centre());

 }
 
 }
 

-void wxAboutDialog::AddText(const wxString& text)
+void wxGenericAboutDialog::AddText(const wxString& text)

 {
     if ( !text.empty() )
         AddControl(new wxStaticText(this, wxID_ANY, text));
 }
 
 {
     if ( !text.empty() )
         AddControl(new wxStaticText(this, wxID_ANY, text));
 }
 

+void wxGenericAboutDialog::AddCollapsiblePane(const wxString& title,
+                                              const wxString& text)
+{
+    wxCollapsiblePane *pane = new wxCollapsiblePane(this, wxID_ANY, title);
+    wxWindow * const paneContents = pane->GetPane();
+    wxStaticText *txt = new wxStaticText(paneContents, wxID_ANY, text,
+                                         wxDefaultPosition, wxDefaultSize,
+                                         wxALIGN_CENTRE);
+
+    // don't make the text unreasonably wide
+    static const int maxWidth = wxGetDisplaySize().x/3;
+    txt->Wrap(maxWidth);
+
+
+    // we need a sizer to make this text expand to fill the entire pane area
+    wxSizer * const sizerPane = new wxBoxSizer(wxHORIZONTAL);
+    sizerPane->Add(txt, wxSizerFlags(1).Expand());
+    paneContents->SetSizer(sizerPane);
+
+    // NB: all the wxCollapsiblePanes must be added with a null proportion value
+    m_sizerText->Add(pane, wxSizerFlags(0).Expand().Border(wxBOTTOM));
+}
+

 // ----------------------------------------------------------------------------
 // public functions
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // public functions
 // ----------------------------------------------------------------------------
 

-void wxGenericAboutBox(const wxAboutDialogInfo& info)
+void wxGenericAboutBox(const wxAboutDialogInfo& info, wxWindow* parent)

 {
 {

-    wxAboutDialog dlg(info);
+#if !defined(__WXGTK__) && !defined(__WXMAC__)
+    wxGenericAboutDialog dlg(info, parent);

     dlg.ShowModal();
     dlg.ShowModal();

+#else
+    wxGenericAboutDialog* dlg = new wxGenericAboutDialog(info, parent);
+    dlg->Show();
+#endif

 }
 
 }
 

-// currently wxAboutBox is implemented natively only under wxMSW, so we provide
-// it here for the other platforms (this is going to change when GTK+ and Mac
-// native versions are implemented)
-#ifndef __WXMSW__
+// currently wxAboutBox is implemented natively only under these platforms, for
+// the others we provide a generic fallback here
+#if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXGTK26__)

 
 

-void wxAboutBox(const wxAboutDialogInfo& info)
+void wxAboutBox(const wxAboutDialogInfo& info, wxWindow* parent)

 {
 {

-    wxGenericAboutBox(info);
+    wxGenericAboutBox(info, parent);

 }
 
 #endif // platforms without native about dialog
 }
 
 #endif // platforms without native about dialog