From de168da1ed50ba602da4868a82de1f27de10c12b Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sat, 22 Dec 2012 02:34:07 +0000 Subject: [PATCH] No changes, just improve wxScrolled::EnableScrolling() documentation. Explain that, in spite of its name, this function doesn't disable scrolling when called with false argument but just changes the mechanism used to implement it. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73241 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- include/wx/scrolwin.h | 8 ++++++++ interface/wx/scrolwin.h | 21 +++++++++++---------- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h index 89f0953362..adc7e5a1fc 100644 --- a/include/wx/scrolwin.h +++ b/include/wx/scrolwin.h @@ -106,6 +106,10 @@ public: // Clear() is necessary. If false, the whole canvas is invalidated and a // Clear() is necessary. Disable for when the scroll increment is used to // actually scroll a non-constant distance + // + // Notice that calling this method with a false argument doesn't disable + // scrolling the window in this direction, it just changes the mechanism by + // which it is implemented to not use wxWindow::ScrollWindow(). virtual void EnableScrolling(bool x_scrolling, bool y_scrolling); // Disable use of keyboard keys for scrolling. By default cursor movement @@ -279,6 +283,10 @@ protected: wxTimer *m_timerAutoScroll; + // The number of pixels to scroll in horizontal and vertical directions + // respectively. + // + // If 0, means that the scrolling in the given direction is disabled. int m_xScrollPixelsPerLine; int m_yScrollPixelsPerLine; int m_xScrollPosition; diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h index f7c3568b58..6234faf54c 100644 --- a/interface/wx/scrolwin.h +++ b/interface/wx/scrolwin.h @@ -297,21 +297,22 @@ public: void DoPrepareDC(wxDC& dc); /** - Enable or disable physical scrolling in the given direction. Physical - scrolling is the physical transfer of bits up or down the - screen when a scroll event occurs. If the application scrolls by a - variable amount (e.g. if there are different font sizes) then physical - scrolling will not work, and you should switch it off. Note that you - will have to reposition child windows yourself, if physical scrolling - is disabled. + Enable or disable use of wxWindow::ScrollWindow() for scrolling. + + By default, when a scrolled window is logically scrolled, + wxWindow::ScrollWindow() is called on the underlying window which + scrolls the window contents and only invalidates the part of the window + newly brought into view. If @false is passed as an argument, then this + "physical scrolling" is disabled and the window is entirely invalidated + whenever it is scrolled by calling wxWindow::Refresh(). + + It should be rarely necessary to disable physical scrolling, so this + method shouldn't be called in normal circumstances. @param xScrolling If @true, enables physical scrolling in the x direction. @param yScrolling If @true, enables physical scrolling in the y direction. - - @remarks Physical scrolling may not be available on all platforms. Where - it is available, it is enabled by default. */ void EnableScrolling(bool xScrolling, bool yScrolling); -- 2.45.2