diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h index 1b41c43d9b..f1ca429fff 100644 --- a/include/wx/scrolwin.h +++ b/include/wx/scrolwin.h @@ -108,6 +108,17 @@ public: // actually scroll a non-constant distance virtual void EnableScrolling(bool x_scrolling, bool y_scrolling); + // Disable use of keyboard keys for scrolling. By default cursor movement + // keys (including Home, End, Page Up and Down) are used to scroll the + // window appropriately. If the derived class uses these keys for something + // else, e.g. changing the currently selected item, this function can be + // used to disable this behaviour as it's not only not necessary then but + // can actually be actively harmful if another object forwards a keyboard + // event corresponding to one of the above keys to us using + // ProcessWindowEvent() because the event will always be processed which + // can be undesirable. + void DisableKeyboardScrolling() { m_kbdScrollingEnabled = false; } + // Get the view start void GetViewStart(int *x, int *y) const { DoGetViewStart(x, y); } @@ -284,6 +295,8 @@ protected: bool m_xScrollingEnabled; bool m_yScrollingEnabled; + bool m_kbdScrollingEnabled; + #if wxUSE_MOUSEWHEEL int m_wheelRotation; #endif // wxUSE_MOUSEWHEEL diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h index 9749ef7e8c..51fbde4e5e 100644 --- a/interface/wx/scrolwin.h +++ b/interface/wx/scrolwin.h @@ -199,6 +199,22 @@ public: long style = wxHSCROLL | wxVSCROLL, const wxString& name = "scrolledWindow"); + /** + Disable use of keyboard keys for scrolling. + + By default cursor movement keys (including Home, End, Page Up and Down) + are used to scroll the window appropriately. If the derived class uses + these keys for something else, e.g. changing the currently selected + item, this function can be used to disable this behaviour as it's not + only not necessary then but can actually be actively harmful if another + object forwards a keyboard event corresponding to one of the above keys + to us using ProcessWindowEvent() because the event will always be + processed which can be undesirable. + + @since 2.9.1 + */ + void DisableKeyboardScrolling(); + /** Call this function to prepare the device context for drawing a scrolled image. diff --git a/src/generic/listctrl.cpp b/src/generic/listctrl.cpp index 1efbc040ea..0a6da82812 100644 --- a/src/generic/listctrl.cpp +++ b/src/generic/listctrl.cpp @@ -2753,21 +2753,11 @@ void wxListMainWindow::OnChar( wxKeyEvent &event ) parent->GetEventHandler()->ProcessEvent( le ); } - if ( (event.GetKeyCode() != WXK_UP) && - (event.GetKeyCode() != WXK_DOWN) && - (event.GetKeyCode() != WXK_RIGHT) && - (event.GetKeyCode() != WXK_LEFT) && - (event.GetKeyCode() != WXK_PAGEUP) && - (event.GetKeyCode() != WXK_PAGEDOWN) && - (event.GetKeyCode() != WXK_END) && - (event.GetKeyCode() != WXK_HOME) ) - { - // propagate the char event upwards - wxKeyEvent ke(event); - ke.SetEventObject( parent ); - if (parent->GetEventHandler()->ProcessEvent( ke )) - return; - } + // propagate the char event upwards + wxKeyEvent ke(event); + ke.SetEventObject( parent ); + if (parent->GetEventHandler()->ProcessEvent( ke )) + return; if ( HandleAsNavigationKey(event) ) return; @@ -4359,6 +4349,11 @@ bool wxGenericListCtrl::Create(wxWindow *parent, SetTargetWindow( m_mainWin ); + // We use the cursor keys for moving the selection, not scrolling, so call + // this method to ensure wxScrollHelperEvtHandler doesn't catch all + // keyboard events forwarded to us from wxListMainWindow. + DisableKeyboardScrolling(); + wxBoxSizer *sizer = new wxBoxSizer( wxVERTICAL ); sizer->Add( m_mainWin, 1, wxGROW ); SetSizer( sizer ); diff --git a/src/generic/scrlwing.cpp b/src/generic/scrlwing.cpp index c5329862e2..7dcd4ba055 100644 --- a/src/generic/scrlwing.cpp +++ b/src/generic/scrlwing.cpp @@ -343,6 +343,8 @@ wxScrollHelperBase::wxScrollHelperBase(wxWindow *win) m_xScrollingEnabled = m_yScrollingEnabled = true; + m_kbdScrollingEnabled = true; + m_scaleX = m_scaleY = 1.0; #if wxUSE_MOUSEWHEEL @@ -844,6 +846,12 @@ void wxScrollHelperBase::HandleOnPaint(wxPaintEvent& WXUNUSED(event)) // this they always have the priority void wxScrollHelperBase::HandleOnChar(wxKeyEvent& event) { + if ( !m_kbdScrollingEnabled ) + { + event.Skip(); + return; + } + // prepare the event this key press maps to wxScrollWinEvent newEvent;