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

Add documentation of emitted events to wxScrolled documentation.

Browse Source 
Make it clear that wxScrolled<> emits wxScrollWinEvent and not wxScrollEvent.

Closes #13730.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69940 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2011-12-07 12:46:15 +00:00
parent ee13a7e261
commit 2e8c12bcb0
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
interface/wx/scrolwin.h
View File

@ -103,6 +103,34 @@ enum wxScrollbarVisibility
Uses a backing pixmap to speed refreshes. Motif only.
@endStyleTable
@beginEventEmissionTable{wxScrollWinEvent}
@event{EVT_SCROLLWIN(func)}
Process all scroll events.
@event{EVT_SCROLLWIN_TOP(func)}
Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
@event{EVT_SCROLLWIN_BOTTOM(func)}
Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
@event{EVT_SCROLLWIN_LINEUP(func)}
Process @c wxEVT_SCROLLWIN_LINEUP line up events.
@event{EVT_SCROLLWIN_LINEDOWN(func)}
Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
@event{EVT_SCROLLWIN_PAGEUP(func)}
Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
@event{EVT_SCROLLWIN_PAGEDOWN(func)}
Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
@event{EVT_SCROLLWIN_THUMBTRACK(func)}
Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
(frequent events sent as the user drags the thumbtrack).
@event{EVT_SCROLLWIN_THUMBRELEASE(func)}
Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
@endEventTable
@note
Don't confuse wxScrollWinEvents generated by this class with
wxScrollEvent objects generated by wxScrollBar and wxSlider.
@remarks
Use wxScrolled for applications where the user scrolls by a fixed amount,
and where a 'page' can be interpreted to be the current visible portion of