]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk1/scrolwin.cpp
Doc tweaks
[wxWidgets.git] / src / gtk1 / scrolwin.cpp
index 579d2b7b6df3b52bc12e7a621bf2388a9ceb7ff2..5a31109d610f8b6c35de42d2aa24668bc3e58dca 100644 (file)
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        gtk/scrolwin.cpp
 // Purpose:     wxScrolledWindow implementation
-// Author:      Julian Smart
-// Modified by:
+// Author:      Robert Roebling
+// Modified by: Ron Lee
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Robert Roebling
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma implementation "scrolwin.h"
 #endif
 
     #pragma hdrstop
 #endif
 
+#include "wx/scrolwin.h"
 #include "wx/utils.h"
 #include "wx/dcclient.h"
-
-#include "wx/scrolwin.h"
 #include "wx/panel.h"
 #include "wx/sizer.h"
 
@@ -83,7 +82,7 @@ static void gtk_scrolled_window_vscroll_callback( GtkAdjustment *adjust,
     if (g_blockEventsOnDrag) return;
 
     if (!win->m_hasVMT) return;
-
+    
     win->GtkVScroll( adjust->value,
             GET_SCROLL_TYPE(GTK_SCROLLED_WINDOW(win->m_widget)->vscrollbar) );
 }
@@ -202,8 +201,6 @@ void wxScrolledWindow::Init()
     m_yScrollingEnabled = TRUE;
     m_xScrollPosition = 0;
     m_yScrollPosition = 0;
-    m_xScrollLines = 0;
-    m_yScrollLines = 0;
     m_xScrollLinesPerPage = 0;
     m_yScrollLinesPerPage = 0;
     m_targetWindow = (wxWindow*) NULL;
@@ -276,13 +273,13 @@ bool wxScrolledWindow::Create(wxWindow *parent,
     m_vAdjust->upper = 1.0;
     m_vAdjust->value = 0.0;
     m_vAdjust->step_increment = 1.0;
-    m_vAdjust->page_increment = 1.0;
+    m_vAdjust->page_increment = 2.0;
     gtk_signal_emit_by_name( GTK_OBJECT(m_vAdjust), "changed" );
     m_hAdjust->lower = 0.0;
     m_hAdjust->upper = 1.0;
     m_hAdjust->value = 0.0;
     m_hAdjust->step_increment = 1.0;
-    m_hAdjust->page_increment = 1.0;
+    m_hAdjust->page_increment = 2.0;
     gtk_signal_emit_by_name( GTK_OBJECT(m_hAdjust), "changed" );
 
     // Handlers for new scrollbar values
@@ -290,7 +287,7 @@ bool wxScrolledWindow::Create(wxWindow *parent,
     GtkHConnectEvent();
 
     // these handlers block mouse events to any window during scrolling such as
-    // motion events and prevent GTK and wxWindows from fighting over where the
+    // motion events and prevent GTK and wxWidgets from fighting over where the
     // slider should be
 
     gtk_signal_connect( GTK_OBJECT(scrolledWindow->vscrollbar), "button_press_event",
@@ -315,7 +312,7 @@ bool wxScrolledWindow::Create(wxWindow *parent,
     PostCreation();
 
     Show( TRUE );
-
+    
     return TRUE;
 }
 
@@ -323,69 +320,185 @@ bool wxScrolledWindow::Create(wxWindow *parent,
 // setting scrolling parameters
 // ----------------------------------------------------------------------------
 
+void wxScrolledWindow::DoSetVirtualSize( int x, int y )
+{
+    wxPanel::DoSetVirtualSize( x, y );
+    AdjustScrollbars();
+
+    if (GetAutoLayout())
+        Layout();
+}
+
+// wxWindow's GetBestVirtualSize returns the actual window size,
+// whereas we want to return the virtual size
+wxSize wxScrolledWindow::GetBestVirtualSize() const
+{
+    wxSize  clientSize( GetClientSize() );
+    if (GetSizer())
+    {
+        wxSize minSize( GetSizer()->CalcMin() );
+
+        return wxSize( wxMax( clientSize.x, minSize.x ), wxMax( clientSize.y, minSize.y ) );
+    }
+    else
+        return clientSize;
+}
+
+// return the size best suited for the current window
+// (this isn't a virtual size, this is a sensible size for the window)
+wxSize wxScrolledWindow::DoGetBestSize() const
+{
+    wxSize best;
+
+    if ( GetSizer() )
+    {
+        wxSize b = GetSizer()->GetMinSize();
+
+        // Only use the content to set the window size in the direction
+        // where there's no scrolling; otherwise we're going to get a huge
+        // window in the direction in which scrolling is enabled
+        int ppuX, ppuY;
+        GetScrollPixelsPerUnit(& ppuX, & ppuY);
+
+        wxSize minSize;
+        if ( GetMinSize().IsFullySpecified() )
+            minSize = GetMinSize();
+        else
+            minSize = GetSize();
+
+        if (ppuX > 0)
+            b.x = minSize.x;
+        if (ppuY > 0)
+            b.y = minSize.y;
+        best = b;
+    }
+    else
+        return wxWindow::DoGetBestSize();
+
+    // Add any difference between size and client size
+    wxSize diff = GetSize() - GetClientSize();
+    best.x += wxMax(0, diff.x);
+    best.y += wxMax(0, diff.y);
+
+    return best;
+}
+
 /*
  * pixelsPerUnitX/pixelsPerUnitY: number of pixels per unit (e.g. pixels per text line)
  * noUnitsX/noUnitsY:        : no. units per scrollbar
  */
-void wxScrolledWindow::SetScrollbars (int pixelsPerUnitX, int pixelsPerUnitY,
-               int noUnitsX, int noUnitsY,
-               int xPos, int yPos, bool noRefresh )
+void wxScrolledWindow::SetScrollbarsint pixelsPerUnitX, int pixelsPerUnitY,
+                                      int noUnitsX, int noUnitsY,
+                                      int xPos, int yPos, bool noRefresh )
 {
-    int old_x = m_xScrollPixelsPerLine * m_xScrollPosition;
-    int old_y = m_yScrollPixelsPerLine * m_yScrollPosition;
+    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_xScrollLines = noUnitsX;
-    m_yScrollLines = noUnitsY;
-    m_xScrollPosition = xPos;
-    m_yScrollPosition = yPos;
 
-    m_hAdjust->lower = 0.0;
-    m_hAdjust->upper = noUnitsX;
-    m_hAdjust->value = xPos;
-    m_hAdjust->step_increment = 1.0;
-    m_hAdjust->page_increment = 2.0;
+    m_hAdjust->value = m_xScrollPosition = xPos;
+    m_vAdjust->value = m_yScrollPosition = yPos;
 
-    m_vAdjust->lower = 0.0;
-    m_vAdjust->upper = noUnitsY;
-    m_vAdjust->value = yPos;
-    m_vAdjust->step_increment = 1.0;
-    m_vAdjust->page_increment = 2.0;
+    // 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 );
 
-    AdjustScrollbars();
+    int w = noUnitsX * pixelsPerUnitX;
+    int h = noUnitsY * pixelsPerUnitY;
+    m_targetWindow->SetVirtualSize( w ? w : wxDefaultCoord,
+                                    h ? h : wxDefaultCoord);
 
     if (!noRefresh)
     {
         int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
         int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
 
-        m_targetWindow->ScrollWindow( old_x-new_x, old_y-new_y );
+        m_targetWindow->ScrollWindow( old_x - new_x, old_y - new_y );
     }
 }
 
 void wxScrolledWindow::AdjustScrollbars()
 {
     int w, h;
-    m_targetWindow->GetClientSize( &w, &h );
+    int vw, vh;
 
+    m_targetWindow->GetClientSize( &w, &h );
+    m_targetWindow->GetVirtualSize( &vw, &vh );
+    
     if (m_xScrollPixelsPerLine == 0)
+    {
+        m_hAdjust->upper = 1.0;
+        m_hAdjust->page_increment = 1.0;
         m_hAdjust->page_size = 1.0;
+    }
     else
-        m_hAdjust->page_size = (w / m_xScrollPixelsPerLine);
+    {
+        m_hAdjust->upper = (vw+m_xScrollPixelsPerLine-1) / m_xScrollPixelsPerLine;
+        m_hAdjust->page_size = w / m_xScrollPixelsPerLine;
+        m_hAdjust->page_increment = w / m_xScrollPixelsPerLine;
+
+        // Special case. When client and virtual size are very close but
+        // the client is big enough, kill scrollbar.
+        
+        if ((m_hAdjust->page_size < m_hAdjust->upper) && (w >= vw)) 
+            m_hAdjust->page_size += 1.0;
+        
+        // If the scrollbar hits the right side, move the window
+        // right to keep it from over extending.
+
+        if ((m_hAdjust->value != 0.0) && (m_hAdjust->value + m_hAdjust->page_size > m_hAdjust->upper))
+        {
+            m_hAdjust->value = m_hAdjust->upper - m_hAdjust->page_size;
+            if (m_hAdjust->value < 0.0)
+                m_hAdjust->value = 0.0;
+                
+            if (GetChildren().GetCount() == 0)
+                m_xScrollPosition = (int)m_hAdjust->value; // This is enough without child windows
+            else
+                gtk_signal_emit_by_name( GTK_OBJECT(m_hAdjust), "value_changed" ); // Actually scroll window
+        }
+    }
 
     if (m_yScrollPixelsPerLine == 0)
+    {
+        m_vAdjust->upper = 1.0;
+        m_vAdjust->page_increment = 1.0;
         m_vAdjust->page_size = 1.0;
+    }
     else
-        m_vAdjust->page_size = (h / m_yScrollPixelsPerLine);
+    {
+        m_vAdjust->upper = (vh+m_yScrollPixelsPerLine-1) / m_yScrollPixelsPerLine;
+        m_vAdjust->page_size = h / m_yScrollPixelsPerLine;
+        m_vAdjust->page_increment = h / m_yScrollPixelsPerLine;
+        
+        if ((m_vAdjust->page_size < m_vAdjust->upper) && (h >= vh)) 
+            m_vAdjust->page_size += 1.0;
+
+        if ((m_vAdjust->value != 0.0) && (m_vAdjust->value + m_vAdjust->page_size > m_vAdjust->upper))
+        {
+            m_vAdjust->value = m_vAdjust->upper - m_vAdjust->page_size;
+            if (m_vAdjust->value < 0.0)
+                m_vAdjust->value = 0.0;
+                
+            if (GetChildren().GetCount() == 0)
+                m_yScrollPosition = (int)m_vAdjust->value;  
+            else
+                gtk_signal_emit_by_name( GTK_OBJECT(m_vAdjust), "value_changed" );
+        }
+    }
 
-    m_xScrollLinesPerPage = (int)(m_hAdjust->page_size + 0.5);
-    m_yScrollLinesPerPage = (int)(m_vAdjust->page_size + 0.5);
+    m_xScrollLinesPerPage = (int)(m_hAdjust->page_increment + 0.5);
+    m_yScrollLinesPerPage = (int)(m_vAdjust->page_increment + 0.5);
 
     gtk_signal_emit_by_name( GTK_OBJECT(m_vAdjust), "changed" );
     gtk_signal_emit_by_name( GTK_OBJECT(m_hAdjust), "changed" );
 }
 
+
 // ----------------------------------------------------------------------------
 // target window handling
 // ----------------------------------------------------------------------------
@@ -396,19 +509,35 @@ void wxScrolledWindow::SetTargetWindow( wxWindow *target, bool WXUNUSED(pushEven
     m_targetWindow = target;
 }
 
-wxWindow *wxScrolledWindow::GetTargetWindow()
+wxWindow *wxScrolledWindow::GetTargetWindow() const
 {
     return m_targetWindow;
 }
 
 // Override this function if you don't want to have wxScrolledWindow
 // automatically change the origin according to the scroll position.
-void wxScrolledWindow::PrepareDC(wxDC& dc)
+void wxScrolledWindow::DoPrepareDC(wxDC& dc)
 {
     dc.SetDeviceOrigin( -m_xScrollPosition * m_xScrollPixelsPerLine,
                         -m_yScrollPosition * m_yScrollPixelsPerLine );
 }
 
+void wxScrolledWindow::SetScrollRate( int xstep, int ystep )
+{
+    int old_x = m_xScrollPixelsPerLine * m_xScrollPosition;
+    int old_y = m_yScrollPixelsPerLine * m_yScrollPosition;
+
+    m_xScrollPixelsPerLine = xstep;
+    m_yScrollPixelsPerLine = ystep;
+
+    int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
+    int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
+
+    m_targetWindow->ScrollWindow( old_x - new_x, old_y - new_y );
+
+    AdjustScrollbars();
+}
+
 void wxScrolledWindow::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
 {
     if ( x_unit )
@@ -478,8 +607,7 @@ void wxScrolledWindow::OnScroll(wxScrollWinEvent& event)
 
 void wxScrolledWindow::Scroll( int x_pos, int y_pos )
 {
-    if (!m_targetWindow)
-        return;
+    wxASSERT_MSG( m_targetWindow != 0, _T("No target window") );
 
     if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
         ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
@@ -497,7 +625,7 @@ void wxScrolledWindow::Scroll( int x_pos, int y_pos )
 
         m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0 );
 
-        // Just update the scrollbar, don't send any wxWindows event
+        // Just update the scrollbar, don't send any wxWidgets event
         GtkHDisconnectEvent();
         gtk_signal_emit_by_name( GTK_OBJECT(m_hAdjust), "value_changed" );
         GtkHConnectEvent();
@@ -516,7 +644,7 @@ void wxScrolledWindow::Scroll( int x_pos, int y_pos )
 
         m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine );
 
-        // Just update the scrollbar, don't send any wxWindows event
+        // Just update the scrollbar, don't send any wxWidgets event
         GtkVDisconnectEvent();
         gtk_signal_emit_by_name( GTK_OBJECT(m_vAdjust), "value_changed" );
         GtkVConnectEvent();
@@ -527,8 +655,7 @@ void wxScrolledWindow::Scroll( int x_pos, int y_pos )
 
 void wxScrolledWindow::GtkVScroll( float value, unsigned int scroll_type )
 {
-    if (!m_targetWindow)
-        return;
+    wxASSERT_MSG( m_targetWindow != 0, _T("No target window") );
 
     if (m_yScrollPixelsPerLine == 0)
         return;
@@ -547,8 +674,7 @@ void wxScrolledWindow::GtkVScroll( float value, unsigned int scroll_type )
 
 void wxScrolledWindow::GtkHScroll( float value, unsigned int scroll_type )
 {
-    if (!m_targetWindow)
-        return;
+    wxASSERT_MSG( m_targetWindow != 0, _T("No target window") );
 
     if (m_xScrollPixelsPerLine == 0)
         return;
@@ -571,14 +697,6 @@ void wxScrolledWindow::EnableScrolling (bool x_scroll, bool y_scroll)
     m_yScrollingEnabled = y_scroll;
 }
 
-void wxScrolledWindow::GetVirtualSize (int *x, int *y) const
-{
-    if ( x )
-        *x = m_xScrollPixelsPerLine * m_xScrollLines;
-    if ( y )
-        *y = m_yScrollPixelsPerLine * m_yScrollLines;
-}
-
 // Where the current view starts from
 void wxScrolledWindow::GetViewStart (int *x, int *y) const
 {
@@ -588,20 +706,26 @@ void wxScrolledWindow::GetViewStart (int *x, int *y) const
         *y = m_yScrollPosition;
 }
 
-void wxScrolledWindow::CalcScrolledPosition(int x, int y, int *xx, int *yy) const
+void wxScrolledWindow::DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const
 {
+    int xs, ys;
+    GetViewStart (& xs, & ys);
+    
     if ( xx )
-        *xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
+        *xx = x - xs * m_xScrollPixelsPerLine;
     if ( yy )
-        *yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
+        *yy = y - ys * m_yScrollPixelsPerLine;
 }
 
-void wxScrolledWindow::CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
+void wxScrolledWindow::DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
 {
+    int xs, ys;
+    GetViewStart (& xs, & ys);
+    
     if ( xx )
-        *xx = x + m_xScrollPosition * m_xScrollPixelsPerLine;
+        *xx = x + xs * m_xScrollPixelsPerLine;
     if ( yy )
-        *yy = y + m_yScrollPosition * m_yScrollPixelsPerLine;
+        *yy = y + ys * m_yScrollPixelsPerLine;
 }
 
 int wxScrolledWindow::CalcScrollInc(wxScrollWinEvent& event)
@@ -620,9 +744,9 @@ int wxScrolledWindow::CalcScrollInc(wxScrollWinEvent& event)
     if (event.GetEventType() == wxEVT_SCROLLWIN_BOTTOM)
     {
             if (orient == wxHORIZONTAL)
-                nScrollInc = m_xScrollLines - m_xScrollPosition;
+                nScrollInc = GetVirtualSize().GetWidth() / m_xScrollPixelsPerLine - m_xScrollPosition;
             else
-                nScrollInc = m_yScrollLines - m_yScrollPosition;
+                nScrollInc = GetVirtualSize().GetHeight() / m_yScrollPixelsPerLine - m_yScrollPosition;
     } else
     if (event.GetEventType() == wxEVT_SCROLLWIN_LINEUP)
     {
@@ -722,14 +846,14 @@ void wxScrolledWindow::SetScrollPos( int orient, int pos, bool refresh )
     {
         if (orient == wxHORIZONTAL)
         {
-            // Just update the scrollbar, don't send any wxWindows event
+            // Just update the scrollbar, don't send any wxWidgets event
             GtkHDisconnectEvent();
             gtk_signal_emit_by_name( GTK_OBJECT(m_hAdjust), "value_changed" );
             GtkHConnectEvent();
         }
         else
         {
-            // Just update the scrollbar, don't send any wxWindows event
+            // Just update the scrollbar, don't send any wxWidgets event
             GtkVDisconnectEvent();
             gtk_signal_emit_by_name( GTK_OBJECT(m_vAdjust), "value_changed" );
             GtkVConnectEvent();
@@ -761,12 +885,13 @@ void wxScrolledWindow::GtkVDisconnectEvent()
         (GtkSignalFunc) gtk_scrolled_window_vscroll_callback, (gpointer) this );
 }
 
-
 bool wxScrolledWindow::Layout()
 {
-    if (GetSizer())
+    if (GetSizer() && m_targetWindow == this)
     {
-        // Take into account the virtual size and scrolled position of the window
+        // If we're the scroll target, take into account the
+        // virtual size and scrolled position of the window.
+
         int x, y, w, h;
         CalcScrolledPosition(0,0, &x,&y);
         GetVirtualSize(&w, &h);
@@ -784,12 +909,17 @@ bool wxScrolledWindow::Layout()
 // Default OnSize resets scrollbars, if any
 void wxScrolledWindow::OnSize(wxSizeEvent& WXUNUSED(event))
 {
-#if wxUSE_CONSTRAINTS
-    if (GetAutoLayout())
-        Layout();
-#endif
-
-    AdjustScrollbars();
+    if ( m_targetWindow->GetAutoLayout() )
+    {
+        wxSize size = m_targetWindow->GetBestVirtualSize();
+        
+        // This will call ::Layout() and ::AdjustScrollbars()
+        SetVirtualSize( size );
+    }
+    else
+    {
+        AdjustScrollbars();
+    }
 }
 
 // This calls OnDraw, having adjusted the origin according to the current
@@ -812,7 +942,7 @@ void wxScrolledWindow::OnChar(wxKeyEvent& event)
         szx, szy,       // view size (total)
         clix, cliy;     // view size (on screen)
 
-    ViewStart(&stx, &sty);
+    GetViewStart(&stx, &sty);
     GetClientSize(&clix, &cliy);
     GetVirtualSize(&szx, &szy);
 
@@ -841,7 +971,7 @@ void wxScrolledWindow::OnChar(wxKeyEvent& event)
         yScrollOld = GetScrollPos(wxVERTICAL);
 
     int dsty;
-    switch ( event.KeyCode() )
+    switch ( event.GetKeyCode() )
     {
         case WXK_PAGEUP:
         case WXK_PRIOR:
@@ -903,3 +1033,5 @@ void wxScrolledWindow::OnChar(wxKeyEvent& event)
     }
 }
 
+
+// vi:sts=4:sw=4:et