From 16361ec94128d2cea3a08c2c84a4eb38232715d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=A1clav=20Slav=C3=ADk?= Date: Tue, 1 Apr 2008 15:07:03 +0000 Subject: [PATCH] Generalized wxScrolledWindow into wxScrolled that can derive from anything (typically wxPanel or wxWindow). Fixed generic wxListCtrl to use wxScrolled - this fixes focus problems with label-editing text control. Fixes to wxScrolledWindow doxygen docs. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52961 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/changes.txt | 2 + include/wx/dlimpexp.h | 7 +- include/wx/scrolwin.h | 116 ++++++++++--- interface/scrolwin.h | 340 ++++++++++++++++++++++++--------------- src/generic/listctrl.cpp | 20 +-- src/generic/scrlwing.cpp | 74 +++------ 6 files changed, 335 insertions(+), 224 deletions(-) diff --git a/docs/changes.txt b/docs/changes.txt index 4c8ff6c2b2..18522e2f5d 100644 --- a/docs/changes.txt +++ b/docs/changes.txt @@ -308,6 +308,8 @@ All (GUI): - Added wxApp::SetNativeTheme() (Stefan H.). - Made wxSpinCtrl::Reparent() in MSW and generic versions (Angelo Mottola). - Freeze() and Thaw() now recursively freeze/thaw the children too. +- Generalized wxScrolledWindow into wxScrolled template that can derive + from any window class, not just wxPanel. wxGTK: diff --git a/include/wx/dlimpexp.h b/include/wx/dlimpexp.h index e87c749ab7..8b88602f04 100644 --- a/include/wx/dlimpexp.h +++ b/include/wx/dlimpexp.h @@ -264,12 +264,14 @@ template class Foo { ... }; WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE( Foo ) - (notice that currently we only need this for the wxBase library) + (notice that currently we only need this for wxBase and wxCore libraries) */ #if defined(__VISUALC__) && (__VISUALC__ <= 1200) #ifdef WXMAKINGDLL_BASE #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl) \ template class WXDLLIMPEXP_BASE decl; + #define WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE(decl) \ + template class WXDLLIMPEXP_CORE decl; #else /* We need to disable this warning when using this macro, as @@ -281,9 +283,12 @@ #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl) \ extern template class WXDLLIMPEXP_BASE decl; + #define WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE(decl) \ + extern template class WXDLLIMPEXP_CORE decl; #endif #else /* not VC <= 6 */ #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl) + #define WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE(decl) #endif /* VC6/others */ #endif /* _WX_DLIMPEXP_H_ */ diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h index 0215586e95..62ccdb04b1 100644 --- a/include/wx/scrolwin.h +++ b/include/wx/scrolwin.h @@ -204,6 +204,10 @@ protected: // delete the event handler we installed void DeleteEvtHandler(); + // calls wxScrollHelperEvtHandler::ResetDrawnFlag(), see explanation + // in wxScrollHelperEvtHandler::ProcessEvent() + void ResetDrawnFlag(); + double m_scaleX; double m_scaleY; @@ -257,53 +261,121 @@ public: \ #endif // ---------------------------------------------------------------------------- -// wxScrolledWindow: a wxWindow which knows how to scroll +// wxScrolled: a wxWindow which knows how to scroll // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_CORE wxScrolledWindow : public wxPanel, - public wxScrollHelperNative +// helper class for wxScrolled below +struct WXDLLIMPEXP_CORE wxScrolledT_Helper +{ + static wxSize FilterBestSize(const wxWindow *win, + const wxScrollHelperNative *helper, + const wxSize& origBest); +#ifdef __WXMSW__ + static WXLRESULT FilterMSWWindowProc(WXLRESULT origResult); +#endif +}; + +// Scrollable window base on window type T. This used to be wxScrolledWindow, +// but wxScrolledWindow includes wxControlContainer functionality and that's +// not always desirable. +template +class WXDLLIMPEXP_CORE wxScrolled : public T, + public wxScrollHelperNative, + private wxScrolledT_Helper { public: - wxScrolledWindow() : wxScrollHelperNative(this) { } - wxScrolledWindow(wxWindow *parent, - wxWindowID winid = wxID_ANY, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxScrolledWindowStyle, - const wxString& name = wxPanelNameStr) + wxScrolled() : wxScrollHelperNative(this) { } + wxScrolled(wxWindow *parent, + wxWindowID winid = wxID_ANY, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxScrolledWindowStyle, + const wxString& name = wxPanelNameStr) : wxScrollHelperNative(this) { Create(parent, winid, pos, size, style, name); } - virtual ~wxScrolledWindow(); - bool Create(wxWindow *parent, wxWindowID winid, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxScrolledWindowStyle, - const wxString& name = wxPanelNameStr); + const wxString& name = wxPanelNameStr) + { + m_targetWindow = this; + +#ifdef __WXMAC__ + MacSetClipChildren(true); +#endif + + this->Connect(wxEVT_PAINT, wxPaintEventHandler(wxScrolled::OnPaint)); + + // by default, we're scrollable in both directions (but if one of the + // styles is specified explicitly, we shouldn't add the other one + // automatically) + if ( !(style & (wxHSCROLL | wxVSCROLL)) ) + style |= wxHSCROLL | wxVSCROLL; + + return T::Create(parent, winid, pos, size, style, name); + } // we need to return a special WM_GETDLGCODE value to process just the // arrows but let the other navigation characters through #ifdef __WXMSW__ - virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); + virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) + { + return FilterMSWWindowProc(T::MSWWindowProc(nMsg, wParam, lParam)); + } #endif // __WXMSW__ WX_FORWARD_TO_SCROLL_HELPER() protected: - virtual wxSize DoGetBestSize() const; - - // this is needed for wxEVT_PAINT processing hack described in - // wxScrollHelperEvtHandler::ProcessEvent() - void OnPaint(wxPaintEvent& event); + virtual wxSize DoGetBestSize() const + { + return FilterBestSize(this, this, T::DoGetBestSize()); + } private: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxScrolledWindow) - DECLARE_EVENT_TABLE() + // this is needed for wxEVT_PAINT processing hack described in + // wxScrollHelperEvtHandler::ProcessEvent() + void OnPaint(wxPaintEvent& event) + { + // the user code didn't really draw the window if we got here, so set + // this flag to try to call OnDraw() later + ResetDrawnFlag(); + event.Skip(); + } + + DECLARE_NO_COPY_CLASS(wxScrolled) }; -#endif // _WX_SCROLWIN_H_BASE_ +// 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 ) +WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE( wxScrolled ) +// for compatibility with existing code, we provide wxScrolledWindow +// "typedef" for wxScrolled. It's not a real typedef because we +// want wxScrolledWindow to show in wxRTTI information (the class is widely +// used and likelihood of its wxRTTI information being used too is high): +class WXDLLIMPEXP_CORE wxScrolledWindow : public wxScrolled +{ +public: + wxScrolledWindow() : wxScrolled() {} + wxScrolledWindow(wxWindow *parent, + wxWindowID winid = wxID_ANY, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxScrolledWindowStyle, + const wxString& name = wxPanelNameStr) + : wxScrolled(parent, winid, pos, size, style, name) {} + + DECLARE_DYNAMIC_CLASS_NO_COPY(wxScrolledWindow) +}; + +typedef wxScrolled wxScrolledCanvas; + +#endif // _WX_SCROLWIN_H_BASE_ diff --git a/interface/scrolwin.h b/interface/scrolwin.h index eb01f8d60a..7bd80daedc 100644 --- a/interface/scrolwin.h +++ b/interface/scrolwin.h @@ -7,156 +7,160 @@ ///////////////////////////////////////////////////////////////////////////// /** - @class wxScrolledWindow @wxheader{scrolwin.h} - The wxScrolledWindow class manages scrolling for its client area, transforming + The wxScrolled class manages scrolling for its client area, transforming the coordinates according to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view. + There are two commonly used (but not the only possible!) specializations of + this class: + + - ::wxScrolledWindow, aka wxScrolled, is equivalent to + ::wxScrolledWindow from earlier versions. Derived from wxPanel, it shares + wxPanel's behaviour with regard to TAB traversal and focus handling. Use + this if the scrolled window will have children controls. + + - ::wxScrolledCanvas, aka wxScrolled, derives from wxWindow and + so doesn't handle children specially. This is suitable e.g. for + implementating scrollable controls such as tree or list controls. + Starting from version 2.4 of wxWidgets, there are several ways to use a - wxScrolledWindow. In particular, there are now three ways to set the + wxScrolled. In particular, there are now three ways to set the size of the scrolling area: - One way is to set the scrollbars directly using a call to - wxScrolledWindow::SetScrollbars. - This is the way it used to be in any previous version of wxWidgets - and it will be kept for backwards compatibility. + One way is to set the scrollbars directly using a call to SetScrollbars(). + This is the way it used to be in any previous version of wxWidgets and it + will be kept for backwards compatibility. An additional method of manual control, which requires a little less computation of your own, is to set the total size of the scrolling area by - calling either wxWindow::SetVirtualSize, - or wxWindow::FitInside, and setting the - scrolling increments for it by calling - wxScrolledWindow::SetScrollRate. + calling either wxWindow::SetVirtualSize(), or wxWindow::FitInside(), and + setting the scrolling increments for it by calling SetScrollRate(). Scrolling in some orientation is enabled by setting a non-zero increment for it. The most automatic and newest way is to simply let sizers determine the - scrolling area. This is now the default when you set an interior sizer - into a wxScrolledWindow with wxWindow::SetSizer. - The scrolling area will be set to the size requested by the sizer and - the scrollbars will be assigned for each orientation according to the need - for them and the scrolling increment set by - wxScrolledWindow::SetScrollRate. - As above, scrolling is only enabled in orientations with a non-zero - increment. You can influence the minimum size of the scrolled area - controlled by a sizer by calling - wxWindow::SetVirtualSizeHints. - (calling wxScrolledWindow::SetScrollbars - has analogous effects in wxWidgets 2.4 -- in later versions it may not continue - to override the sizer) + scrolling area. This is now the default when you set an interior sizer into + a wxScrolled with wxWindow::SetSizer(). The scrolling area will be + set to the size requested by the sizer and the scrollbars will be assigned + for each orientation according to the need for them and the scrolling + increment set by SetScrollRate(). As above, scrolling is only enabled in + orientations with a non-zero increment. You can influence the minimum size + of the scrolled area controlled by a sizer by calling + wxWindow::SetVirtualSizeHints(). (Calling SetScrollbars() has analogous + effects in wxWidgets 2.4 -- in later versions it may not continue to + override the sizer.) - Note: if Maximum size hints are still supported by SetVirtualSizeHints, use - them at your own dire risk. They may or may not have been removed for 2.4, - but it really only makes sense to set minimum size hints here. We should - probably replace SetVirtualSizeHints with SetMinVirtualSize or similar - and remove it entirely in future. + Note that if maximum size hints are still supported by + wxWindow::SetVirtualSizeHints(), use them at your own dire risk. They may + or may not have been removed for 2.4, but it really only makes sense to set + minimum size hints here. We should probably replace + wxWindow::SetVirtualSizeHints() with wxWindow::SetMinVirtualSize() or + similar and remove it entirely in future. - As with all windows, an application can draw onto a wxScrolledWindow using + As with all windows, an application can draw onto a wxScrolled using a @ref overview_dcoverview "device context". - You have the option of handling the OnPaint handler - or overriding the wxScrolledWindow::OnDraw function, which is - passed a pre-scrolled device context (prepared by - wxScrolledWindow::DoPrepareDC). + You have the option of handling the OnPaint handler or overriding the + wxScrolled::OnDraw() function, which is passed a pre-scrolled device + context (prepared by wxScrolled::DoPrepareDC()). - If you don't wish to calculate your own scrolling, you must call DoPrepareDC - when not drawing from - within OnDraw, to set the device origin for the device context according to the - current - scroll position. + If you don't wish to calculate your own scrolling, you must call + DoPrepareDC() when not drawing from within OnDraw(), to set the device + origin for the device context according to the current scroll position. - A wxScrolledWindow will normally scroll itself and therefore its child windows - as well. It - might however be desired to scroll a different window than itself: e.g. when - designing a - spreadsheet, you will normally only have to scroll the (usually white) cell - area, whereas the - (usually grey) label area will scroll very differently. For this special - purpose, you can - call wxScrolledWindow::SetTargetWindow which means that pressing - the scrollbars will scroll a different window. + A wxScrolled will normally scroll itself and therefore its child windows + as well. It might however be desired to scroll a different window than + itself: e.g. when designing a spreadsheet, you will normally only have to + scroll the (usually white) cell area, whereas the (usually grey) label area + will scroll very differently. For this special purpose, you can call + SetTargetWindow() which means that pressing the scrollbars will scroll a + different window. - Note that the underlying system knows nothing about scrolling coordinates, so - that all system - functions (mouse events, expose events, refresh calls etc) as well as the - position of subwindows - are relative to the "physical" origin of the scrolled window. If the user - insert a child window at + Note that the underlying system knows nothing about scrolling coordinates, + so that all system functions (mouse events, expose events, refresh calls + etc) as well as the position of subwindows are relative to the "physical" + origin of the scrolled window. If the user insert a child window at position (10,10) and scrolls the window down 100 pixels (moving the child - window out of the visible - area), the child window will report a position of (10,-90). + window out of the visible area), the child window will report a position + of (10,-90). @beginStyleTable @style{wxRETAINED}: Uses a backing pixmap to speed refreshes. Motif only. @endStyleTable + @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 the window. For more sophisticated applications, use the + wxScrolled implementation as a guide to build your own scroll + behaviour or use wxVScrolledWindow or its variants. + + @since wxScrolled template exists since version 2.9.0. In older + versions, only ::wxScrolledWindow (equivalent of wxScrolled) + was available. + @library{wxcore} @category{miscwnd} - @see wxScrollBar, wxClientDC, wxPaintDC, wxVScrolledWindow + @see wxScrollBar, wxClientDC, wxPaintDC, + wxVScrolledWindow, wxHScrolledWindow, wxHVScrolledWindow, */ -class wxScrolledWindow : public wxPanel +template +class wxScrolled : public T { public: - //@{ + /// Default constructor. + wxScrolled(); + /** Constructor. @param parent Parent window. @param id - Window identifier. The value wxID_ANY indicates a default value. + Window identifier. The value @c wxID_ANY indicates a default value. @param pos - Window position. If a position of (-1, -1) is specified then a default - position - is chosen. + Window position. If a position of @c wxDefaultPosition is specified + then a default position is chosen. @param size - Window size. If a size of (-1, -1) is specified then the window is sized - appropriately. + Window size. If a size of @c wxDefaultSize is specified then the + window is sized appropriately. @param style - Window style. See wxScrolledWindow. + Window style. See wxScrolled. @param name Window name. - @remarks The window is initially created without visible scrollbars. Call - SetScrollbars() to specify how big the - virtual window size should be. + @remarks The window is initially created without visible scrollbars. + Call SetScrollbars() to specify how big the virtual window + size should be. */ - wxScrolledWindow(); - wxScrolledWindow(wxWindow* parent, wxWindowID id = -1, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxHSCROLL | wxVSCROLL, - const wxString& name = "scrolledWindow"); - //@} + wxScrolled(wxWindow* parent, wxWindowID id = -1, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxHSCROLL | wxVSCROLL, + const wxString& name = "scrolledWindow"); + /** - Destructor. - */ - ~wxScrolledWindow(); - - /** - Translates the logical coordinates to the device ones. For example, if a window - is - scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, - 0) - (as always), but the logical coordinates are (0, 10) and so the call to - CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy. + Translates the logical coordinates to the device ones. For example, if + a window is scrolled 10 pixels to the bottom, the device coordinates of + the origin are (0, 0) (as always), but the logical coordinates are (0, + 10) and so the call to CalcScrolledPosition(0, 10, xx, yy) will return + 0 in yy. @see CalcUnscrolledPosition() */ void CalcScrolledPosition(int x, int y, int* xx, int* yy) const; /** - Translates the device coordinates to the logical ones. For example, if a window - is - scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, - 0) - (as always), but the logical coordinates are (0, 10) and so the call to - CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy. + Translates the device coordinates to the logical ones. For example, if + a window is scrolled 10 pixels to the bottom, the device coordinates of + the origin are (0, 0) (as always), but the logical coordinates are (0, + 10) and so the call to CalcUnscrolledPosition(0, 0, xx, yy) will return + 10 in yy. @see CalcScrolledPosition() */ @@ -164,7 +168,7 @@ public: /** Creates the window for two-step construction. Derived classes - should call or replace this function. See wxScrolledWindow() + should call or replace this function. See wxScrolled constructor for details. */ bool Create(wxWindow* parent, wxWindowID id = -1, @@ -174,16 +178,35 @@ public: const wxString& name = "scrolledWindow"); /** - Call this function to prepare the device context for drawing a scrolled image. - It - sets the device origin according to the current scroll position. - DoPrepareDC is called automatically within the default OnPaint() event - handler, so your OnDraw() override - will be passed a 'pre-scrolled' device context. However, if you wish to draw - from - outside of OnDraw (via OnPaint), or you wish to implement OnPaint yourself, you - must - call this function yourself. For example: + Call this function to prepare the device context for drawing a scrolled + image. + + It sets the device origin according to the current scroll position. + DoPrepareDC() is called automatically within the default OnPaint() + event handler, so your OnDraw() override will be passed a + 'pre-scrolled' device context. However, if you wish to draw from + outside of OnDraw() (via OnPaint()), or you wish to implement OnPaint() + yourself, you must call this function yourself. + + For example: + @code + void MyWindow::OnEvent(wxMouseEvent& event) + { + wxClientDC dc(this); + DoPrepareDC(dc); + + dc.SetPen(*wxBLACK_PEN); + float x, y; + event.Position(&x, &y); + if (xpos > -1 && ypos > -1 && event.Dragging()) + { + dc.DrawLine(xpos, ypos, x, y); + } + xpos = x; + ypos = y; + } + @endcode + */ void DoPrepareDC(wxDC& dc); @@ -207,9 +230,9 @@ public: void EnableScrolling(bool xScrolling, bool yScrolling); /** - Get the number of pixels per scroll unit (line), in each direction, as set - by SetScrollbars(). A value of zero indicates no - scrolling in that direction. + Get the number of pixels per scroll unit (line), in each direction, as + set by SetScrollbars(). A value of zero indicates no scrolling in that + direction. @param xUnit Receives the number of pixels per horizontal unit. @@ -230,7 +253,7 @@ public: @remarks If either of the scrollbars is not at the home position, x and/or y will be greater than zero. Combined with - wxWindow::GetClientSize, the application can use this + wxWindow::GetClientSize(), the application can use this function to efficiently redraw only the visible portion of the window. The positions are in logical scroll units, not pixels, so to convert to pixels you will @@ -251,7 +274,7 @@ public: @param y Receives the height of the scrollable window, in pixels. - @remarks Use wxDC::DeviceToLogicalX and wxDC::DeviceToLogicalY to + @remarks Use wxDC::DeviceToLogicalX() and wxDC::DeviceToLogicalY() to translate these units to logical units. @see SetScrollbars(), GetScrollPixelsPerUnit() @@ -264,20 +287,21 @@ public: bool IsRetained() const; /** - Called by the default paint event handler to allow the application to define - painting behaviour without having to worry about calling + Called by the default paint event handler to allow the application to + define painting behaviour without having to worry about calling DoPrepareDC(). - Instead of overriding this function you may also just process the paint event - in the derived class as usual, but then you will have to call DoPrepareDC() - yourself. + + Instead of overriding this function you may also just process the paint + event in the derived class as usual, but then you will have to call + DoPrepareDC() yourself. */ virtual void OnDraw(wxDC& dc); /** This function is for backwards compatibility only and simply calls - DoPrepareDC() now. Notice that it is - not called by the default paint event handle (DoPrepareDC() is), so - overriding this method in your derived class is useless. + DoPrepareDC() now. Notice that it is not called by the default paint + event handle (DoPrepareDC() is), so overriding this method in your + derived class is useless. */ void PrepareDC(wxDC& dc); @@ -300,14 +324,37 @@ public: void Scroll(int x, int y); /** - Set the horizontal and vertical scrolling increment only. See the pixelsPerUnit - parameter in SetScrollbars. + Set the horizontal and vertical scrolling increment only. See the + pixelsPerUnit parameter in SetScrollbars(). */ void SetScrollRate(int xstep, int ystep); /** Sets up vertical and/or horizontal scrollbars. + The first pair of parameters give the number of pixels per 'scroll + step', i.e. amount moved when the up or down scroll arrows are pressed. + The second pair gives the length of scrollbar in scroll steps, which + sets the size of the virtual window. + + @a xPos and @a yPos optionally specify a position to scroll to + immediately. + + For example, the following gives a window horizontal and vertical + scrollbars with 20 pixels per scroll step, and a size of 50 steps (1000 + pixels) in each direction: + @code + window->SetScrollbars(20, 20, 50, 50); + @endcode + + wxScrolled manages the page size itself, using the current client + window size as the page size. + + Note that for more sophisticated scrolling applications, for example + where scroll steps may be variable according to the position in the + document, it will be necessary to derive a new class from wxWindow, + overriding OnSize() and adjusting the scrollbars appropriately. + @param pixelsPerUnitX Pixels per scroll unit in the horizontal direction. @param pixelsPerUnitY @@ -317,21 +364,15 @@ public: @param noUnitsY Number of units in the vertical direction. @param xPos - Position to initialize the scrollbars in the horizontal direction, in - scroll units. + Position to initialize the scrollbars in the horizontal direction, + in scroll units. @param yPos - Position to initialize the scrollbars in the vertical direction, in scroll - units. + Position to initialize the scrollbars in the vertical direction, in + scroll units. @param noRefresh Will not refresh window if @true. - @remarks The first pair of parameters give the number of pixels per - 'scroll step', i.e. amount moved when the up or down - scroll arrows are pressed. The second pair gives the - length of scrollbar in scroll steps, which sets the - size of the virtual window. - - @see wxWindow::SetVirtualSize + @see wxWindow::SetVirtualSize() */ void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, @@ -341,9 +382,42 @@ public: bool noRefresh = false); /** - Call this function to tell wxScrolledWindow to perform the actual scrolling on - a different window (and not on itself). + Call this function to tell wxScrolled to perform the actual + scrolling on a different window (and not on itself). */ void SetTargetWindow(wxWindow* window); }; + +/** + Scrolled window derived from wxPanel. + + See wxScrolled for detailed description. + + @note Note that because this class derives from wxPanel, it shares its + behavior with regard to TAB traversal and focus handling (in + particular, it forwards focus to its children). If you don't want + this behaviour, use ::wxScrolledCanvas instead. + + @note wxScrolledWindow is an alias for wxScrolled since version + 2.9.0. In older versions, it was a standalone class. + + @library{wxcore} + @category{miscwnd} + + @see wxScrolled, wxScrolledCanvas +*/ +typedef wxScrolled wxScrolledWindow; + +/** + Alias for wxScrolled. Scrolled window that doesn't have children + and so doesn't need or want special handling of TAB traversal. + + @since 2.9.0 + + @library{wxcore} + @category{miscwnd} + + @see wxScrolled, ::wxScrolledWindow +*/ +typedef wxScrolled wxScrolledCanvas; diff --git a/src/generic/listctrl.cpp b/src/generic/listctrl.cpp index a3419d15c7..eb553e1328 100644 --- a/src/generic/listctrl.cpp +++ b/src/generic/listctrl.cpp @@ -432,7 +432,6 @@ private: // it wasn't vetoed, i.e. if we should proceed bool SendListEvent(wxEventType type, const wxPoint& pos); - DECLARE_DYNAMIC_CLASS(wxListHeaderWindow) DECLARE_EVENT_TABLE() }; @@ -492,7 +491,7 @@ WX_DECLARE_LIST(wxListHeaderData, wxListHeaderDataList); #include "wx/listimpl.cpp" WX_DEFINE_LIST(wxListHeaderDataList) -class wxListMainWindow : public wxScrolledWindow +class wxListMainWindow : public wxScrolledCanvas { public: wxListMainWindow(); @@ -701,7 +700,7 @@ public: // override base class virtual to reset m_lineHeight when the font changes virtual bool SetFont(const wxFont& font) { - if ( !wxScrolledWindow::SetFont(font) ) + if ( !wxScrolledCanvas::SetFont(font) ) return false; m_lineHeight = 0; @@ -849,7 +848,6 @@ private: wxListTextCtrlWrapper *m_textctrlWrapper; - DECLARE_DYNAMIC_CLASS(wxListMainWindow) DECLARE_EVENT_TABLE() friend class wxGenericListCtrl; @@ -1686,8 +1684,6 @@ void wxListLineData::ReverseHighlight( void ) // wxListHeaderWindow //----------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxListHeaderWindow,wxWindow) - BEGIN_EVENT_TABLE(wxListHeaderWindow,wxWindow) EVT_PAINT (wxListHeaderWindow::OnPaint) EVT_MOUSE_EVENTS (wxListHeaderWindow::OnMouse) @@ -2160,7 +2156,7 @@ void wxListTextCtrlWrapper::Finish( bool setfocus ) wxPendingDelete.Append( this ); if (setfocus) - m_owner->SetFocusIgnoringChildren(); + m_owner->SetFocus(); } bool wxListTextCtrlWrapper::AcceptChanges() @@ -2237,9 +2233,7 @@ void wxListTextCtrlWrapper::OnKillFocus( wxFocusEvent &event ) // wxListMainWindow //----------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxListMainWindow,wxScrolledWindow) - -BEGIN_EVENT_TABLE(wxListMainWindow,wxScrolledWindow) +BEGIN_EVENT_TABLE(wxListMainWindow,wxScrolledCanvas) EVT_PAINT (wxListMainWindow::OnPaint) EVT_MOUSE_EVENTS (wxListMainWindow::OnMouse) EVT_CHAR (wxListMainWindow::OnChar) @@ -2295,7 +2289,7 @@ wxListMainWindow::wxListMainWindow( wxWindow *parent, const wxSize& size, long style, const wxString &name ) - : wxScrolledWindow( parent, id, pos, size, + : wxScrolledCanvas( parent, id, pos, size, style | wxHSCROLL | wxVSCROLL, name ) { Init(); @@ -2994,7 +2988,7 @@ void wxListMainWindow::OnMouse( wxMouseEvent &event ) #endif // __WXMAC__ if ( event.LeftDown() ) - SetFocusIgnoringChildren(); + SetFocus(); event.SetEventObject( GetParent() ); if ( GetParent()->GetEventHandler()->ProcessEvent( event) ) @@ -4860,7 +4854,7 @@ void wxListMainWindow::OnScroll(wxScrollWinEvent& event) { // FIXME #if ( defined(__WXGTK__) || defined(__WXMAC__) ) && !defined(__WXUNIVERSAL__) - wxScrolledWindow::OnScroll(event); + wxScrolledCanvas::OnScroll(event); #else HandleOnScroll( event ); #endif diff --git a/src/generic/scrlwing.cpp b/src/generic/scrlwing.cpp index 00dac29274..7d14e6a556 100644 --- a/src/generic/scrlwing.cpp +++ b/src/generic/scrlwing.cpp @@ -438,6 +438,12 @@ void wxScrollHelper::DeleteEvtHandler() } } +void wxScrollHelper::ResetDrawnFlag() +{ + wxCHECK_RET( m_handler, "invalid use of ResetDrawnFlag - no handler?" ); + m_handler->ResetDrawnFlag(); +} + void wxScrollHelper::DoSetTargetWindow(wxWindow *target) { m_targetWindow = target; @@ -1398,52 +1404,12 @@ void wxScrollHelper::HandleOnChildFocus(wxChildFocusEvent& event) } // ---------------------------------------------------------------------------- -// wxScrolledWindow implementation +// wxScrolled and wxScrolledWindow implementation // ---------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel) - -BEGIN_EVENT_TABLE(wxScrolledWindow, wxPanel) - EVT_PAINT(wxScrolledWindow::OnPaint) -END_EVENT_TABLE() - -bool wxScrolledWindow::Create(wxWindow *parent, - wxWindowID id, - const wxPoint& pos, - const wxSize& size, - long style, - const wxString& name) -{ - m_targetWindow = this; -#ifdef __WXMAC__ - MacSetClipChildren( true ) ; -#endif - - // by default, we're scrollable in both directions (but if one of the - // styles is specified explicitly, we shouldn't add the other one - // automatically) - if ( !(style & (wxHSCROLL | wxVSCROLL)) ) - style |= wxHSCROLL | wxVSCROLL; - - bool ok = wxPanel::Create(parent, id, pos, size, style, name); - - return ok; -} - -wxScrolledWindow::~wxScrolledWindow() -{ -} - -void wxScrolledWindow::OnPaint(wxPaintEvent& event) -{ - // the user code didn't really draw the window if we got here, so set this - // flag to try to call OnDraw() later - m_handler->ResetDrawnFlag(); - - event.Skip(); -} - -wxSize wxScrolledWindow::DoGetBestSize() const +wxSize wxScrolledT_Helper::FilterBestSize(const wxWindow *win, + const wxScrollHelperNative *helper, + const wxSize& origBest) { // NB: We don't do this in WX_FORWARD_TO_SCROLL_HELPER, because not // all scrollable windows should behave like this, only those that @@ -1451,15 +1417,15 @@ wxSize wxScrolledWindow::DoGetBestSize() const // (i.e., wxScrolledWindow) and other some scrollable windows may // have different DoGetBestSize() implementation (e.g. wxTreeCtrl). - wxSize best = wxPanel::DoGetBestSize(); + wxSize best = origBest; - if ( GetAutoLayout() ) + if ( win->GetAutoLayout() ) { // Only use the content to set the window size in the direction // where there's no scrolling; otherwise we're going to get a huge // window in the direction in which scrolling is enabled int ppuX, ppuY; - GetScrollPixelsPerUnit(&ppuX, &ppuY); + helper->GetScrollPixelsPerUnit(&ppuX, &ppuY); // NB: This code used to use *current* size if min size wasn't // specified, presumably to get some reasonable (i.e., larger than @@ -1471,7 +1437,7 @@ wxSize wxScrolledWindow::DoGetBestSize() const // // See also http://svn.wxwidgets.org/viewvc/wx?view=rev&revision=45864 - wxSize minSize = GetMinSize(); + wxSize minSize = win->GetMinSize(); if ( ppuX > 0 ) best.x = minSize.x + wxSystemSettings::GetMetric(wxSYS_VSCROLL_X); @@ -1484,12 +1450,8 @@ wxSize wxScrolledWindow::DoGetBestSize() const } #ifdef __WXMSW__ -WXLRESULT wxScrolledWindow::MSWWindowProc(WXUINT nMsg, - WXWPARAM wParam, - WXLPARAM lParam) +WXLRESULT wxScrolledT_Helper::FilterMSWWindowProc(WXLRESULT rc) { - WXLRESULT rc = wxPanel::MSWWindowProc(nMsg, wParam, lParam); - #ifndef __WXWINCE__ // we need to process arrows ourselves for scrolling if ( nMsg == WM_GETDLGCODE ) @@ -1497,8 +1459,10 @@ WXLRESULT wxScrolledWindow::MSWWindowProc(WXUINT nMsg, rc |= DLGC_WANTARROWS; } #endif - return rc; } - #endif // __WXMSW__ + +// NB: skipping wxScrolled in wxRTTI information because being a templte, +// it doesn't and can't implement wxRTTI support +IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel)