src/generic/aboutdlgg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/aboutdlgg.cpp
   3 // Purpose:     implements wxGenericAboutBox() function
   4 // Author:      Vadim Zeitlin
   5 // Created:     2006-10-08
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 // ============================================================================
  12 // declarations
  13 // ============================================================================
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 // for compilers that support precompilation, includes "wx.h".
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_ABOUTDLG
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/sizer.h"
  30     #include "wx/statbmp.h"
  31     #include "wx/stattext.h"
  32     #include "wx/button.h"
  33 #endif //WX_PRECOMP
  34
  35 #include "wx/aboutdlg.h"
  36 #include "wx/generic/aboutdlgg.h"
  37
  38 #include "wx/hyperlink.h"
  39 #include "wx/collpane.h"
  40
  41 // ============================================================================
  42 // implementation
  43 // ============================================================================
  44
  45 // helper function: returns all array elements in a single comma-separated and
  46 // newline-terminated string
  47 static wxString AllAsString(const wxArrayString& a)
  48 {
  49     wxString s;
  50     const size_t count = a.size();
  51     s.reserve(20*count);
  52     for ( size_t n = 0; n < count; n++ )
  53     {
  54         s << a[n] << (n == count - 1 ? _T("\n") : _T(", "));
  55     }
  56
  57     return s;
  58 }
  59
  60 // ----------------------------------------------------------------------------
  61 // wxAboutDialogInfo
  62 // ----------------------------------------------------------------------------
  63
  64 wxString wxAboutDialogInfo::GetDescriptionAndCredits() const
  65 {
  66     wxString s = GetDescription();
  67     if ( !s.empty() )
  68         s << _T('\n');
  69
  70     if ( HasDevelopers() )
  71         s << _T('\n') << _("Developed by ") << AllAsString(GetDevelopers());
  72
  73     if ( HasDocWriters() )
  74         s << _T('\n') << _("Documentation by ") << AllAsString(GetDocWriters());
  75
  76     if ( HasArtists() )
  77         s << _T('\n') << _("Graphics art by ") << AllAsString(GetArtists());
  78
  79     if ( HasTranslators() )
  80         s << _T('\n') << _("Translations by ") << AllAsString(GetTranslators());
  81
  82     return s;
  83 }
  84
  85 wxIcon wxAboutDialogInfo::GetIcon() const
  86 {
  87     wxIcon icon = m_icon;
  88     if ( !icon.Ok() && wxTheApp )
  89     {
  90         const wxTopLevelWindow * const
  91             tlw = wxDynamicCast(wxTheApp->GetTopWindow(), wxTopLevelWindow);
  92         if ( tlw )
  93             icon = tlw->GetIcon();
  94     }
  95
  96     return icon;
  97 }
  98
  99 wxString wxAboutDialogInfo::GetCopyrightToDisplay() const
 100 {
 101     wxString ret = m_copyright;
 102
 103 #if wxUSE_UNICODE
 104     const wxString copyrightSign = wxString::FromUTF8("\xc2\xa9");
 105     ret.Replace("(c)", copyrightSign);
 106     ret.Replace("(C)", copyrightSign);
 107 #endif // wxUSE_UNICODE
 108
 109     return ret;
 110 }
 111
 112 // ----------------------------------------------------------------------------
 113 // wxGenericAboutDialog
 114 // ----------------------------------------------------------------------------
 115
 116 bool wxGenericAboutDialog::Create(const wxAboutDialogInfo& info)
 117 {
 118     // this is a modal dialog thus we'll use GetParentForModalDialog:
 119     if ( !wxDialog::Create(GetParentForModalDialog(), wxID_ANY, _("About ") + info.GetName(),
 120                            wxDefaultPosition, wxDefaultSize, wxRESIZE_BORDER|wxDEFAULT_DIALOG_STYLE) )
 121         return false;
 122
 123     m_sizerText = new wxBoxSizer(wxVERTICAL);
 124     wxString nameAndVersion = info.GetName();
 125     if ( info.HasVersion() )
 126         nameAndVersion << _T(' ') << info.GetVersion();
 127     wxStaticText *label = new wxStaticText(this, wxID_ANY, nameAndVersion);
 128     wxFont fontBig(*wxNORMAL_FONT);
 129     fontBig.SetPointSize(fontBig.GetPointSize() + 2);
 130     fontBig.SetWeight(wxFONTWEIGHT_BOLD);
 131     label->SetFont(fontBig);
 132
 133     m_sizerText->Add(label, wxSizerFlags().Centre().Border());
 134     m_sizerText->AddSpacer(5);
 135
 136     AddText(info.GetCopyrightToDisplay());
 137     AddText(info.GetDescription());
 138
 139     if ( info.HasWebSite() )
 140     {
 141 #if wxUSE_HYPERLINKCTRL
 142         AddControl(new wxHyperlinkCtrl(this, wxID_ANY,
 143                                        info.GetWebSiteDescription(),
 144                                        info.GetWebSiteURL()));
 145 #else
 146         AddText(info.GetWebSiteURL());
 147 #endif // wxUSE_HYPERLINKCTRL/!wxUSE_HYPERLINKCTRL
 148     }
 149
 150 #if wxUSE_COLLPANE
 151     if ( info.HasLicence() )
 152         AddCollapsiblePane(_("License"), info.GetLicence());
 153
 154     if ( info.HasDevelopers() )
 155         AddCollapsiblePane(_("Developers"),
 156                            AllAsString(info.GetDevelopers()));
 157
 158     if ( info.HasDocWriters() )
 159         AddCollapsiblePane(_("Documentation writers"),
 160                            AllAsString(info.GetDocWriters()));
 161
 162     if ( info.HasArtists() )
 163         AddCollapsiblePane(_("Artists"),
 164                            AllAsString(info.GetArtists()));
 165
 166     if ( info.HasTranslators() )
 167         AddCollapsiblePane(_("Translators"),
 168                            AllAsString(info.GetTranslators()));
 169 #endif // wxUSE_COLLPANE
 170
 171     DoAddCustomControls();
 172
 173
 174     wxSizer *sizerIconAndText = new wxBoxSizer(wxHORIZONTAL);
 175 #if wxUSE_STATBMP
 176     wxIcon icon = info.GetIcon();
 177     if ( icon.Ok() )
 178     {
 179         sizerIconAndText->Add(new wxStaticBitmap(this, wxID_ANY, icon),
 180                                 wxSizerFlags().Border(wxRIGHT));
 181     }
 182 #endif // wxUSE_STATBMP
 183     sizerIconAndText->Add(m_sizerText, wxSizerFlags(1).Expand());
 184
 185     wxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
 186     sizerTop->Add(sizerIconAndText, wxSizerFlags(1).Expand().Border());
 187
 188 // Mac typically doesn't use OK buttons just for dismissing dialogs.
 189 #if !defined(__WXMAC__)
 190     wxSizer *sizerBtns = CreateButtonSizer(wxOK);
 191     if ( sizerBtns )
 192     {
 193         sizerTop->Add(sizerBtns, wxSizerFlags().Expand().Border());
 194     }
 195 #endif
 196
 197     SetSizerAndFit(sizerTop);
 198
 199     CentreOnScreen();
 200
 201     return true;
 202 }
 203
 204 void wxGenericAboutDialog::AddControl(wxWindow *win, const wxSizerFlags& flags)
 205 {
 206     wxCHECK_RET( m_sizerText, _T("can only be called after Create()") );
 207     wxASSERT_MSG( win, _T("can't add NULL window to about dialog") );
 208
 209     m_sizerText->Add(win, flags);
 210 }
 211
 212 void wxGenericAboutDialog::AddControl(wxWindow *win)
 213 {
 214     AddControl(win, wxSizerFlags().Border(wxDOWN).Centre());
 215 }
 216
 217 void wxGenericAboutDialog::AddText(const wxString& text)
 218 {
 219     if ( !text.empty() )
 220         AddControl(new wxStaticText(this, wxID_ANY, text));
 221 }
 222
 223 void wxGenericAboutDialog::AddCollapsiblePane(const wxString& title,
 224                                               const wxString& text)
 225 {
 226     wxCollapsiblePane *pane = new wxCollapsiblePane(this, wxID_ANY, title);
 227     wxStaticText *txt = new wxStaticText(pane->GetPane(), wxID_ANY, text,
 228                                          wxDefaultPosition, wxDefaultSize,
 229                                          wxALIGN_CENTRE);
 230
 231     // don't make the text unreasonably wide
 232     static const int maxWidth = wxGetDisplaySize().x/3;
 233     txt->Wrap(maxWidth);
 234
 235     // NB: all the wxCollapsiblePanes must be added with a null proportion value
 236     m_sizerText->Add(pane, wxSizerFlags(0).Expand().Border(wxBOTTOM));
 237 }
 238
 239 // ----------------------------------------------------------------------------
 240 // public functions
 241 // ----------------------------------------------------------------------------
 242
 243 void wxGenericAboutBox(const wxAboutDialogInfo& info)
 244 {
 245 #if !defined(__WXGTK__) && !defined(__WXMAC__)
 246     wxGenericAboutDialog dlg(info);
 247     dlg.ShowModal();
 248 #else
 249     wxGenericAboutDialog* dlg = new wxGenericAboutDialog(info);
 250     dlg->Show();
 251 #endif
 252 }
 253
 254 // currently wxAboutBox is implemented natively only under these platforms, for
 255 // the others we provide a generic fallback here
 256 #if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXGTK26__)
 257
 258 void wxAboutBox(const wxAboutDialogInfo& info)
 259 {
 260     wxGenericAboutBox(info);
 261 }
 262
 263 #endif // platforms without native about dialog
 264
 265
 266 #endif // wxUSE_ABOUTDLG