Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

No changes, just improve wxScrolled::EnableScrolling() documentation.

Browse Source 
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
This commit is contained in:
Vadim Zeitlin
2012-12-22 02:34:07 +00:00
parent 01936e1d49
commit de168da1ed
2 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/wx/scrolwin.h
View File

@@ -106,6 +106,10 @@ public:
// Clear() is necessary. If false, the whole canvas is invalidated and a // Clear() is necessary. If false, the whole canvas is invalidated and a
// Clear() is necessary. Disable for when the scroll increment is used to // Clear() is necessary. Disable for when the scroll increment is used to
// actually scroll a non-constant distance // 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); virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
// Disable use of keyboard keys for scrolling. By default cursor movement // Disable use of keyboard keys for scrolling. By default cursor movement
@@ -279,6 +283,10 @@ protected:
wxTimer *m_timerAutoScroll; 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_xScrollPixelsPerLine;
int m_yScrollPixelsPerLine; int m_yScrollPixelsPerLine;
int m_xScrollPosition; int m_xScrollPosition;

21
interface/wx/scrolwin.h
View File

@@ -297,21 +297,22 @@ public:
void DoPrepareDC(wxDC& dc); void DoPrepareDC(wxDC& dc);
/** /**
Enable or disable physical scrolling in the given direction. Physical Enable or disable use of wxWindow::ScrollWindow() for scrolling.
scrolling is the physical transfer of bits up or down the
screen when a scroll event occurs. If the application scrolls by a By default, when a scrolled window is logically scrolled,
variable amount (e.g. if there are different font sizes) then physical wxWindow::ScrollWindow() is called on the underlying window which
scrolling will not work, and you should switch it off. Note that you scrolls the window contents and only invalidates the part of the window
will have to reposition child windows yourself, if physical scrolling newly brought into view. If @false is passed as an argument, then this
is disabled. "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 @param xScrolling
If @true, enables physical scrolling in the x direction. If @true, enables physical scrolling in the x direction.
@param yScrolling @param yScrolling
If @true, enables physical scrolling in the y direction. 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); void EnableScrolling(bool xScrolling, bool yScrolling);