Fix wxTextFile::GetLine() documentation.

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

diff --git a/src/gtk1/renderer.cpp b/src/gtk1/renderer.cpp
index d9b057e69352e80f58fd1ebdf914e36d0f758890..3a089c690801af691c85388e5145cc7f1f08e953 100644 (file)
--- a/src/gtk1/renderer.cpp
+++ b/src/gtk1/renderer.cpp
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        gtk/renderer.cpp
+// Name:        src/gtk1/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
+// Licence:     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/dc.h"
+#endif

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

-#include "wx/gtk/win_gtk.h"
+#include "wx/gtk1/win_gtk.h"
+#include "wx/gtk1/dcclient.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


@@ -46,19 +48,41 @@ class WXDLLEXPORT wxRendererGTK : public wxDelegateRendererNative
 {
 public:
     // draw the header control button (used by wxListCtrl)
 {
 public:
     // draw the header control button (used by wxListCtrl)

-    virtual void DrawHeaderButton(wxWindow *win,
-                                  wxDC& dc,
-                                  const wxRect& rect,
-                                  int flags = 0);
+    virtual int DrawHeaderButton(wxWindow *win,
+                                 wxDC& dc,
+                                 const wxRect& rect,
+                                 int flags = 0,
+                                 wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
+                                 wxHeaderButtonParams* params=NULL);

 
 

-#ifdef __WXGTK20__
-    // draw the expanded/collapsed icon for a tree control item
-    virtual void DrawTreeItemButton(wxWindow *win,
+    virtual void DrawSplitterBorder(wxWindow *win,

                                     wxDC& dc,
                                     const wxRect& rect,
                                     int flags = 0);
                                     wxDC& dc,
                                     const wxRect& rect,
                                     int flags = 0);

-#endif // GTK 2.0
+    virtual void DrawSplitterSash(wxWindow *win,
+                                  wxDC& dc,
+                                  const wxSize& size,
+                                  wxCoord position,
+                                  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 wxSplitterRenderParams GetSplitterParams(const wxWindow *win);
+
+private:
+    // FIXME: shouldn't we destroy these windows somewhere?
+
+    // used by DrawHeaderButton and DrawComboBoxDropButton
+    static GtkWidget *GetButtonWidget();

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


@@ -66,71 +90,315 @@ public:
 // ============================================================================
 
 /* static */
 // ============================================================================
 
 /* static */

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

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

-void
+// ----------------------------------------------------------------------------
+// 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;
+}
+
+// ----------------------------------------------------------------------------
+// list/tree controls drawing
+// ----------------------------------------------------------------------------
+
+int

 wxRendererGTK::DrawHeaderButton(wxWindow *win,
                                 wxDC& dc,
                                 const wxRect& rect,
 wxRendererGTK::DrawHeaderButton(wxWindow *win,
                                 wxDC& dc,
                                 const wxRect& rect,

-                                int flags)
+                                int flags,
+                                wxHeaderSortIconType WXUNUSED(sortArrow),
+                                wxHeaderButtonParams* WXUNUSED(params))

 {
 {

+
+    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 DrawComboBoxDropButton 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) -1, rect.y -1, rect.width +2, rect.height +2

     );
     );

+
+    return rect.width + 2;
+}
+
+// ----------------------------------------------------------------------------
+// splitter sash drawing
+// ----------------------------------------------------------------------------
+
+// the full sash width (should be even)
+static const wxCoord SASH_SIZE = 8;
+
+// margin around the sash
+static const wxCoord SASH_MARGIN = 2;
+
+static int GetGtkSplitterFullSize()
+{
+    return SASH_SIZE + SASH_MARGIN;

 }
 
 }
 

-#ifdef __WXGTK20__
+wxSplitterRenderParams
+wxRendererGTK::GetSplitterParams(const wxWindow *WXUNUSED(win))
+{
+    // we don't draw any border, hence 0 for the second field
+    return wxSplitterRenderParams
+           (
+               GetGtkSplitterFullSize(),
+               0,
+               false    // not
+           );
+}

 
 

-// draw a ">" or "v" button
-//
-// TODO: isn't there a GTK function to draw it?

 void
 void

-wxRendererGTK::DrawTreeItemButton(wxWindow* WXUNUSED(win),
-                                  wxDC& dc, const wxRect& rect, int flags)
+wxRendererGTK::DrawSplitterBorder(wxWindow * WXUNUSED(win),
+                                  wxDC& WXUNUSED(dc),
+                                  const wxRect& WXUNUSED(rect),
+                                  int WXUNUSED(flags))

 {
 {

-    dc.SetBrush(wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT),
-                        wxSOLID));
-    dc.SetPen(*wxBLACK_PEN);
-    wxPoint button[3];
+    // nothing to do
+}

 
 

-    const wxCoord xMiddle = rect.x + rect.width/2;
-    const wxCoord yMiddle = rect.y + rect.height/2;
+void
+wxRendererGTK::DrawSplitterSash(wxWindow *win,
+                                wxDC& WXUNUSED(dc),
+                                const wxSize& size,
+                                wxCoord position,
+                                wxOrientation orient,
+                                int WXUNUSED(flags))
+{
+    if ( !win->m_wxwindow->window )
+    {
+        // window not realized yet
+        return;
+    }

 
 

-    if ( flags & wxCONTROL_EXPANDED )
+    wxCoord full_size = GetGtkSplitterFullSize();
+
+    // are we drawing vertical or horizontal splitter?
+    const bool isVert = orient == wxVERTICAL;
+
+    GdkRectangle rect;
+#if USE_ERASE_RECT
+    GdkRectangle erase_rect;
+#endif
+
+    if ( isVert )

     {
     {

-        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;
+        int h = win->GetClientSize().GetHeight();
+
+        rect.x = position;
+        rect.y = 0;
+        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 // collapsed
+    else // horz

     {
     {

-        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;
+        int w = win->GetClientSize().GetWidth();
+
+        rect.x = 0;
+        rect.y = position;
+        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

     }
 
     }
 

-    dc.DrawPolygon(3, button);
+#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,
+        NULL,
+        win->m_wxwindow,
+        (char *)"viewportbin", // const_cast
+        erase_rect.x,
+        erase_rect.y,
+        erase_rect.width,
+        erase_rect.height
+    );
+#endif
+
+
+    // leave some margin before sash itself
+    position += SASH_MARGIN / 2;
+
+    // and finally draw it using GTK paint functions
+    typedef void (*GtkPaintLineFunc)(GtkStyle *, GdkWindow *,
+                                                GtkStateType,
+                                                GdkRectangle *, GtkWidget *,
+                                                gchar *,
+                                                gint, gint, gint);
+
+    GtkPaintLineFunc func = isVert ? gtk_paint_vline : gtk_paint_hline;
+
+    (*func)
+    (
+        win->m_wxwindow->style,
+        GTK_PIZZA(win->m_wxwindow)->bin_window,
+        GTK_STATE_NORMAL,
+        NULL,
+        win->m_wxwindow,
+        (char *)"paned", // const_cast
+        0, isVert ? size.y : size.x, position + SASH_SIZE / 2 - 1
+    );
+
+    gtk_paint_box
+    (
+        win->m_wxwindow->style,
+        GTK_PIZZA(win->m_wxwindow)->bin_window,
+        GTK_STATE_NORMAL,
+        GTK_SHADOW_OUT,
+        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
+    );
+}
+
+void
+wxRendererGTK::DrawDropArrow(wxWindow *WXUNUSED(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.
+    wxWindowDCImpl * const impl = wxDynamicCast(dc.GetImpl(), wxWindowDCImpl);
+    wxCHECK_RET( impl, "must have a window DC" );
+
+    GdkWindow* gdk_window = impl->GetGDKWindow();
+
+    // 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,
+        gdk_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
+    );

 }
 
 }
 

-#endif // GTK 2.0
+void
+wxRendererGTK::DrawComboBoxDropButton(wxWindow *win,
+                                      wxDC& dc,
+                                      const wxRect& rect,
+                                      int flags)
+{
+    GtkWidget *button = GetButtonWidget();
+
+    // for reason why we do this, see DrawDropArrow
+    wxWindowDCImpl * const impl = wxDynamicCast(dc.GetImpl(), wxWindowDCImpl);
+    wxCHECK_RET( impl, "must have a window DC" );
+
+    GdkWindow* gdk_window = impl->GetGDKWindow();
+
+    // 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
+    (
+        button->style,
+        gdk_window,
+        state,
+        flags & wxCONTROL_PRESSED ? GTK_SHADOW_IN : GTK_SHADOW_OUT,
+        NULL,
+        button,
+        "button",
+        rect.x, rect.y, rect.width, rect.height
+    );
+
+    // draw arrow on button
+    DrawDropArrow(win,dc,rect,flags);
+
+}