src/gtk/scrolwin.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        gtk/scrolwin.cpp
   3 // Purpose:     wxScrolledWindow implementation
   4 // Author:      Robert Roebling
   5 // Modified by: Ron Lee
   6 //              Vadim Zeitlin: removed 90% of duplicated common code
   7 // Created:     01/02/97
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) Robert Roebling
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // ============================================================================
  14 // declarations
  15 // ============================================================================
  16
  17 // ----------------------------------------------------------------------------
  18 // headers
  19 // ----------------------------------------------------------------------------
  20
  21 // For compilers that support precompilation, includes "wx.h".
  22 #include "wx/wxprec.h"
  23
  24 #ifdef __BORLANDC__
  25     #pragma hdrstop
  26 #endif
  27
  28 #include "wx/scrolwin.h"
  29 #include "wx/gtk/private.h"
  30
  31 // ============================================================================
  32 // implementation
  33 // ============================================================================
  34
  35 // ----------------------------------------------------------------------------
  36 // wxScrollHelper implementation
  37 // ----------------------------------------------------------------------------
  38
  39 void wxScrollHelper::SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
  40                                    int noUnitsX, int noUnitsY,
  41                                    int xPos, int yPos,
  42                                    bool noRefresh)
  43 {
  44     int xs, ys;
  45     GetViewStart(& xs, & ys);
  46
  47     int old_x = m_xScrollPixelsPerLine * xs;
  48     int old_y = m_yScrollPixelsPerLine * ys;
  49
  50     m_xScrollPixelsPerLine = pixelsPerUnitX;
  51     m_yScrollPixelsPerLine = pixelsPerUnitY;
  52
  53     m_win->m_scrollBar[wxWindow::ScrollDir_Horz]->adjustment->value =
  54     m_xScrollPosition = xPos;
  55     m_win->m_scrollBar[wxWindow::ScrollDir_Vert]->adjustment->value =
  56     m_yScrollPosition = yPos;
  57
  58     // Setting hints here should arguably be deprecated, but without it
  59     // a sizer might override this manual scrollbar setting in old code.
  60     // m_targetWindow->SetVirtualSizeHints( noUnitsX * pixelsPerUnitX, noUnitsY * pixelsPerUnitY );
  61
  62     int w = noUnitsX * pixelsPerUnitX;
  63     int h = noUnitsY * pixelsPerUnitY;
  64     m_targetWindow->SetVirtualSize( w ? w : wxDefaultCoord,
  65                                     h ? h : wxDefaultCoord);
  66
  67     // If the target is not the same as the window with the scrollbars,
  68     // then we need to update the scrollbars here, since they won't have
  69     // been updated by SetVirtualSize().
  70     if (m_targetWindow != m_win)
  71     {
  72         AdjustScrollbars();
  73     }
  74
  75     if (!noRefresh)
  76     {
  77         int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
  78         int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
  79
  80         m_targetWindow->ScrollWindow( old_x - new_x, old_y - new_y );
  81     }
  82 }
  83
  84 void wxScrollHelper::DoAdjustScrollbar(GtkRange* range,
  85                                        int pixelsPerLine,
  86                                        int winSize,
  87                                        int virtSize,
  88                                        int *pos,
  89                                        int *lines,
  90                                        int *linesPerPage)
  91 {
  92     int upper;
  93     int page_size;
  94     if (pixelsPerLine > 0 && winSize > 0 && winSize < virtSize)
  95     {
  96         upper = (virtSize + pixelsPerLine - 1) / pixelsPerLine;
  97         page_size = winSize / pixelsPerLine;
  98         *lines = upper;
  99         *linesPerPage = page_size;
 100     }
 101     else
 102     {
 103         // GtkRange won't allow upper == lower, so for disabled state use [0,1]
 104         //   with a page size of 1. This will also clamp position to 0.
 105         upper = 1;
 106         page_size = 1;
 107         *lines = 0;
 108         *linesPerPage = 0;
 109     }
 110
 111     GtkAdjustment* adj = range->adjustment;
 112     adj->step_increment = 1;
 113     adj->page_increment =
 114     adj->page_size = page_size;
 115     gtk_range_set_range(range, 0, upper);
 116
 117     // ensure that the scroll position is always in valid range
 118     if (*pos > *lines)
 119         *pos = *lines;
 120 }
 121
 122 void wxScrollHelper::AdjustScrollbars()
 123 {
 124     int vw, vh;
 125     m_targetWindow->GetVirtualSize(&vw, &vh);
 126
 127     int w, h;
 128     const wxSize availSize = GetSizeAvailableForScrollTarget(
 129         m_win->GetSize() - m_win->GetWindowBorderSize());
 130     if ( availSize.x >= vw && availSize.y >= vh )
 131     {
 132         w = availSize.x;
 133         h = availSize.y;
 134
 135         // we know that the scrollbars will be removed
 136         DoAdjustHScrollbar(w, vw);
 137         DoAdjustVScrollbar(h, vh);
 138
 139         return;
 140     }
 141
 142     m_targetWindow->GetClientSize(&w, NULL);
 143     DoAdjustHScrollbar(w, vw);
 144
 145     m_targetWindow->GetClientSize(NULL, &h);
 146     DoAdjustVScrollbar(h, vh);
 147
 148     const int w_old = w;
 149     m_targetWindow->GetClientSize(&w, NULL);
 150     if ( w != w_old )
 151     {
 152         // It is necessary to repeat the calculations in this case to avoid an
 153         // observed infinite series of size events, involving alternating
 154         // changes in visibility of the scrollbars.
 155         // At this point, GTK+ has already queued a resize, which will cause
 156         // AdjustScrollbars() to be called again. If the scrollbar visibility
 157         // is not correct before then, yet another resize will occur, possibly
 158         // leading to an unending series if the sizes are just right.
 159         DoAdjustHScrollbar(w, vw);
 160
 161         m_targetWindow->GetClientSize(NULL, &h);
 162         DoAdjustVScrollbar(h, vh);
 163     }
 164 }
 165
 166 void wxScrollHelper::DoScrollOneDir(int orient,
 167                                     int pos,
 168                                     int pixelsPerLine,
 169                                     int *posOld)
 170 {
 171     if ( pos != -1 && pos != *posOld && pixelsPerLine )
 172     {
 173         m_win->SetScrollPos(orient, pos);
 174         pos = m_win->GetScrollPos(orient);
 175
 176         int diff = (*posOld - pos)*pixelsPerLine;
 177         m_targetWindow->ScrollWindow(orient == wxHORIZONTAL ? diff : 0,
 178                                      orient == wxHORIZONTAL ? 0 : diff);
 179
 180         *posOld = pos;
 181     }
 182 }
 183
 184 void wxScrollHelper::DoScroll( int x_pos, int y_pos )
 185 {
 186     wxCHECK_RET( m_targetWindow != 0, _T("No target window") );
 187
 188     DoScrollOneDir(wxHORIZONTAL, x_pos, m_xScrollPixelsPerLine, &m_xScrollPosition);
 189     DoScrollOneDir(wxVERTICAL, y_pos, m_yScrollPixelsPerLine, &m_yScrollPosition);
 190 }
 191
 192 // ----------------------------------------------------------------------------
 193 // scrollbars visibility
 194 // ----------------------------------------------------------------------------
 195
 196 namespace
 197 {
 198
 199 GtkPolicyType GtkPolicyFromWX(wxScrollbarVisibility visibility)
 200 {
 201     GtkPolicyType policy;
 202     switch ( visibility )
 203     {
 204         case wxSHOW_SB_NEVER:
 205             policy = GTK_POLICY_NEVER;
 206             break;
 207
 208         case wxSHOW_SB_DEFAULT:
 209             policy = GTK_POLICY_AUTOMATIC;
 210             break;
 211
 212         case wxSHOW_SB_ALWAYS:
 213             policy = GTK_POLICY_ALWAYS;
 214             break;
 215     }
 216
 217     return policy;
 218 }
 219
 220 } // anonymous namespace
 221
 222 void wxScrollHelper::DoShowScrollbars(wxScrollbarVisibility horz,
 223                                       wxScrollbarVisibility vert)
 224 {
 225     GtkScrolledWindow * const scrolled = GTK_SCROLLED_WINDOW(m_win->m_widget);
 226     wxCHECK_RET( scrolled, "window must be created" );
 227
 228     gtk_scrolled_window_set_policy(scrolled,
 229                                    GtkPolicyFromWX(horz),
 230                                    GtkPolicyFromWX(vert));
 231 }
 232