Improve wxMenu docs

[wxWidgets.git] / src / gtk / utilsgtk.cpp

diff --git a/src/gtk/utilsgtk.cpp b/src/gtk/utilsgtk.cpp
index 72757f441ba6560126389d28288dad429e9ed7af..d255eb50e0e92a59f90e7bdee2130f0fe5bb98f2 100644 (file)
--- a/src/gtk/utilsgtk.cpp
+++ b/src/gtk/utilsgtk.cpp
@@ -19,11 +19,13 @@
 #endif
 
 #include "wx/apptrait.h"
 #endif
 
 #include "wx/apptrait.h"

-

 #include "wx/process.h"
 #include "wx/process.h"

-
+#include "wx/sysopt.h"

 #include "wx/unix/execute.h"
 
 #include "wx/unix/execute.h"
 

+#include "wx/gtk/private/timer.h"
+#include "wx/evtloop.h"
+

 #ifdef __WXDEBUG__
     #include "wx/gtk/assertdlg_gtk.h"
     #if wxUSE_STACKWALKER
 #ifdef __WXDEBUG__
     #include "wx/gtk/assertdlg_gtk.h"
     #if wxUSE_STACKWALKER


@@ -94,41 +96,6 @@ bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
 }
 #endif
 
 }
 #endif
 

-// Escapes string so that it is valid Pango markup XML string:
-wxString wxEscapeStringForPangoMarkup(const wxString& str)
-{
-    size_t len = str.length();
-    wxString out;
-    out.Alloc(len);
-    for (size_t i = 0; i < len; i++)
-    {
-        wxChar c = str[i];
-        switch (c)
-        {
-            case _T('&'):
-                out << _T("&amp;");
-                break;
-            case _T('<'):
-                out << _T("&lt;");
-                break;
-            case _T('>'):
-                out << _T("&gt;");
-                break;
-            case _T('\''):
-                out << _T("&apos;");
-                break;
-            case _T('"'):
-                out << _T("&quot;");
-                break;
-            default:
-                out << c;
-                break;
-        }
-    }
-    return out;
-}
-
-

 // ----------------------------------------------------------------------------
 // display characterstics
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // display characterstics
 // ----------------------------------------------------------------------------


@@ -150,17 +117,6 @@ void wxDisplaySizeMM( int *width, int *height )
     if (height) *height = gdk_screen_height_mm();
 }
 
     if (height) *height = gdk_screen_height_mm();
 }
 

-void wxClientDisplayRect(int *x, int *y, int *width, int *height)
-{
-    // This is supposed to return desktop dimensions minus any window
-    // manager panels, menus, taskbars, etc.  If there is a way to do that
-    // for this platform please fix this function, otherwise it defaults
-    // to the entire desktop.
-    if (x) *x = 0;
-    if (y) *y = 0;
-    wxDisplaySize(width, height);
-}
-

 void wxGetMousePosition( int* x, int* y )
 {
     gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );
 void wxGetMousePosition( int* x, int* y )
 {
     gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );


@@ -183,16 +139,17 @@ wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 
 #if !wxUSE_UNICODE
 
 
 #if !wxUSE_UNICODE
 

-wxCharBuffer wxConvertToGTK(const wxString& s, wxFontEncoding enc)
+WXDLLIMPEXP_CORE wxCharBuffer
+wxConvertToGTK(const wxString& s, wxFontEncoding enc)

 {
     wxWCharBuffer wbuf;
     if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
     {
 {
     wxWCharBuffer wbuf;
     if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
     {

-        wbuf = wxConvUI->cMB2WC(s);
+        wbuf = wxConvUI->cMB2WC(s.c_str());

     }
     else // another encoding, use generic conversion class
     {
     }
     else // another encoding, use generic conversion class
     {

-        wbuf = wxCSConv(enc).cMB2WC(s);
+        wbuf = wxCSConv(enc).cMB2WC(s.c_str());

     }
 
     if ( !wbuf && !s.empty() )
     }
 
     if ( !wbuf && !s.empty() )


@@ -203,14 +160,52 @@ wxCharBuffer wxConvertToGTK(const wxString& s, wxFontEncoding enc)
         // we choose ISO8859-1 here arbitrarily, it's just the most common
         // encoding probably and, also importantly here, conversion from it
         // never fails as it's done internally by wxCSConv
         // we choose ISO8859-1 here arbitrarily, it's just the most common
         // encoding probably and, also importantly here, conversion from it
         // never fails as it's done internally by wxCSConv

-        wbuf = wxCSConv(wxFONTENCODING_ISO8859_1).cMB2WC(s);
+        wbuf = wxCSConv(wxFONTENCODING_ISO8859_1).cMB2WC(s.c_str());

     }
 
     return wxConvUTF8.cWC2MB(wbuf);
 }
 
     }
 
     return wxConvUTF8.cWC2MB(wbuf);
 }
 

+WXDLLIMPEXP_CORE wxCharBuffer
+wxConvertFromGTK(const wxString& s, wxFontEncoding enc)
+{
+    // this conversion should never fail as GTK+ always uses UTF-8 internally
+    // so there are no complications here
+    const wxWCharBuffer wbuf(wxConvUTF8.cMB2WC(s.c_str()));
+    if ( enc == wxFONTENCODING_SYSTEM )
+        return wxConvUI->cWC2MB(wbuf);
+
+    return wxCSConv(enc).cWC2MB(wbuf);
+}
+

 #endif // !wxUSE_UNICODE
 
 #endif // !wxUSE_UNICODE
 

+// Returns NULL if version is certainly greater or equal than major.minor.micro
+// Returns string describing the error if version is lower than
+// major.minor.micro OR it cannot be determined and one should not rely on the
+// availability of pango version major.minor.micro, nor the non-availability
+const gchar *wx_pango_version_check (int major, int minor, int micro)
+{
+#ifdef PANGO_VERSION_MAJOR
+    if (!gtk_check_version (2,11,0))
+    {
+        // GTK+ 2.11 requires Pango >= 1.15.3 and pango_version_check
+        // was added in Pango 1.15.2 thus we know for sure the pango lib we're
+        // using has the pango_version_check function:
+        return pango_version_check (major, minor, micro);
+    }
+
+    return "can't check";
+#else // !PANGO_VERSION_MAJOR
+    wxUnusedVar(major);
+    wxUnusedVar(minor);
+    wxUnusedVar(micro);
+
+    return "too old headers";
+#endif
+}
+
+

 // ----------------------------------------------------------------------------
 // subprocess routines
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // subprocess routines
 // ----------------------------------------------------------------------------


@@ -218,38 +213,22 @@ wxCharBuffer wxConvertToGTK(const wxString& s, wxFontEncoding enc)
 extern "C" {
 static
 void GTK_EndProcessDetector(gpointer data, gint source,
 extern "C" {
 static
 void GTK_EndProcessDetector(gpointer data, gint source,

-                            GdkInputCondition WXUNUSED(condition) )
+                            GdkInputCondition WXUNUSED(condition))

 {
 {

-   wxEndProcessData *proc_data = (wxEndProcessData *)data;
-
-   // has the process really terminated? unfortunately GDK (or GLib) seem to
-   // generate G_IO_HUP notification even when it simply tries to read from a
-   // closed fd and hasn't terminated at all
-   int pid = (proc_data->pid > 0) ? proc_data->pid : -(proc_data->pid);
-   int status = 0;
-   int rc = waitpid(pid, &status, WNOHANG);
-
-   if ( rc == 0 )
-   {
-       // no, it didn't exit yet, continue waiting
-       return;
-   }
-
-   // set exit code to -1 if something bad happened
-   proc_data->exitcode = rc != -1 && WIFEXITED(status) ? WEXITSTATUS(status)
-                                                      : -1;
+    wxEndProcessData * const
+        proc_data = wx_static_cast(wxEndProcessData *, data);

 
 

-   // child exited, end waiting
-   close(source);
+    // child exited, end waiting
+    close(source);

 
 

-   // don't call us again!
-   gdk_input_remove(proc_data->tag);
+    // don't call us again!
+    gdk_input_remove(proc_data->tag);

 
 

-   wxHandleProcessTermination(proc_data);
+    wxHandleProcessTermination(proc_data);

 }
 }
 
 }
 }
 

-int wxAddProcessCallback(wxEndProcessData *proc_data, int fd)
+int wxGUIAppTraits::AddProcessCallback(wxEndProcessData *proc_data, int fd)

 {
     int tag = gdk_input_add(fd,
                             GDK_INPUT_READ,
 {
     int tag = gdk_input_add(fd,
                             GDK_INPUT_READ,


@@ -275,6 +254,15 @@ wxPortId wxGUIAppTraits::GetToolkitVersion(int *verMaj, int *verMin) const
     return wxPORT_GTK;
 }
 
     return wxPORT_GTK;
 }
 

+#if wxUSE_TIMER
+
+wxTimerImpl *wxGUIAppTraits::CreateTimerImpl(wxTimer *timer)
+{
+    return new wxGTKTimerImpl(timer);
+}
+
+#endif // wxUSE_TIMER
+

 #if wxUSE_DETECT_SM
 static wxString GetSM()
 {
 #if wxUSE_DETECT_SM
 static wxString GetSM()
 {


@@ -292,15 +280,19 @@ static wxString GetSM()
     if ( !dpy )
         return wxEmptyString;
 
     if ( !dpy )
         return wxEmptyString;
 

+    char smerr[256];

     char *client_id;
     SmcConn smc_conn = SmcOpenConnection(NULL, NULL,
                                          999, 999,
                                          0 /* mask */, NULL /* callbacks */,
                                          NULL, &client_id,
     char *client_id;
     SmcConn smc_conn = SmcOpenConnection(NULL, NULL,
                                          999, 999,
                                          0 /* mask */, NULL /* callbacks */,
                                          NULL, &client_id,

-                                         0, NULL);
+                                         WXSIZEOF(smerr), smerr);

 
     if ( !smc_conn )
 
     if ( !smc_conn )

+    {
+        wxLogWarning(_("Failed to connect to session manager: %s"), smerr);

         return wxEmptyString;
         return wxEmptyString;

+    }

 
     char *vendor = SmcVendor(smc_conn);
     wxString ret = wxString::FromAscii( vendor );
 
     char *vendor = SmcVendor(smc_conn);
     wxString ret = wxString::FromAscii( vendor );


@@ -318,6 +310,20 @@ static wxString GetSM()
 // wxGUIAppTraits
 //-----------------------------------------------------------------------------
 
 // wxGUIAppTraits
 //-----------------------------------------------------------------------------
 

+wxEventLoopBase *wxGUIAppTraits::CreateEventLoop()
+{
+    return new wxEventLoop();
+}
+
+
+#if wxUSE_INTL
+void wxGUIAppTraits::SetLocale()
+{
+    gtk_set_locale();
+    wxUpdateLocaleIsUtf8();
+}
+#endif
+

 #ifdef __WXDEBUG__
 
 #if wxUSE_STACKWALKER
 #ifdef __WXDEBUG__
 
 #if wxUSE_STACKWALKER


@@ -422,18 +428,112 @@ bool wxGUIAppTraits::ShowAssertDialog(const wxString& msg)
 
 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 {
 
 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 {

+    wxString de = wxSystemOptions::GetOption(_T("gtk.desktop"));

 #if wxUSE_DETECT_SM
 #if wxUSE_DETECT_SM

-    const wxString SM = GetSM();
-
-    if (SM == wxT("GnomeSM"))
-        return wxT("GNOME");
+    if ( de.empty() )
+    {
+        static const wxString s_SM = GetSM();

 
 

-    if (SM == wxT("KDE"))
-        return wxT("KDE");
+        if (s_SM == wxT("GnomeSM"))
+            de = wxT("GNOME");
+        else if (s_SM == wxT("KDE"))
+            de = wxT("KDE");
+    }

 #endif // wxUSE_DETECT_SM
 
 #endif // wxUSE_DETECT_SM
 

-    return wxEmptyString;
+    return de;

 }
 
 }
 

+#ifdef __WXGTK26__
+
+// see the hack below in wxCmdLineParser::GetUsageString().
+// TODO: replace this hack with a g_option_group_get_entries()
+//       call as soon as such function exists
+struct _GOptionGroup
+{
+  gchar           *name;
+  gchar           *description;
+  gchar           *help_description;
+
+  GDestroyNotify   destroy_notify;
+  gpointer         user_data;
+
+  GTranslateFunc   translate_func;
+  GDestroyNotify   translate_notify;
+  gpointer     translate_data;
+
+  GOptionEntry    *entries;
+  gint             n_entries;
+
+  GOptionParseFunc pre_parse_func;
+  GOptionParseFunc post_parse_func;
+  GOptionErrorFunc error_func;
+};
+
+wxString wxGetNameFromGtkOptionEntry(const GOptionEntry *opt)
+{
+    wxString ret;
+
+    if (opt->short_name)
+        ret << _T("-") << opt->short_name;
+    if (opt->long_name)
+    {
+        if (!ret.empty())
+            ret << _T(", ");
+        ret << _T("--") << opt->long_name;

 
 

+        if (opt->arg_description)
+            ret << _T("=") << opt->arg_description;
+    }
+
+    return _T("  ") + ret;
+}
+
+#endif // __WXGTK26__
+
+wxString
+wxGUIAppTraits::GetStandardCmdLineOptions(wxArrayString& names,
+                                          wxArrayString& desc) const
+{
+    wxString usage;
+
+#ifdef __WXGTK26__
+    // check whether GTK version is greater than 2.6 but also lower than 2.12
+    // because, as we use the undocumented _GOptionGroup struct, we don't want
+    // to run this code with future versions which might change it (2.11 is the
+    // latest one at the time of this writing)
+    if (!gtk_check_version(2,6,0) &&
+        gtk_check_version(2,12,0))
+    {
+        usage << _("The following standard GTK+ options are also supported:\n");
+
+        // passing true here means that the function can open the default
+        // display while parsing (not really used here anyhow)
+        GOptionGroup *gtkOpts = gtk_get_option_group(true);
+
+        // WARNING: here we access the internals of GOptionGroup:
+        GOptionEntry *entries = ((_GOptionGroup*)gtkOpts)->entries;
+        unsigned int n_entries = ((_GOptionGroup*)gtkOpts)->n_entries;
+        wxArrayString namesOptions, descOptions;
+
+        for ( size_t n = 0; n < n_entries; n++ )
+        {
+            if ( entries[n].flags & G_OPTION_FLAG_HIDDEN )
+                continue;       // skip
+
+            names.push_back(wxGetNameFromGtkOptionEntry(&entries[n]));
+
+            const gchar * const entryDesc = entries[n].description;
+            desc.push_back(wxString(entryDesc));
+        }
+
+        g_option_group_free (gtkOpts);
+    }
+#else
+    wxUnusedVar(names);
+    wxUnusedVar(desc);
+#endif // __WXGTK26__
+
+    return usage;
+}