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@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GTK_PRIVATE_H_
  13 #define _WX_GTK_PRIVATE_H_
  14
  15 #include <gdk/gdk.h>
  16 #include <gtk/gtk.h>
  17
  18 #include "wx/event.h"
  19
  20 // fail all version tests if the GTK+ version is so ancient that it doesn't
  21 // even have GTK_CHECK_VERSION
  22 #ifndef GTK_CHECK_VERSION
  23     #define GTK_CHECK_VERSION(a, b, c) 0
  24 #endif
  25
  26 #ifdef __WXGTK20__
  27 #if wxUSE_UNICODE
  28     #define wxGTK_CONV(s) wxConvUTF8.cWX2MB(s)
  29     #define wxGTK_CONV_BACK(s) wxConvUTF8.cMB2WX(s)
  30 #else
  31     #define wxGTK_CONV(s) wxConvUTF8.cWC2MB( wxConvLocal.cWX2WC(s) )
  32     #define wxGTK_CONV_BACK(s)  wxConvLocal.cWC2WX( (wxConvUTF8.cMB2WC( s ) ) )
  33 #endif
  34 #else
  35     #define wxGTK_CONV(s) s.c_str()
  36     #define wxGTK_CONV_BACK(s) s
  37 #endif
  38
  39
  40 // GTK+ 2.0 compatibility define is broken when used from C++ as it
  41 // casts enum to int implicitly
  42 #ifdef __WXGTK20__
  43     #undef gtk_signal_disconnect_by_func
  44     #define gtk_signal_disconnect_by_func(object,func,data) \
  45         gtk_signal_compat_matched((object), (func), (data), \
  46                                   (GSignalMatchType)(G_SIGNAL_MATCH_FUNC | \
  47                                                      G_SIGNAL_MATCH_DATA), 0)
  48 #endif
  49
  50 // child is not a member of GTK_BUTTON() any more in GTK+ 2.0
  51 #ifdef __WXGTK20__
  52     #define BUTTON_CHILD(w) GTK_BIN((w))->child
  53 #else
  54     #define BUTTON_CHILD(w) GTK_BUTTON((w))->child
  55 #endif
  56
  57 // event_window has disappeared from GtkToggleButton in GTK+ 2.0
  58 #ifdef __WXGTK20__
  59     #define TOGGLE_BUTTON_EVENT_WIN(w) GTK_BUTTON((w))->event_window
  60 #else
  61     #define TOGGLE_BUTTON_EVENT_WIN(w) GTK_TOGGLE_BUTTON((w))->event_window
  62 #endif
  63
  64 // gtk_editable_{copy|cut|paste}_clipboard() had an extra argument under
  65 // previous GTK+ versions but no more
  66 #if defined(__WXGTK20__) || (GTK_MINOR_VERSION > 0)
  67     #define DUMMY_CLIPBOARD_ARG
  68 #else
  69     #define DUMMY_CLIPBOARD_ARG  ,0
  70 #endif
  71
  72 // _GtkEditable is now private
  73 #ifdef __WXGTK20__
  74     #define GET_EDITABLE_POS(w) gtk_editable_get_position(GTK_EDITABLE(w))
  75     #define SET_EDITABLE_POS(w, pos) \
  76         gtk_editable_set_position(GTK_EDITABLE(w), (pos))
  77 #else
  78     #define GET_EDITABLE_POS(w) GTK_EDITABLE((w))->current_pos
  79     #define SET_EDITABLE_POS(w, pos) \
  80         GTK_EDITABLE((w))->current_pos = (pos)
  81 #endif
  82
  83 // this GtkNotebook struct field has been renamed
  84 #ifdef __WXGTK20__
  85     #define NOTEBOOK_PANEL(nb)  GTK_NOTEBOOK(nb)->event_window
  86 #else
  87     #define NOTEBOOK_PANEL(nb)  GTK_NOTEBOOK(nb)->panel
  88 #endif
  89
  90 #ifdef __WXGTK20__
  91     #define SCROLLBAR_CBACK_ARG
  92     #define GET_SCROLL_TYPE(w)   GTK_SCROLL_JUMP
  93 #else
  94     #define SCROLLBAR_CBACK_ARG
  95     #define GET_SCROLL_TYPE(w)   GTK_RANGE((w))->scroll_type
  96 #endif
  97
  98 // translate a GTK+ scroll type to a wxEventType
  99 inline wxEventType GtkScrollTypeToWx(guint scrollType)
 100 {
 101     wxEventType command;
 102     switch ( scrollType )
 103     {
 104         case GTK_SCROLL_STEP_BACKWARD:
 105             command = wxEVT_SCROLL_LINEUP;
 106             break;
 107
 108         case GTK_SCROLL_STEP_FORWARD:
 109             command = wxEVT_SCROLL_LINEDOWN;
 110             break;
 111
 112         case GTK_SCROLL_PAGE_BACKWARD:
 113             command = wxEVT_SCROLL_PAGEUP;
 114             break;
 115
 116         case GTK_SCROLL_PAGE_FORWARD:
 117             command = wxEVT_SCROLL_PAGEDOWN;
 118             break;
 119
 120         default:
 121             command = wxEVT_SCROLL_THUMBTRACK;
 122     }
 123
 124     return command;
 125 }
 126
 127 inline wxEventType GtkScrollWinTypeToWx(guint scrollType)
 128 {
 129     // GtkScrollTypeToWx() returns SCROLL_XXX, not SCROLLWIN_XXX as we need
 130     return GtkScrollTypeToWx(scrollType) +
 131             wxEVT_SCROLLWIN_TOP - wxEVT_SCROLL_TOP;
 132 }
 133
 134
 135
 136 // In wxGTK2 the wxMessageDialog is not a real wxDialog, instead a
 137 // gtk_message_dialog is created, shown and destroyed inside the ShowModal()
 138 // call.  Since its m_widget will always be NULL there would normally be lots
 139 // of wxCHECK asserts triggered by calling base class methods that are valid
 140 // calls (or just ignored) on other wx ports.  Using these macros instead of
 141 // wxCHECK will silence those asserts if the window is a wxMessageDialog and
 142 // will let the method doing the check just be ignored in that case.  If it's
 143 // not a wxMessageDialog then it behaves just like before.
 144 //
 145 // NOTE: Once more native dialogs are used then this will need to be
 146 //       generalized a bit, perhaps with a IsNativeGTKDialog method or
 147 //       something...
 148
 149 #if wxUSE_MSGDLG && defined(__WXGTK20__) && !defined(__WXGPE__)
 150 #define wxCHECK_VALID_WIDGET(rc)   \
 151     if (!(m_widget != NULL)) { \
 152         if (!wxIsKindOf(this, wxMessageDialog)) { wxFAIL_MSG(wxT("invalid window")); } \
 153         return rc; \
 154     }
 155
 156 #define wxCHECK_VALID_WIDGET_RET()    \
 157     if (!(m_widget != NULL)) { \
 158         if (!wxIsKindOf(this, wxMessageDialog)) { wxFAIL_MSG(wxT("invalid window")); } \
 159         return; \
 160     }
 161
 162 #else  // not wxGTK2, so just use wxCHECK
 163 #define wxCHECK_VALID_WIDGET(rc)   wxCHECK_MSG( (m_widget != NULL), rc, wxT("invalid window") )
 164 #define wxCHECK_VALID_WIDGET_RET() wxCHECK_RET( (m_widget != NULL),     wxT("invalid window") );
 165 #endif
 166
 167
 168 #endif // _WX_GTK_PRIVATE_H_
 169