More comments about non-native GTH widgets.

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

diff --git a/src/gtk/renderer.cpp b/src/gtk/renderer.cpp
index efe4eb28015042d62584b6dbfc5b4427c4c3ba8d..7a7beefbd2a71ee52daa9b677525150bbfc0b34f 100644 (file)
--- a/src/gtk/renderer.cpp
+++ b/src/gtk/renderer.cpp
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        gtk/renderer.cpp
+// Name:        src/gtk/renderer.cpp

 // Purpose:     implementation of wxRendererNative for wxGTK
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     20.07.2003
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
 // Purpose:     implementation of wxRendererNative for wxGTK
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     20.07.2003
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>

-// License:     wxWindows license
+// License:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -24,19 +24,21 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/renderer.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-#endif // WX_PRECOMP
+    #include "wx/window.h"
+    #include "wx/dcclient.h"
+    #include "wx/settings.h"
+#endif

 
 #include <gtk/gtk.h>
 #include "wx/gtk/win_gtk.h"
 
 
 #include <gtk/gtk.h>
 #include "wx/gtk/win_gtk.h"
 

-#include "wx/window.h"
-#include "wx/dc.h"
-#include "wx/renderer.h"
-
-#ifdef __WXGTK20__
-    #include "wx/settings.h"
-#endif // GTK 2.0
+// RR: After a correction to the orientation of the sash
+//     this doesn't seem to be required anymore and it
+//     seems to confuse some themes so USE_ERASE_RECT=0
+#define USE_ERASE_RECT 0

 
 // ----------------------------------------------------------------------------
 // wxRendererGTK: our wxRendererNative implementation
 
 // ----------------------------------------------------------------------------
 // wxRendererGTK: our wxRendererNative implementation


@@ -51,24 +53,61 @@ public:
                                   const wxRect& rect,
                                   int flags = 0);
 
                                   const wxRect& rect,
                                   int flags = 0);
 

-#ifdef __WXGTK20__

     // draw the expanded/collapsed icon for a tree control item
     virtual void DrawTreeItemButton(wxWindow *win,
                                     wxDC& dc,
                                     const wxRect& rect,
                                     int flags = 0);
     // draw the expanded/collapsed icon for a tree control item
     virtual void DrawTreeItemButton(wxWindow *win,
                                     wxDC& dc,
                                     const wxRect& rect,
                                     int flags = 0);

-#endif // GTK 2.0

 
     virtual void DrawSplitterBorder(wxWindow *win,
                                     wxDC& dc,
 
     virtual void DrawSplitterBorder(wxWindow *win,
                                     wxDC& dc,

-                                    const wxRect& rect) ;
+                                    const wxRect& rect,
+                                    int flags = 0);

     virtual void DrawSplitterSash(wxWindow *win,
                                   wxDC& dc,
                                   const wxSize& size,
                                   wxCoord position,
     virtual void DrawSplitterSash(wxWindow *win,
                                   wxDC& dc,
                                   const wxSize& size,
                                   wxCoord position,

-                                  wxOrientation orient);
+                                  wxOrientation orient,
+                                  int flags = 0);
+
+    virtual void DrawComboBoxDropButton(wxWindow *win,
+                                        wxDC& dc,
+                                        const wxRect& rect,
+                                        int flags = 0);
+
+    virtual void DrawDropArrow(wxWindow *win,
+                               wxDC& dc,
+                               const wxRect& rect,
+                               int flags = 0);
+
+    virtual void DrawCheckBox(wxWindow *win,
+                              wxDC& dc,
+                              const wxRect& rect,
+                              int flags = 0);
+
+    virtual void DrawPushButton(wxWindow *win,
+                                wxDC& dc,
+                                const wxRect& rect,
+                                int flags = 0);
+
+    virtual void DrawItemSelectionRect(wxWindow *win,
+                                       wxDC& dc,
+                                       const wxRect& rect,
+                                       int flags = 0);
+
+    virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win);
+
+private:
+    // FIXME: shouldn't we destroy these windows somewhere?

 
 

-    virtual wxPoint GetSplitterSashAndBorder(const wxWindow *win);
+    // used by DrawHeaderButton and DrawPushButton
+    static GtkWidget *GetButtonWidget();
+
+    // used by DrawTreeItemButton()
+    static GtkWidget *GetTreeWidget();
+
+    // used by DrawCheckBox()
+    static GtkWidget *GetCheckButtonWidget();

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -76,13 +115,71 @@ public:
 // ============================================================================
 
 /* static */
 // ============================================================================
 
 /* static */

-wxRendererNative& wxRendererNative::Get()
+wxRendererNative& wxRendererNative::GetDefault()

 {
     static wxRendererGTK s_rendererGTK;
 
     return s_rendererGTK;
 }
 
 {
     static wxRendererGTK s_rendererGTK;
 
     return s_rendererGTK;
 }
 

+// ----------------------------------------------------------------------------
+// helper functions
+// ----------------------------------------------------------------------------
+
+GtkWidget *
+wxRendererGTK::GetButtonWidget()
+{
+    static GtkWidget *s_button = NULL;
+    static GtkWidget *s_window = NULL;
+
+    if ( !s_button )
+    {
+        s_window = gtk_window_new( GTK_WINDOW_POPUP );
+        gtk_widget_realize( s_window );
+        s_button = gtk_button_new();
+        gtk_container_add( GTK_CONTAINER(s_window), s_button );
+        gtk_widget_realize( s_button );
+    }
+
+    return s_button;
+}
+
+GtkWidget *
+wxRendererGTK::GetCheckButtonWidget()
+{
+    static GtkWidget *s_button = NULL;
+    static GtkWidget *s_window = NULL;
+
+    if ( !s_button )
+    {
+        s_window = gtk_window_new( GTK_WINDOW_POPUP );
+        gtk_widget_realize( s_window );
+        s_button = gtk_check_button_new();
+        gtk_container_add( GTK_CONTAINER(s_window), s_button );
+        gtk_widget_realize( s_button );
+    }
+
+    return s_button;
+}
+
+GtkWidget *
+wxRendererGTK::GetTreeWidget()
+{
+    static GtkWidget *s_tree = NULL;
+    static GtkWidget *s_window = NULL;
+
+    if ( !s_tree )
+    {
+        s_tree = gtk_tree_view_new();
+        s_window = gtk_window_new( GTK_WINDOW_POPUP );
+        gtk_widget_realize( s_window );
+        gtk_container_add( GTK_CONTAINER(s_window), s_tree );
+        gtk_widget_realize( s_tree );
+    }
+
+    return s_tree;
+}
+

 // ----------------------------------------------------------------------------
 // list/tree controls drawing
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // list/tree controls drawing
 // ----------------------------------------------------------------------------


@@ -93,82 +190,88 @@ wxRendererGTK::DrawHeaderButton(wxWindow *win,
                                 const wxRect& rect,
                                 int flags)
 {
                                 const wxRect& rect,
                                 int flags)
 {

+
+    GtkWidget *button = GetButtonWidget();
+

     gtk_paint_box
     (
     gtk_paint_box
     (

-        win->m_wxwindow->style,
+        button->style,
+        // FIXME: I suppose GTK_PIZZA(win->m_wxwindow)->bin_window doesn't work with wxMemoryDC.
+        //   Maybe use code similar as in DrawPushButton below?

         GTK_PIZZA(win->m_wxwindow)->bin_window,
         flags & wxCONTROL_DISABLED ? GTK_STATE_INSENSITIVE : GTK_STATE_NORMAL,
         GTK_SHADOW_OUT,
         GTK_PIZZA(win->m_wxwindow)->bin_window,
         flags & wxCONTROL_DISABLED ? GTK_STATE_INSENSITIVE : GTK_STATE_NORMAL,
         GTK_SHADOW_OUT,

-        (GdkRectangle*) NULL,
-        win->m_wxwindow,
-        (char *)"button", // const_cast
-        dc.XLOG2DEV(rect.x) - 1, rect.y - 1, rect.width + 2, rect.height + 2
+        NULL,
+        button,
+        "button",
+        dc.LogicalToDeviceX(rect.x), rect.y, rect.width, rect.height

     );
 }
 
     );
 }
 

-#ifdef __WXGTK20__
-

 // draw a ">" or "v" button
 // draw a ">" or "v" button

-//
-// TODO: isn't there a GTK function to draw it?

 void
 void

-wxRendererGTK::DrawTreeItemButton(wxWindow* WXUNUSED(win),
+wxRendererGTK::DrawTreeItemButton(wxWindow* win,

                                   wxDC& dc, const wxRect& rect, int flags)
 {
                                   wxDC& dc, const wxRect& rect, int flags)
 {

-    dc.SetBrush(wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT),
-                        wxSOLID));
-    dc.SetPen(*wxBLACK_PEN);
-    wxPoint button[3];
+    GtkWidget *tree = GetTreeWidget();

 
 

-    const wxCoord xMiddle = rect.x + rect.width/2;
-    const wxCoord yMiddle = rect.y + rect.height/2;
+    GtkStateType state;
+    if ( flags & wxCONTROL_CURRENT )
+        state = GTK_STATE_PRELIGHT;
+    else
+        state = GTK_STATE_NORMAL;

 
 

-    if ( flags & wxCONTROL_EXPANDED )
-    {
-        button[0].x = rect.GetLeft();
-        button[0].y = yMiddle - 2;
-        button[1].x = rect.GetRight();
-        button[1].y = yMiddle - 2;
-        button[2].x = xMiddle;
-        button[2].y = yMiddle + 3;
-    }
-    else // collapsed
-    {
-        button[0].y = rect.GetBottom();
-        button[0].x = xMiddle - 2;
-        button[1].y = rect.GetTop();
-        button[1].x = xMiddle - 2;
-        button[2].y = yMiddle;
-        button[2].x = xMiddle + 3;
-    }
-
-    dc.DrawPolygon(3, button);
+    // VZ: I don't know how to get the size of the expander so as to centre it
+    //     in the given rectangle, +2/3 below is just what looks good here...
+    gtk_paint_expander
+    (
+        tree->style,
+        GTK_PIZZA(win->m_wxwindow)->bin_window,
+        state,
+        NULL,
+        tree,
+        "treeview",
+        dc.LogicalToDeviceX(rect.x) + 2,
+        dc.LogicalToDeviceY(rect.y) + 3,
+        flags & wxCONTROL_EXPANDED ? GTK_EXPANDER_EXPANDED
+                                   : GTK_EXPANDER_COLLAPSED
+    );

 }
 
 }
 

-#endif // GTK 2.0

 
 // ----------------------------------------------------------------------------
 // splitter sash drawing
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // splitter sash drawing
 // ----------------------------------------------------------------------------
 

-// the full sash width (should be even)
-static const wxCoord SASH_SIZE = 10;
+static int GetGtkSplitterFullSize()
+{
+    static GtkWidget *s_paned = NULL;
+    if (s_paned == NULL)
+        s_paned = gtk_vpaned_new();
+
+    gint handle_size;
+    gtk_widget_style_get (s_paned, "handle_size", &handle_size, NULL);

 
 

-// margin around the sash
-static const wxCoord SASH_MARGIN = 5;
+    return handle_size;
+}

 
 

-wxPoint
-wxRendererGTK::GetSplitterSashAndBorder(const wxWindow * WXUNUSED(win))
+wxSplitterRenderParams
+wxRendererGTK::GetSplitterParams(const wxWindow *WXUNUSED(win))

 {
 {

-    // we don't draw any border, hence 0 for the second field, but we must
-    // leave some margin around the sash
-    return wxPoint(SASH_SIZE + SASH_MARGIN, 0);
+    // we don't draw any border, hence 0 for the second field
+    return wxSplitterRenderParams
+           (
+               GetGtkSplitterFullSize(),
+               0,
+               true     // hot sensitive
+           );

 }
 
 void
 wxRendererGTK::DrawSplitterBorder(wxWindow * WXUNUSED(win),
                                   wxDC& WXUNUSED(dc),
 }
 
 void
 wxRendererGTK::DrawSplitterBorder(wxWindow * WXUNUSED(win),
                                   wxDC& WXUNUSED(dc),

-                                  const wxRect& WXUNUSED(rect))
+                                  const wxRect& WXUNUSED(rect),
+                                  int WXUNUSED(flags))

 {
     // nothing to do
 }
 {
     // nothing to do
 }


@@ -178,84 +281,269 @@ wxRendererGTK::DrawSplitterSash(wxWindow *win,
                                 wxDC& dc,
                                 const wxSize& size,
                                 wxCoord position,
                                 wxDC& dc,
                                 const wxSize& size,
                                 wxCoord position,

-                                wxOrientation orient)
+                                wxOrientation orient,
+                                int flags)

 {
     if ( !win->m_wxwindow->window )
     {
 {
     if ( !win->m_wxwindow->window )
     {

-        // VZ: this happens on startup -- why?
+        // window not realized yet

         return;
     }
 
         return;
     }
 

+    wxCoord full_size = GetGtkSplitterFullSize();
+

     // are we drawing vertical or horizontal splitter?
     const bool isVert = orient == wxVERTICAL;
 
     // are we drawing vertical or horizontal splitter?
     const bool isVert = orient == wxVERTICAL;
 

-    // we must erase everything first, otherwise the garbage from the old sash
-    // is left when dragging it
-    //
-    // TODO: is this the right way to draw themed background?

     GdkRectangle rect;
     GdkRectangle rect;

+#if USE_ERASE_RECT
+    GdkRectangle erase_rect;
+#endif
+

     if ( isVert )
     {
     if ( isVert )
     {

+        int h = win->GetClientSize().GetHeight();
+

         rect.x = position;
         rect.y = 0;
         rect.x = position;
         rect.y = 0;

-        rect.width = SASH_SIZE + SASH_MARGIN;
-        rect.height = size.y;
+        rect.width = full_size;
+        rect.height = h;
+
+#if USE_ERASE_RECT
+        erase_rect.x = position;
+        erase_rect.y = 0;
+        erase_rect.width = full_size;
+        erase_rect.height = h;
+#endif

     }
     else // horz
     {
     }
     else // horz
     {

+        int w = win->GetClientSize().GetWidth();
+

         rect.x = 0;
         rect.y = position;
         rect.x = 0;
         rect.y = position;

-        rect.height = SASH_SIZE + SASH_MARGIN;
-        rect.width = size.x;
+        rect.height = full_size;
+        rect.width = w;
+
+#if USE_ERASE_RECT
+        erase_rect.y = position;
+        erase_rect.x = 0;
+        erase_rect.height = full_size;
+        erase_rect.width = w;
+#endif

     }
 
     }
 

+#if USE_ERASE_RECT
+    // we must erase everything first, otherwise the garbage
+    // from the old sash is left when dragging it

     gtk_paint_flat_box
     (
         win->m_wxwindow->style,
         GTK_PIZZA(win->m_wxwindow)->bin_window,
         GTK_STATE_NORMAL,
         GTK_SHADOW_NONE,
     gtk_paint_flat_box
     (
         win->m_wxwindow->style,
         GTK_PIZZA(win->m_wxwindow)->bin_window,
         GTK_STATE_NORMAL,
         GTK_SHADOW_NONE,

-        &rect,
+        NULL,

         win->m_wxwindow,
         win->m_wxwindow,

-        (char *)"base", // const_cast
-        0, 0, -1, -1
+        (char *)"viewportbin", // const_cast
+        erase_rect.x,
+        erase_rect.y,
+        erase_rect.width,
+        erase_rect.height

     );
     );

+#endif

 
 

+    gtk_paint_handle
+    (
+        win->m_wxwindow->style,
+        GTK_PIZZA(win->m_wxwindow)->bin_window,
+        flags & wxCONTROL_CURRENT ? GTK_STATE_PRELIGHT : GTK_STATE_NORMAL,
+        GTK_SHADOW_NONE,
+        NULL /* no clipping */,
+        win->m_wxwindow,
+        "paned",
+        rect.x,
+        rect.y,
+        rect.width,
+        rect.height,
+        isVert ? GTK_ORIENTATION_VERTICAL : GTK_ORIENTATION_HORIZONTAL
+    );
+}

 
 

-    // leave some margin before sash itself
-    position += SASH_MARGIN / 2;
+void
+wxRendererGTK::DrawDropArrow(wxWindow *win,
+                             wxDC& dc,
+                             const wxRect& rect,
+                             int flags)
+{
+    GtkWidget *button = GetButtonWidget();
+
+    // If we give GTK_PIZZA(win->m_wxwindow)->bin_window as
+    // a window for gtk_paint_xxx function, then it won't
+    // work for wxMemoryDC. So that is why we assume wxDC
+    // is wxWindowDC (wxClientDC, wxMemoryDC and wxPaintDC
+    // are derived from it) and use its m_window.
+    wxWindowDC& wdc = (wxWindowDC&)dc;
+
+    // only doing debug-time checking here (it should
+    // probably be enough)
+    wxASSERT ( wdc.IsKindOf(CLASSINFO(wxWindowDC)) );
+
+    // draw arrow so that there is even space horizontally
+    // on both sides
+    int arrowX = rect.width/4 + 1;
+    int arrowWidth = rect.width - (arrowX*2);
+
+    // scale arrow's height accoording to the width
+    int arrowHeight = rect.width/3;
+    int arrowY = (rect.height-arrowHeight)/2 +
+                 ((rect.height-arrowHeight) & 1);
+
+    GtkStateType state;
+
+    if ( flags & wxCONTROL_PRESSED )
+        state = GTK_STATE_ACTIVE;
+    else if ( flags & wxCONTROL_DISABLED )
+        state = GTK_STATE_INSENSITIVE;
+    else if ( flags & wxCONTROL_CURRENT )
+        state = GTK_STATE_PRELIGHT;
+    else
+        state = GTK_STATE_NORMAL;
+
+    // draw arrow on button
+    gtk_paint_arrow
+    (
+        button->style,
+        wdc.m_window,
+        state,
+        flags & wxCONTROL_PRESSED ? GTK_SHADOW_IN : GTK_SHADOW_OUT,
+        NULL,
+        button,
+        "arrow",
+        GTK_ARROW_DOWN,
+        FALSE,
+        rect.x + arrowX,
+        rect.y + arrowY,
+        arrowWidth,
+        arrowHeight
+    );
+}

 
 

-    // and finally draw it using GTK paint functions
-    typedef void (*GtkPaintLineFunc)(GtkStyle *, GdkWindow *,
-                                                GtkStateType,
-                                                GdkRectangle *, GtkWidget *,
-                                                gchar *, gint, gint, gint);
+void
+wxRendererGTK::DrawComboBoxDropButton(wxWindow *win,
+                                      wxDC& dc,
+                                      const wxRect& rect,
+                                      int flags)
+{
+    DrawPushButton(win,dc,rect,flags);
+    DrawDropArrow(win,dc,rect);
+}

 
 

-    GtkPaintLineFunc func = isVert ? gtk_paint_vline : gtk_paint_hline;
+void
+wxRendererGTK::DrawCheckBox(wxWindow *win,
+                            wxDC& dc,
+                            const wxRect& rect,
+                            int flags )
+{
+    GtkWidget *button = GetCheckButtonWidget();
+
+    // for reason why we do this, see DrawDropArrow
+    wxWindowDC& wdc = (wxWindowDC&)dc;
+    wxASSERT ( wdc.IsKindOf(CLASSINFO(wxWindowDC)) );
+
+    GtkStateType state;
+
+    if ( flags & wxCONTROL_PRESSED )
+        state = GTK_STATE_ACTIVE;
+    else if ( flags & wxCONTROL_DISABLED )
+        state = GTK_STATE_INSENSITIVE;
+    else if ( flags & wxCONTROL_CURRENT )
+        state = GTK_STATE_PRELIGHT;
+    else
+        state = GTK_STATE_NORMAL;

 
 

-    (*func)
+    gtk_paint_check

     (
     (

-        win->m_wxwindow->style,
-        GTK_PIZZA(win->m_wxwindow)->bin_window,
-        GTK_STATE_NORMAL,
+        button->style,
+        wdc.m_window,
+        state,
+        flags & wxCONTROL_CHECKED ? GTK_SHADOW_IN : GTK_SHADOW_OUT,

         NULL,
         NULL,

-        win->m_wxwindow,
-        (char *)"paned", // const_cast
-        0, isVert ? size.y : size.x, position + SASH_SIZE / 2 - 1
+        button,
+        "cellcheck",
+        dc.LogicalToDeviceX(rect.x)+2,
+        dc.LogicalToDeviceY(rect.y)+3,
+        13, 13

     );
     );

+}
+
+void
+wxRendererGTK::DrawPushButton(wxWindow *win,
+                              wxDC& dc,
+                              const wxRect& rect,
+                              int flags)
+{
+    GtkWidget *button = GetButtonWidget();
+
+    // for reason why we do this, see DrawDropArrow
+    wxWindowDC& wdc = (wxWindowDC&)dc;
+    wxASSERT ( wdc.IsKindOf(CLASSINFO(wxWindowDC)) );
+
+    // draw button
+    GtkStateType state;
+
+    if ( flags & wxCONTROL_PRESSED )
+        state = GTK_STATE_ACTIVE;
+    else if ( flags & wxCONTROL_DISABLED )
+        state = GTK_STATE_INSENSITIVE;
+    else if ( flags & wxCONTROL_CURRENT )
+        state = GTK_STATE_PRELIGHT;
+    else
+        state = GTK_STATE_NORMAL;

 
     gtk_paint_box
     (
 
     gtk_paint_box
     (

-        win->m_wxwindow->style,
-        GTK_PIZZA(win->m_wxwindow)->bin_window,
-        GTK_STATE_NORMAL,
-        GTK_SHADOW_OUT,
-        (GdkRectangle*) NULL,
-        win->m_wxwindow,
-        (char *)"paned", // const_cast
-        isVert ? position : size.x - 2*SASH_SIZE,
-        isVert ? size.y - 2*SASH_SIZE : position,
-        SASH_SIZE, SASH_SIZE
+        button->style,
+        wdc.m_window,
+        state,
+        flags & wxCONTROL_PRESSED ? GTK_SHADOW_IN : GTK_SHADOW_OUT,
+        NULL,
+        button,
+        "button",
+        rect.x, rect.y, rect.width, rect.height

     );
 }
 
     );
 }
 

+void
+wxRendererGTK::DrawItemSelectionRect(wxWindow *win,
+                                     wxDC& dc,
+                                     const wxRect& rect,
+                                     int flags )
+{
+    GtkStateType state;
+    if (flags & wxCONTROL_SELECTED)
+    {
+        if (flags & wxCONTROL_FOCUSED)
+            state = GTK_STATE_SELECTED;
+        else
+            state = GTK_STATE_INSENSITIVE;
+
+        gtk_paint_flat_box( win->m_wxwindow->style,
+                        GTK_PIZZA(win->m_wxwindow)->bin_window,
+                        state,
+                        GTK_SHADOW_NONE,
+                        NULL,
+                        win->m_wxwindow,
+                        "treeview",
+                        dc.LogicalToDeviceX(rect.x),
+                        dc.LogicalToDeviceY(rect.y),
+                        rect.width,
+                        rect.height );
+    }
+
+    if (flags & wxCONTROL_CURRENT)
+    {
+        dc.SetPen( *wxBLACK_PEN );
+        dc.SetBrush( *wxTRANSPARENT_BRUSH );
+        dc.DrawRectangle( rect );
+    }
+}