include/wx/gtk/private.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/private.h
   3 // Purpose:     wxGTK private macros, functions &c
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     12.03.02
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GTK_PRIVATE_H_
  13 #define _WX_GTK_PRIVATE_H_
  14
  15 #include <gtk/gtk.h>
  16
  17 #include "wx/event.h"
  18
  19 // fail all version tests if the GTK+ version is so ancient that it doesn't
  20 // even have GTK_CHECK_VERSION
  21 #ifndef GTK_CHECK_VERSION
  22     #define GTK_CHECK_VERSION(a, b, c) 0
  23 #endif
  24
  25 #if wxUSE_UNICODE
  26     #define wxGTK_CONV(s) wxConvUTF8.cWX2MB(s)
  27     #define wxGTK_CONV_BACK(s) wxConvUTF8.cMB2WX(s)
  28 #else
  29     #define wxGTK_CONV(s) wxConvUTF8.cWC2MB( wxConvLocal.cWX2WC(s) )
  30     #define wxGTK_CONV_BACK(s)  wxConvLocal.cWC2WX( (wxConvUTF8.cMB2WC( s ) ) )
  31 #endif
  32
  33 // Some deprecated GTK+ prototypes we still use often
  34 // FIXME: Don't use them if possible.
  35 G_BEGIN_DECLS
  36
  37 // Should use gtk_image_new, but the mask seems to be handled different,
  38 // and we need to migrate
  39 GtkWidget* gtk_pixmap_new (GdkPixmap *pixmap,
  40                            GdkBitmap *mask);
  41
  42 // Deprecated since GTK+-1.3.7:
  43 // Trivial wrapper around gtk_window_move, with some side effects we seem to rely on
  44 void gtk_widget_set_uposition (GtkWidget *widget,
  45                                gint      x,
  46                                gint      y);
  47
  48 // We rely on the allow_shrink parameter in one place
  49 void gtk_window_set_policy (GtkWindow *window,
  50                             gint       allow_shrink,
  51                             gint       allow_grow,
  52                             gint       auto_shrink);
  53
  54 G_END_DECLS
  55
  56 //-----------------------------------------------------------------------------
  57 // idle system
  58 //-----------------------------------------------------------------------------
  59
  60 extern void wxapp_install_idle_handler();
  61 extern bool g_isIdle;
  62
  63 //-----------------------------------------------------------------------------
  64 // Convenience class for g_freeing a gchar* on scope exit automatically
  65 //-----------------------------------------------------------------------------
  66
  67 class wxGtkString
  68 {
  69 public:
  70     explicit wxGtkString(gchar *s) : m_str(s) { }
  71     ~wxGtkString() { g_free(m_str); }
  72
  73     const gchar *c_str() const { return m_str; }
  74
  75     operator gchar *() const { return m_str; }
  76
  77 private:
  78     gchar *m_str;
  79
  80     DECLARE_NO_COPY_CLASS(wxGtkString)
  81 };
  82
  83 //-----------------------------------------------------------------------------
  84 // GTK+ scroll types -> wxEventType
  85 //-----------------------------------------------------------------------------
  86
  87 // translate a GTK+ scroll type to a wxEventType
  88 inline wxEventType GtkScrollTypeToWx(guint scrollType)
  89 {
  90     wxEventType command;
  91     switch ( scrollType )
  92     {
  93         case GTK_SCROLL_STEP_BACKWARD:
  94             command = wxEVT_SCROLL_LINEUP;
  95             break;
  96
  97         case GTK_SCROLL_STEP_FORWARD:
  98             command = wxEVT_SCROLL_LINEDOWN;
  99             break;
 100
 101         case GTK_SCROLL_PAGE_BACKWARD:
 102             command = wxEVT_SCROLL_PAGEUP;
 103             break;
 104
 105         case GTK_SCROLL_PAGE_FORWARD:
 106             command = wxEVT_SCROLL_PAGEDOWN;
 107             break;
 108
 109         default:
 110             command = wxEVT_SCROLL_THUMBTRACK;
 111     }
 112
 113     return command;
 114 }
 115
 116 inline wxEventType GtkScrollWinTypeToWx(guint scrollType)
 117 {
 118     // GtkScrollTypeToWx() returns SCROLL_XXX, not SCROLLWIN_XXX as we need
 119     return GtkScrollTypeToWx(scrollType) +
 120             wxEVT_SCROLLWIN_TOP - wxEVT_SCROLL_TOP;
 121 }
 122
 123
 124 //-----------------------------------------------------------------------------
 125 // Misc. functions
 126 //-----------------------------------------------------------------------------
 127
 128 // Needed for implementing e.g. combobox on wxGTK within a modal dialog.
 129 void wxAddGrab(wxWindow* window);
 130 void wxRemoveGrab(wxWindow* window);
 131
 132 // Escapes string so that it is valid Pango markup XML string:
 133 WXDLLIMPEXP_CORE wxString wxEscapeStringForPangoMarkup(const wxString& str);
 134
 135 // The declaration for gtk_icon_size_lookup was accidentally ifdefed out in
 136 // GTK+ 2.1.0 which Sun seem to have shipped with some versions of JDS
 137 // for Solaris 9 x86.
 138 #ifdef NEED_GTK_ICON_SIZE_LOOKUP
 139 extern "C" gboolean gtk_icon_size_lookup  (GtkIconSize  size,
 140                                            gint         *width,
 141                                            gint         *height);
 142 #endif
 143
 144 #endif // _WX_GTK_PRIVATE_H_
 145