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