Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/private.h b/include/wx/gtk/private.h
index 7352f87369905e4896f4c2151e9d110d624591a7..69de2460a99f279ab02704bf23beb5235d6edea6 100644 (file)
--- a/include/wx/gtk/private.h
+++ b/include/wx/gtk/private.h
@@ -14,99 +14,115 @@
 
 #include <gtk/gtk.h>
 
 
 #include <gtk/gtk.h>
 

-#include "wx/event.h"

 #include "wx/gtk/private/string.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
+#include "wx/gtk/private/gtk2-compat.h"
+
+// 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);

 
 #if wxUSE_UNICODE
 
 #if wxUSE_UNICODE

-    #define wxGTK_CONV(s) wxConvUTF8.cWX2MB((s))
+    #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_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) wxConvUTF8.cMB2WX((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
     #include "wx/font.h"
 
 #else
     #include "wx/font.h"
 

-    // convert the text in given encoding to UTF-8 used by wxGTK
-    extern wxCharBuffer
+    // 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);
 
     wxConvertToGTK(const wxString& s,
                    wxFontEncoding enc = wxFONTENCODING_SYSTEM);
 

+    extern WXDLLIMPEXP_CORE wxCharBuffer
+    wxConvertFromGTK(const wxString& s,
+                     wxFontEncoding enc = wxFONTENCODING_SYSTEM);
+

     // helper: use the encoding of the given font if it's valid
     inline wxCharBuffer wxConvertToGTK(const wxString& s, const wxFont& font)
     {
     // 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()
+        return wxConvertToGTK(s, font.IsOk() ? font.GetEncoding()

                                            : wxFONTENCODING_SYSTEM);
     }
 
                                            : wxFONTENCODING_SYSTEM);
     }
 

+    inline wxCharBuffer wxConvertFromGTK(const wxString& s, const wxFont& font)
+    {
+        return wxConvertFromGTK(s, font.IsOk() ? font.GetEncoding()
+                                             : wxFONTENCODING_SYSTEM);
+    }
+
+    // more helpers: allow passing GTK+ strings directly
+    inline wxCharBuffer
+    wxConvertFromGTK(const wxGtkString& gs,
+                     wxFontEncoding enc = wxFONTENCODING_SYSTEM)
+    {
+        return wxConvertFromGTK(gs.c_str(), enc);
+    }
+
+    inline wxCharBuffer
+    wxConvertFromGTK(const wxGtkString& gs, const wxFont& font)
+    {
+        return wxConvertFromGTK(gs.c_str(), font);
+    }
+
+    #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_ENC(s, enc) wxConvertToGTK((s), (enc))
     #define wxGTK_CONV_FONT(s, font) wxConvertToGTK((s), (font))

-    #define wxGTK_CONV(s) wxGTK_CONV_FONT((s), m_font)

     #define wxGTK_CONV_SYS(s) wxConvertToGTK((s))
     #define wxGTK_CONV_SYS(s) wxConvertToGTK((s))

-    #define wxGTK_CONV_BACK(s)  wxConvLocal.cWC2WX(wxConvUTF8.cMB2WC((s)))
-#endif

 
 

-// Some deprecated GTK+ prototypes we still use often
-// FIXME: Don't use them if possible.
-G_BEGIN_DECLS
-
-// Should use gtk_image_new, but the mask seems to be handled different,
-// and we need to migrate
-GtkWidget* gtk_pixmap_new (GdkPixmap *pixmap,
-                           GdkBitmap *mask);
-
-// Deprecated since GTK+-1.3.7:
-// Trivial wrapper around gtk_window_move, with some side effects we seem to rely on
-void gtk_widget_set_uposition (GtkWidget *widget,
-                               gint      x,
-                               gint      y);
-
-// We rely on the allow_shrink parameter in one place
-void gtk_window_set_policy (GtkWindow *window,
-                            gint       allow_shrink,
-                            gint       allow_grow,
-                            gint       auto_shrink);
-
-G_END_DECLS
-
-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
-
-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
-
-//-----------------------------------------------------------------------------
-// Misc. functions
-//-----------------------------------------------------------------------------
-
-// Needed for implementing e.g. combobox on wxGTK within a modal dialog.
-void wxAddGrab(wxWindow* window);
-void wxRemoveGrab(wxWindow* window);
-
-// Escapes string so that it is valid Pango markup XML string:
-WXDLLIMPEXP_CORE wxString wxEscapeStringForPangoMarkup(const wxString& str);
-
-// The declaration for gtk_icon_size_lookup was accidentally ifdefed out in
-// GTK+ 2.1.0 which Sun seem to have shipped with some versions of JDS
-// for Solaris 9 x86.
-#ifdef NEED_GTK_ICON_SIZE_LOOKUP
-extern "C" gboolean gtk_icon_size_lookup  (GtkIconSize  size,
-                                           gint         *width,
-                                           gint         *height);
+    #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__
-#include <gdk/gdktypes.h>
-
-// Returns stock accelerator modifier and key code for the given ID
-WXDLLEXPORT bool wxGetStockGtkAccelerator(const char *id, GdkModifierType *mod, guint *key);
+// Define a macro for converting wxString to char* in appropriate encoding for
+// the file names.
+#ifdef G_OS_WIN32
+    // Under MSW, UTF-8 file name encodings are always used.
+    #define wxGTK_CONV_FN(s) (s).utf8_str()
+#else
+    // Under Unix use GLib file name encoding (which is also UTF-8 by default
+    // but may be different from it).
+    #define wxGTK_CONV_FN(s) (s).fn_str()

 #endif
 
 #endif
 

-#endif // _WX_GTK_PRIVATE_H_
+// ----------------------------------------------------------------------------
+// various private helper functions
+// ----------------------------------------------------------------------------
+
+namespace wxGTKPrivate
+{
+
+// 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
+WXDLLIMPEXP_CORE GtkWidget *GetButtonWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetCheckButtonWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetComboBoxWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetEntryWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetHeaderButtonWidgetFirst();
+WXDLLIMPEXP_CORE GtkWidget *GetHeaderButtonWidgetLast();
+WXDLLIMPEXP_CORE GtkWidget *GetHeaderButtonWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetNotebookWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetRadioButtonWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetSplitterWidget(wxOrientation orient = wxHORIZONTAL);
+WXDLLIMPEXP_CORE GtkWidget *GetTextEntryWidget();
+WXDLLIMPEXP_CORE GtkWidget *GetTreeWidget();
+
+} // wxGTKPrivate

 
 

+#endif // _WX_GTK_PRIVATE_H_