src/gtk/aboutdlg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/aboutdlg.cpp
   3 // Purpose:     native GTK+ wxAboutBox() implementation
   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 #if wxUSE_ABOUTDLG
  22
  23 #include "wx/aboutdlg.h"
  24
  25 #ifndef WX_PRECOMP
  26     #include "wx/utils.h"       // for wxLaunchDefaultBrowser()
  27 #endif //WX_PRECOMP
  28
  29 #include <gtk/gtk.h>
  30 #include "wx/gtk/private.h"
  31 #include "wx/gtk/private/gtk2-compat.h"
  32
  33 // ----------------------------------------------------------------------------
  34 // GtkArray: temporary array of GTK strings
  35 // ----------------------------------------------------------------------------
  36
  37 namespace
  38 {
  39
  40 class GtkArray
  41 {
  42 public:
  43     // Create empty GtkArray
  44     GtkArray() : m_strings(0), m_count(0)
  45     {
  46     }
  47
  48     // Create GtkArray from wxArrayString. Note that the created object is
  49     // only valid as long as 'a' is!
  50     GtkArray(const wxArrayString& a)
  51     {
  52         m_count = a.size();
  53         m_strings = new const gchar *[m_count + 1];
  54
  55         for ( size_t n = 0; n < m_count; n++ )
  56         {
  57 #if wxUSE_UNICODE
  58             // notice that there is no need to copy the string pointer here
  59             // because this class is used only as a temporary and during its
  60             // existence the pointer persists in wxString which uses it either
  61             // for internal representation (in wxUSE_UNICODE_UTF8 case) or as
  62             // cached m_convertedToChar (in wxUSE_UNICODE_WCHAR case)
  63             m_strings[n] = wxGTK_CONV_SYS(a[n]);
  64 #else // !wxUSE_UNICODE
  65             // and in ANSI build we can simply borrow the pointer from
  66             // wxCharBuffer (which owns it in this case) instead of copying it
  67             // but we then become responsible for freeing it
  68             m_strings[n] = wxGTK_CONV_SYS(a[n]).release();
  69 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
  70         }
  71
  72         // array must be NULL-terminated
  73         m_strings[m_count] = NULL;
  74     }
  75
  76     operator const gchar **() const { return m_strings; }
  77
  78     ~GtkArray()
  79     {
  80 #if !wxUSE_UNICODE
  81         for ( size_t n = 0; n < m_count; n++ )
  82             free(const_cast<gchar *>(m_strings[n]));
  83 #endif
  84
  85         delete [] m_strings;
  86     }
  87
  88 private:
  89     const gchar **m_strings;
  90     size_t m_count;
  91
  92     wxDECLARE_NO_COPY_CLASS(GtkArray);
  93 };
  94
  95 } // anonymous namespace
  96
  97 // ============================================================================
  98 // implementation
  99 // ============================================================================
 100
 101 // GTK+ about dialog is modeless, keep track of it in this variable
 102 static GtkAboutDialog *gs_aboutDialog = NULL;
 103
 104 extern "C" {
 105 static void wxGtkAboutDialogOnClose(GtkAboutDialog *about)
 106 {
 107     gtk_widget_destroy(GTK_WIDGET(about));
 108     if ( about == gs_aboutDialog )
 109         gs_aboutDialog = NULL;
 110 }
 111 }
 112
 113 #ifdef __WXGTK3__
 114 extern "C" {
 115 static gboolean activate_link(GtkAboutDialog*, const char* link, void* dontIgnore)
 116 {
 117     if (dontIgnore)
 118     {
 119         wxLaunchDefaultBrowser(wxGTK_CONV_BACK_SYS(link));
 120         return true;
 121     }
 122     return false;
 123 }
 124 }
 125 #else
 126 extern "C" {
 127 static void wxGtkAboutDialogOnLink(GtkAboutDialog*, const char* link, void*)
 128 {
 129     wxLaunchDefaultBrowser(wxGTK_CONV_BACK_SYS(link));
 130 }
 131 }
 132 #endif
 133
 134 void wxAboutBox(const wxAboutDialogInfo& info, wxWindow* WXUNUSED(parent))
 135 {
 136     // don't create another dialog if one is already present
 137     if ( !gs_aboutDialog )
 138         gs_aboutDialog = GTK_ABOUT_DIALOG(gtk_about_dialog_new());
 139
 140     GtkAboutDialog * const dlg = gs_aboutDialog;
 141     gtk_about_dialog_set_program_name(dlg, wxGTK_CONV_SYS(info.GetName()));
 142     if ( info.HasVersion() )
 143         gtk_about_dialog_set_version(dlg, wxGTK_CONV_SYS(info.GetVersion()));
 144     else
 145         gtk_about_dialog_set_version(dlg, NULL);
 146     if ( info.HasCopyright() )
 147         gtk_about_dialog_set_copyright(dlg, wxGTK_CONV_SYS(info.GetCopyrightToDisplay()));
 148     else
 149         gtk_about_dialog_set_copyright(dlg, NULL);
 150     if ( info.HasDescription() )
 151         gtk_about_dialog_set_comments(dlg, wxGTK_CONV_SYS(info.GetDescription()));
 152     else
 153         gtk_about_dialog_set_comments(dlg, NULL);
 154     if ( info.HasLicence() )
 155         gtk_about_dialog_set_license(dlg, wxGTK_CONV_SYS(info.GetLicence()));
 156     else
 157         gtk_about_dialog_set_license(dlg, NULL);
 158
 159     wxIcon icon = info.GetIcon();
 160     if ( icon.IsOk() )
 161         gtk_about_dialog_set_logo(dlg, info.GetIcon().GetPixbuf());
 162
 163     if ( info.HasWebSite() )
 164     {
 165 #ifdef __WXGTK3__
 166         g_signal_connect(dlg, "activate-link", G_CALLBACK(activate_link), dlg);
 167 #else
 168         // NB: must be called before gtk_about_dialog_set_website() as
 169         //     otherwise it has no effect (although GTK+ docs don't mention
 170         //     this...)
 171         gtk_about_dialog_set_url_hook(wxGtkAboutDialogOnLink, NULL, NULL);
 172 #endif
 173
 174         gtk_about_dialog_set_website(dlg, wxGTK_CONV_SYS(info.GetWebSiteURL()));
 175         gtk_about_dialog_set_website_label
 176         (
 177             dlg,
 178             wxGTK_CONV_SYS(info.GetWebSiteDescription())
 179         );
 180     }
 181     else
 182     {
 183         gtk_about_dialog_set_website(dlg, NULL);
 184         gtk_about_dialog_set_website_label(dlg, NULL);
 185 #ifdef __WXGTK3__
 186         g_signal_connect(dlg, "activate-link", G_CALLBACK(activate_link), NULL);
 187 #else
 188         gtk_about_dialog_set_url_hook(NULL, NULL, NULL);
 189 #endif
 190     }
 191
 192     if ( info.HasDevelopers() )
 193         gtk_about_dialog_set_authors(dlg, GtkArray(info.GetDevelopers()));
 194     else
 195         gtk_about_dialog_set_authors(dlg, GtkArray());
 196     if ( info.HasDocWriters() )
 197         gtk_about_dialog_set_documenters(dlg, GtkArray(info.GetDocWriters()));
 198     else
 199         gtk_about_dialog_set_documenters(dlg, GtkArray());
 200     if ( info.HasArtists() )
 201         gtk_about_dialog_set_artists(dlg, GtkArray(info.GetArtists()));
 202     else
 203         gtk_about_dialog_set_artists(dlg, GtkArray());
 204
 205     wxString transCredits;
 206     if ( info.HasTranslators() )
 207     {
 208         const wxArrayString& translators = info.GetTranslators();
 209         const size_t count = translators.size();
 210         for ( size_t n = 0; n < count; n++ )
 211         {
 212             transCredits << translators[n] << wxT('\n');
 213         }
 214     }
 215     else // no translators explicitly specified
 216     {
 217         // maybe we have translator credits in the message catalog?
 218         wxString translator = _("translator-credits");
 219
 220         // gtk_about_dialog_set_translator_credits() is smart enough to
 221         // detect if "translator-credits" is untranslated and hide the
 222         // translators tab in that case, however it will still show the
 223         // "credits" button, (at least GTK 2.10.6) even if there are no
 224         // credits informations at all, so we still need to do the check
 225         // ourselves
 226         if ( translator != wxT("translator-credits") ) // untranslated!
 227             transCredits = translator;
 228     }
 229
 230     if ( !transCredits.empty() )
 231         gtk_about_dialog_set_translator_credits(dlg, wxGTK_CONV_SYS(transCredits));
 232     else
 233         gtk_about_dialog_set_translator_credits(dlg, NULL);
 234
 235     g_signal_connect(dlg, "response",
 236                         G_CALLBACK(wxGtkAboutDialogOnClose), NULL);
 237
 238     gtk_window_present(GTK_WINDOW(dlg));
 239 }
 240
 241 #endif // wxUSE_ABOUTDLG