/////////////////////////////////////////////////////////////////////////////
-// Name: include/wx/scrolwin.h
+// Name: wx/scrolwin.h
// Purpose: wxScrolledWindow, wxScrolledControl and wxScrollHelper
// Author: Vadim Zeitlin
// Modified by:
bool noRefresh = false );
// scroll to the given (in logical coords) position
- void Scroll(int x, int y) { DoScroll(x, y); }
- void Scroll(const wxPoint& pt) { DoScroll(pt.x, pt.y); }
+ //
+ // notice that for backwards compatibility reasons Scroll() is virtual as
+ // the existing code could override it but new code should override
+ // DoScroll() instead
+ virtual void Scroll(int x, int y) { DoScroll(x, y); }
+ virtual void Scroll(const wxPoint& pt) { DoScroll(pt.x, pt.y); }
// get/set the page size for this orientation (wxVERTICAL/wxHORIZONTAL)
int GetScrollPageSize(int orient) const;
// 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); }
#endif // wxUSE_MOUSEWHEEL
void HandleOnChildFocus(wxChildFocusEvent& event);
- // FIXME: this is needed for now for wxPlot compilation, should be removed
- // once it is fixed!
- void OnScroll(wxScrollWinEvent& event) { HandleOnScroll(event); }
+#if WXWIN_COMPATIBILITY_2_8
+ wxDEPRECATED(
+ void OnScroll(wxScrollWinEvent& event) { HandleOnScroll(event); }
+ )
+#endif // WXWIN_COMPATIBILITY_2_8
protected:
// get pointer to our scroll rect if we use it or NULL
bool m_xScrollingEnabled;
bool m_yScrollingEnabled;
+ bool m_kbdScrollingEnabled;
+
#if wxUSE_MOUSEWHEEL
int m_wheelRotation;
#endif // wxUSE_MOUSEWHEEL
wxScrollHelperEvtHandler *m_handler;
- DECLARE_NO_COPY_CLASS(wxScrollHelperBase)
+ wxDECLARE_NO_COPY_CLASS(wxScrollHelperBase);
};
// this macro can be used in a wxScrollHelper-derived class to forward wxWindow
// but wxScrolledWindow includes wxControlContainer functionality and that's
// not always desirable.
template<class T>
-class WXDLLIMPEXP_CORE wxScrolled : public T,
- public wxScrollHelper,
- private wxScrolledT_Helper
+class wxScrolled : public T,
+ public wxScrollHelper,
+ private wxScrolledT_Helper
{
public:
wxScrolled() : wxScrollHelper(this) { }
// VC++ 6 gives warning for the declaration of template member function
// without definition
-#if !defined(__VISUALC__) || wxCHECK_VISUALC_VERSION(7)
- DECLARE_NO_COPY_CLASS(wxScrolled)
+#ifndef __VISUALC6__
+ wxDECLARE_NO_COPY_CLASS(wxScrolled);
#endif
};
-// VC++ <= 6 requires this; it's unlikely any other specializations would
-// be needed by user code _and_ they were using VC6, so we list only wxWindow
-// (typical use) and wxPanel (wxScrolledWindow use) specializations here
-WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE( wxScrolled<wxPanel> )
-WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE( wxScrolled<wxWindow> )
+#ifdef __VISUALC6__
+ // disable the warning about non dll-interface class used as base for
+ // dll-interface class: it's harmless in this case
+ #pragma warning(push)
+ #pragma warning(disable:4275)
+#endif
// for compatibility with existing code, we provide wxScrolledWindow
// "typedef" for wxScrolled<wxPanel>. It's not a real typedef because we
typedef wxScrolled<wxWindow> wxScrolledCanvas;
+#ifdef __VISUALC6__
+ #pragma warning(pop)
+#endif
+
#endif // _WX_SCROLWIN_H_BASE_