Fix stc doxygen warnings and regen stc files.

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

diff --git a/src/gtk/scrolwin.cpp b/src/gtk/scrolwin.cpp
index 86728b90ab33018bc6dd3a0808fcd0a5450b6cb8..9b39077a3dbcaa465dc06c2c63609c6803509be1 100644 (file)
--- a/src/gtk/scrolwin.cpp
+++ b/src/gtk/scrolwin.cpp
@@ -1,23 +1,14 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxScrolledWindow implementation
 // Author:      Robert Roebling
 // Modified by: Ron Lee
 //              Vadim Zeitlin: removed 90% of duplicated common code
 // Created:     01/02/97
 // Purpose:     wxScrolledWindow implementation
 // Author:      Robert Roebling
 // Modified by: Ron Lee
 //              Vadim Zeitlin: removed 90% of duplicated common code
 // Created:     01/02/97

-// RCS-ID:      $Id$

 // Copyright:   (c) Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Copyright:   (c) Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -26,105 +17,111 @@
 #endif
 
 #include "wx/scrolwin.h"
 #endif
 
 #include "wx/scrolwin.h"

-#include "wx/gtk/private.h"

 
 

-// ============================================================================
-// implementation
-// ============================================================================
+#include <gtk/gtk.h>
+#include "wx/gtk/private/gtk2-compat.h"

 
 // ----------------------------------------------------------------------------
 // wxScrollHelper implementation
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxScrollHelper implementation
 // ----------------------------------------------------------------------------
 

-void wxScrollHelperNative::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
-                                         int noUnitsX, int noUnitsY,
-                                         int xPos, int yPos,
-                                         bool noRefresh)
+void wxScrollHelper::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
+                                   int noUnitsX, int noUnitsY,
+                                   int xPos, int yPos,
+                                   bool noRefresh)

 {
 {

-    int xs, ys;
-    GetViewStart(& xs, & ys);
-
-    int old_x = m_xScrollPixelsPerLine * xs;
-    int old_y = m_yScrollPixelsPerLine * ys;
-
-    m_xScrollPixelsPerLine = pixelsPerUnitX;
-    m_yScrollPixelsPerLine = pixelsPerUnitY;
-
-    m_win->m_scrollBar[0]->adjustment->value =
-    m_xScrollPosition = xPos;
-    m_win->m_scrollBar[1]->adjustment->value =
-    m_yScrollPosition = yPos;
-
-    // Setting hints here should arguably be deprecated, but without it
-    // a sizer might override this manual scrollbar setting in old code.
-    // m_targetWindow->SetVirtualSizeHints( noUnitsX * pixelsPerUnitX, noUnitsY * pixelsPerUnitY );
-
-    int w = noUnitsX * pixelsPerUnitX;
-    int h = noUnitsY * pixelsPerUnitY;
-    m_targetWindow->SetVirtualSize( w ? w : wxDefaultCoord,
-                                    h ? h : wxDefaultCoord);
-
-    // If the target is not the same as the window with the scrollbars,
-    // then we need to update the scrollbars here, since they won't have
-    // been updated by SetVirtualSize().
-    if (m_targetWindow != m_win)
-    {
-        AdjustScrollbars();
-    }
-
-    if (!noRefresh)
-    {
-        int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
-        int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
+    // prevent programmatic position changes from causing scroll events
+    m_win->SetScrollPos(wxHORIZONTAL, xPos);
+    m_win->SetScrollPos(wxVERTICAL, yPos);

 
 

-        m_targetWindow->ScrollWindow( old_x - new_x, old_y - new_y );
-    }
+    base_type::SetScrollbars(
+        pixelsPerUnitX, pixelsPerUnitY, noUnitsX, noUnitsY, xPos, yPos, noRefresh);

 }
 
 }
 

-void wxScrollHelperNative::DoAdjustScrollbar(GtkRange* range,
-                                             int pixelsPerLine,
-                                             int winSize,
-                                             int virtSize,
-                                             int *lines,
-                                             int *linesPerPage)
+void wxScrollHelper::DoAdjustScrollbar(GtkRange* range,
+                                       int pixelsPerLine,
+                                       int winSize,
+                                       int virtSize,
+                                       int *pos,
+                                       int *lines,
+                                       int *linesPerPage)

 {
 {

-    // GtkRange won't allow upper == lower, so for disabled state use [0,1]
-    //   with a page size of 1. This will also clamp position to 0.
-    int upper = 1;
-    int page_size = 1;
+    if (!range)
+        return;
+
+    int upper;
+    int page_size;

     if (pixelsPerLine > 0 && winSize > 0 && winSize < virtSize)
     {
         upper = (virtSize + pixelsPerLine - 1) / pixelsPerLine;
         page_size = winSize / pixelsPerLine;
     if (pixelsPerLine > 0 && winSize > 0 && winSize < virtSize)
     {
         upper = (virtSize + pixelsPerLine - 1) / pixelsPerLine;
         page_size = winSize / pixelsPerLine;

+        *lines = upper;
+        *linesPerPage = page_size;
+    }
+    else
+    {
+        // GtkRange won't allow upper == lower, so for disabled state use [0,1]
+        //   with a page size of 1. This will also clamp position to 0.
+        upper = 1;
+        page_size = 1;
+        *lines = 0;
+        *linesPerPage = 0;

     }
 
     }
 

-    *lines = upper;
-    *linesPerPage = page_size;
-
-    GtkAdjustment* adj = range->adjustment;
-    adj->step_increment = 1;
-    adj->page_increment =
-    adj->page_size = page_size;
+    gtk_range_set_increments(range, 1, page_size);
+    gtk_adjustment_set_page_size(gtk_range_get_adjustment(range), page_size);

     gtk_range_set_range(range, 0, upper);
     gtk_range_set_range(range, 0, upper);

+
+    // ensure that the scroll position is always in valid range
+    if (*pos > *lines)
+        *pos = *lines;

 }
 
 }
 

-void wxScrollHelperNative::AdjustScrollbars()
+void wxScrollHelper::AdjustScrollbars()

 {
 {

-    int w, h;

     int vw, vh;
     int vw, vh;

+    m_targetWindow->GetVirtualSize(&vw, &vh);

 
 

-    m_targetWindow->m_hasScrolling = m_xScrollPixelsPerLine != 0 || m_yScrollPixelsPerLine != 0;
+    int w, h;
+    const wxSize availSize = GetSizeAvailableForScrollTarget(
+        m_win->GetSize() - m_win->GetWindowBorderSize());
+    if ( availSize.x >= vw && availSize.y >= vh )
+    {
+        w = availSize.x;
+        h = availSize.y;

 
 

-    m_targetWindow->GetClientSize( &w, &h );
-    m_targetWindow->GetVirtualSize( &vw, &vh );
+        // we know that the scrollbars will be removed
+        DoAdjustHScrollbar(w, vw);
+        DoAdjustVScrollbar(h, vh);
+
+        return;
+    }

 
 

-    DoAdjustScrollbar(m_win->m_scrollBar[0], m_xScrollPixelsPerLine, w, vw,
-                      &m_xScrollLines, &m_xScrollLinesPerPage);
-    DoAdjustScrollbar(m_win->m_scrollBar[1], m_yScrollPixelsPerLine, h, vh,
-                      &m_yScrollLines, &m_yScrollLinesPerPage);
+    m_targetWindow->GetClientSize(&w, NULL);
+    DoAdjustHScrollbar(w, vw);
+
+    m_targetWindow->GetClientSize(NULL, &h);
+    DoAdjustVScrollbar(h, vh);
+
+    const int w_old = w;
+    m_targetWindow->GetClientSize(&w, NULL);
+    if ( w != w_old )
+    {
+        // It is necessary to repeat the calculations in this case to avoid an
+        // observed infinite series of size events, involving alternating
+        // changes in visibility of the scrollbars.
+        // At this point, GTK+ has already queued a resize, which will cause
+        // AdjustScrollbars() to be called again. If the scrollbar visibility
+        // is not correct before then, yet another resize will occur, possibly
+        // leading to an unending series if the sizes are just right.
+        DoAdjustHScrollbar(w, vw);
+
+        m_targetWindow->GetClientSize(NULL, &h);
+        DoAdjustVScrollbar(h, vh);
+    }

 }
 
 }
 

-void wxScrollHelperNative::DoScroll(int orient,
+void wxScrollHelper::DoScrollOneDir(int orient,

                                     int pos,
                                     int pixelsPerLine,
                                     int *posOld)
                                     int pos,
                                     int pixelsPerLine,
                                     int *posOld)


@@ -142,10 +139,72 @@ void wxScrollHelperNative::DoScroll(int orient,
     }
 }
 
     }
 }
 

-void wxScrollHelperNative::Scroll( int x_pos, int y_pos )
+void wxScrollHelper::DoScroll( int x_pos, int y_pos )
+{
+    wxCHECK_RET( m_targetWindow != 0, wxT("No target window") );
+
+    DoScrollOneDir(wxHORIZONTAL, x_pos, m_xScrollPixelsPerLine, &m_xScrollPosition);
+    DoScrollOneDir(wxVERTICAL, y_pos, m_yScrollPixelsPerLine, &m_yScrollPosition);
+}
+
+// ----------------------------------------------------------------------------
+// scrollbars visibility
+// ----------------------------------------------------------------------------
+
+namespace
+{
+
+GtkPolicyType GtkPolicyFromWX(wxScrollbarVisibility visibility)
+{
+    GtkPolicyType policy;
+    switch ( visibility )
+    {
+        case wxSHOW_SB_NEVER:
+            policy = GTK_POLICY_NEVER;
+            break;
+
+        case wxSHOW_SB_DEFAULT:
+            policy = GTK_POLICY_AUTOMATIC;
+            break;
+
+        default:
+            wxFAIL_MSG( wxS("unknown scrollbar visibility") );
+            // fall through
+
+        case wxSHOW_SB_ALWAYS:
+            policy = GTK_POLICY_ALWAYS;
+            break;
+    }
+
+    return policy;
+}
+
+} // anonymous namespace
+
+bool wxScrollHelper::IsScrollbarShown(int orient) const
+{
+    GtkScrolledWindow * const scrolled = GTK_SCROLLED_WINDOW(m_win->m_widget);
+    if ( !scrolled )
+    {
+        // By default, all windows are scrollable.
+        return true;
+    }
+
+    GtkPolicyType hpolicy, vpolicy;
+    gtk_scrolled_window_get_policy(scrolled, &hpolicy, &vpolicy);
+
+    GtkPolicyType policy = orient == wxHORIZONTAL ? hpolicy : vpolicy;
+
+    return policy != GTK_POLICY_NEVER;
+}
+
+void wxScrollHelper::DoShowScrollbars(wxScrollbarVisibility horz,
+                                      wxScrollbarVisibility vert)

 {
 {

-    wxCHECK_RET( m_targetWindow != 0, _T("No target window") );
+    GtkScrolledWindow * const scrolled = GTK_SCROLLED_WINDOW(m_win->m_widget);
+    wxCHECK_RET( scrolled, "window must be created" );

 
 

-    DoScroll(wxHORIZONTAL, x_pos, m_xScrollPixelsPerLine, &m_xScrollPosition);
-    DoScroll(wxVERTICAL, y_pos, m_yScrollPixelsPerLine, &m_yScrollPosition);
+    gtk_scrolled_window_set_policy(scrolled,
+                                   GtkPolicyFromWX(horz),
+                                   GtkPolicyFromWX(vert));

 }
 }