Fixed typo in documentation string

[wxWidgets.git] / include / wx / gtk / private.h

diff --git a/include/wx/gtk/private.h b/include/wx/gtk/private.h
index 877dd4b56191de5cb0f55a2020b95c61fbd311c4..b63479d372aee9431823af5228abe6400665ffa6 100644 (file)
--- a/include/wx/gtk/private.h
+++ b/include/wx/gtk/private.h
@@ -5,145 +5,112 @@
 // Modified by:
 // Created:     12.03.02
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     12.03.02
 // RCS-ID:      $Id$

-// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwindows.org>
-// Licence:     wxWindows license
+// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwidgets.org>
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_GTK_PRIVATE_H_
 #define _WX_GTK_PRIVATE_H_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_GTK_PRIVATE_H_
 #define _WX_GTK_PRIVATE_H_
 

-#include <gdk/gdk.h>

 #include <gtk/gtk.h>
 
 #include <gtk/gtk.h>
 

-#include "wx/event.h"
+#include "wx/gtk/private/string.h"

 
 

-// fail all version tests if the GTK+ version is so ancient that it doesn't
-// even have GTK_CHECK_VERSION
-#ifndef GTK_CHECK_VERSION
-    #define GTK_CHECK_VERSION(a, b, c) 0
-#endif
+// pango_version_check symbol is quite recent ATM (4/2007)... so we
+// use our own wrapper which implements a smart trick.
+// Use this function as you'd use pango_version_check:
+//
+//  if (!wx_pango_version_check(1,18,0))
+//     ... call to a function available only in pango >= 1.18 ...
+//
+// and use it only to test for pango versions >= 1.16.0
+extern const gchar *wx_pango_version_check(int major, int minor, int micro);

 
 

-#ifdef __WXGTK20__

 #if wxUSE_UNICODE
 #if wxUSE_UNICODE

-    #define wxGTK_CONV(s) wxConvUTF8.cWX2MB(s)
-    #define wxGTK_CONV_BACK(s) wxConvUTF8.cMB2WX(s)
-#else
-    #define wxGTK_CONV(s) wxConvUTF8.cWC2MB( wxConvLocal.cWX2WC(s) )
-    #define wxGTK_CONV_BACK(s)  wxConvLocal.cWC2WX( (wxConvUTF8.cMB2WC( s ) ) )
-#endif
+    #define wxGTK_CONV(s) s.utf8_str()
+    #define wxGTK_CONV_ENC(s, enc) wxGTK_CONV((s))
+    #define wxGTK_CONV_FONT(s, font) wxGTK_CONV((s))
+    #define wxGTK_CONV_SYS(s) wxGTK_CONV((s))
+
+    #define wxGTK_CONV_BACK(s) wxString::FromUTF8Unchecked(s)
+    #define wxGTK_CONV_BACK_ENC(s, enc) wxGTK_CONV_BACK(s)
+    #define wxGTK_CONV_BACK_FONT(s, font) wxGTK_CONV_BACK(s)
+    #define wxGTK_CONV_BACK_SYS(s) wxGTK_CONV_BACK(s)

 #else
 #else

-    #define wxGTK_CONV(s) s.c_str()
-    #define wxGTK_CONV_BACK(s) s
-#endif
+    #include "wx/font.h"

 
 

+    // convert the text between the given encoding and UTF-8 used by wxGTK
+    extern WXDLLIMPEXP_CORE wxCharBuffer
+    wxConvertToGTK(const wxString& s,
+                   wxFontEncoding enc = wxFONTENCODING_SYSTEM);

 
 

-// GTK+ 2.0 compatibility define is broken when used from C++ as it
-// casts enum to int implicitly
-#ifdef __WXGTK20__
-    #undef gtk_signal_disconnect_by_func
-    #define gtk_signal_disconnect_by_func(object,func,data) \
-        gtk_signal_compat_matched((object), (func), (data), \
-                                  (GSignalMatchType)(G_SIGNAL_MATCH_FUNC | \
-                                                     G_SIGNAL_MATCH_DATA), 0)
-#endif
+    extern WXDLLIMPEXP_CORE wxCharBuffer
+    wxConvertFromGTK(const wxString& s,
+                     wxFontEncoding enc = wxFONTENCODING_SYSTEM);

 
 

-// child is not a member of GTK_BUTTON() any more in GTK+ 2.0
-#ifdef __WXGTK20__
-    #define BUTTON_CHILD(w) GTK_BIN((w))->child
-#else
-    #define BUTTON_CHILD(w) GTK_BUTTON((w))->child
-#endif
+    // helper: use the encoding of the given font if it's valid
+    inline wxCharBuffer wxConvertToGTK(const wxString& s, const wxFont& font)
+    {
+        return wxConvertToGTK(s, font.Ok() ? font.GetEncoding()
+                                           : wxFONTENCODING_SYSTEM);
+    }

 
 

-// event_window has disappeared from GtkToggleButton in GTK+ 2.0
-#ifdef __WXGTK20__
-    #define TOGGLE_BUTTON_EVENT_WIN(w) GTK_BUTTON((w))->event_window
-#else
-    #define TOGGLE_BUTTON_EVENT_WIN(w) GTK_TOGGLE_BUTTON((w))->event_window
-#endif
+    inline wxCharBuffer wxConvertFromGTK(const wxString& s, const wxFont& font)
+    {
+        return wxConvertFromGTK(s, font.Ok() ? font.GetEncoding()
+                                             : wxFONTENCODING_SYSTEM);
+    }

 
 

-// get the font from a style
-//
-// TODO: GdkFont has been replaced by PangoFontDescription in GTK+ 2.0
-//       and we really should use it instead of GdkFont (see also dclient.cpp)
-#ifdef __WXGTK20__
-    #define GET_STYLE_FONT(style) gtk_style_get_font(style)
-    #define SET_STYLE_FONT(style, font) gtk_style_set_font(style, font)
-#else
-    #define GET_STYLE_FONT(style) ((style)->font)
-    #define SET_STYLE_FONT(style, fnt) \
-        gdk_font_unref( style->font );  \
-        style->font = gdk_font_ref( fnt )
-#endif
+    // more helpers: allow passing GTK+ strings directly
+    inline wxCharBuffer
+    wxConvertFromGTK(const wxGtkString& gs,
+                     wxFontEncoding enc = wxFONTENCODING_SYSTEM)
+    {
+        return wxConvertFromGTK(gs.c_str(), enc);
+    }

 
 

-// gtk_editable_{copy|cut|paste}_clipboard() had an extra argument under
-// previous GTK+ versions but no more
-#if defined(__WXGTK20__) || (GTK_MINOR_VERSION > 0)
-    #define DUMMY_CLIPBOARD_ARG
-#else
-    #define DUMMY_CLIPBOARD_ARG  ,0
-#endif
+    inline wxCharBuffer
+    wxConvertFromGTK(const wxGtkString& gs, const wxFont& font)
+    {
+        return wxConvertFromGTK(gs.c_str(), font);
+    }

 
 

-// _GtkEditable is now private
-#ifdef __WXGTK20__
-    #define GET_EDITABLE_POS(w) gtk_editable_get_position(GTK_EDITABLE(w))
-    #define SET_EDITABLE_POS(w, pos) \
-        gtk_editable_set_position(GTK_EDITABLE(w), (pos))
-#else
-    #define GET_EDITABLE_POS(w) GTK_EDITABLE((w))->current_pos
-    #define SET_EDITABLE_POS(w, pos) \
-        GTK_EDITABLE((w))->current_pos = (pos)
-#endif
+    #define wxGTK_CONV(s) wxGTK_CONV_FONT((s), m_font)
+    #define wxGTK_CONV_ENC(s, enc) wxConvertToGTK((s), (enc))
+    #define wxGTK_CONV_FONT(s, font) wxConvertToGTK((s), (font))
+    #define wxGTK_CONV_SYS(s) wxConvertToGTK((s))

 
 

-// this GtkNotebook struct field has been renamed
-#ifdef __WXGTK20__
-    #define NOTEBOOK_PANEL(nb)  GTK_NOTEBOOK(nb)->event_window
-#else
-    #define NOTEBOOK_PANEL(nb)  GTK_NOTEBOOK(nb)->panel
+    #define wxGTK_CONV_BACK(s) wxConvertFromGTK((s), m_font)
+    #define wxGTK_CONV_BACK_ENC(s, enc) wxConvertFromGTK((s), (enc))
+    #define wxGTK_CONV_BACK_FONT(s, font) wxConvertFromGTK((s), (font))
+    #define wxGTK_CONV_BACK_SYS(s) wxConvertFromGTK((s))

 #endif
 
 #endif
 

-#ifdef __WXGTK20__
-    #define SCROLLBAR_CBACK_ARG
-    #define GET_SCROLL_TYPE(w)   GTK_SCROLL_JUMP
-#else
-    #define SCROLLBAR_CBACK_ARG
-    #define GET_SCROLL_TYPE(w)   GTK_RANGE((w))->scroll_type
-#endif
+// ----------------------------------------------------------------------------
+// various private helper functions
+// ----------------------------------------------------------------------------

 
 

-// translate a GTK+ scroll type to a wxEventType
-inline wxEventType GtkScrollTypeToWx(guint scrollType)
+namespace wxGTKPrivate

 {
 {

-    wxEventType command;
-    switch ( scrollType )
-    {
-        case GTK_SCROLL_STEP_BACKWARD:
-            command = wxEVT_SCROLL_LINEUP;
-            break;
-
-        case GTK_SCROLL_STEP_FORWARD:
-            command = wxEVT_SCROLL_LINEDOWN;
-            break;
-
-        case GTK_SCROLL_PAGE_BACKWARD:
-            command = wxEVT_SCROLL_PAGEUP;
-            break;

 
 

-        case GTK_SCROLL_PAGE_FORWARD:
-            command = wxEVT_SCROLL_PAGEDOWN;
-            break;
-
-        default:
-            command = wxEVT_SCROLL_THUMBTRACK;
-    }
-
-    return command;
-}
-
-inline wxEventType GtkScrollWinTypeToWx(guint scrollType)
-{
-    // GtkScrollTypeToWx() returns SCROLL_XXX, not SCROLLWIN_XXX as we need
-    return GtkScrollTypeToWx(scrollType) +
-            wxEVT_SCROLLWIN_TOP - wxEVT_SCROLL_TOP;
-}
+// these functions create the GTK widgets of the specified types which can then
+// used to retrieve their styles, pass them to drawing functions &c
+//
+// the returned widgets shouldn't be destroyed, this is done automatically on
+// shutdown
+GtkWidget *GetButtonWidget();
+GtkWidget *GetCheckButtonWidget();
+GtkWidget *GetComboBoxWidget();
+GtkWidget *GetEntryWidget();
+GtkWidget *GetHeaderButtonWidgetFirst();
+GtkWidget *GetHeaderButtonWidgetLast();
+GtkWidget *GetHeaderButtonWidget();
+GtkWidget *GetRadioButtonWidget();
+GtkWidget *GetSplitterWidget();
+GtkWidget *GetTextEntryWidget();
+GtkWidget *GetTreeWidget();
+
+} // wxGTKPrivate

 
 #endif // _WX_GTK_PRIVATE_H_
 
 
 #endif // _WX_GTK_PRIVATE_H_