X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2cd354c9c696fa507f3bd1443da14a320c0e14b9..3039ade95dbad1ee5a5ed03c25e3ed9241907850:/include/wx/scrolwin.h diff --git a/include/wx/scrolwin.h b/include/wx/scrolwin.h index 4fa1a03af1..0ba4976501 100644 --- a/include/wx/scrolwin.h +++ b/include/wx/scrolwin.h @@ -14,8 +14,8 @@ #include "wx/panel.h" -class WXDLLEXPORT wxScrollHelperEvtHandler; -class WXDLLEXPORT wxTimer; +class WXDLLIMPEXP_FWD_CORE wxScrollHelperEvtHandler; +class WXDLLIMPEXP_FWD_BASE wxTimer; // default scrolled window style: scroll in both directions #define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL) @@ -48,7 +48,7 @@ class WXDLLEXPORT wxTimer; // // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxScrollHelper +class WXDLLIMPEXP_CORE wxScrollHelper { public: // ctor must be given the associated window @@ -68,6 +68,10 @@ public: int GetScrollPageSize(int orient) const; void SetScrollPageSize(int orient, int pageSize); + // get the number of lines the window can scroll, + // returns 0 if no scrollbars are there. + int GetScrollLines( int orient ) const; + // Set the x, y scrolling increments. void SetScrollRate( int xstep, int ystep ); @@ -158,6 +162,7 @@ public: #if wxUSE_MOUSEWHEEL void HandleOnMouseWheel(wxMouseEvent& event); #endif // wxUSE_MOUSEWHEEL + void HandleOnChildFocus(wxChildFocusEvent& event); // FIXME: this is needed for now for wxPlot compilation, should be removed // once it is fixed! @@ -177,7 +182,7 @@ protected: : m_targetWindow->GetClientSize(); } - void GetTargetSize(int *w, int *h) + void GetTargetSize(int *w, int *h) const { wxSize size = GetTargetSize(); if ( w ) @@ -191,7 +196,6 @@ protected: bool ScrollLayout(); void ScrollDoSetVirtualSize(int x, int y); wxSize ScrollGetBestVirtualSize() const; - wxSize ScrollGetWindowSizeForVirtualSize(const wxSize& size) const; // change just the target window (unlike SetWindow which changes m_win as // well) @@ -200,6 +204,37 @@ protected: // delete the event handler we installed void DeleteEvtHandler(); + // calls wxScrollHelperEvtHandler::ResetDrawnFlag(), see explanation + // in wxScrollHelperEvtHandler::ProcessEvent() + void ResetDrawnFlag(); + + // helper of AdjustScrollbars(): does the work for the single scrollbar + // + // notice that the parameters passed by non-const references are modified + // by this function + void AdjustScrollbar(int orient, + int clientSize, + int virtSize, + int& pixelsPerUnit, + int& scrollUnits, + int& scrollPosition); + + // this function should be overridden to return the size available for + // m_targetWindow inside m_win of the given size + // + // the default implementation is only good for m_targetWindow == m_win + // case, if we're scrolling a subwindow you must override this method + virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size) + { + // returning just size from here is wrong but it was decided that it is + // not wrong enough to break the existing code (which doesn't override + // this recently added function at all) by adding this assert + // + // wxASSERT_MSG( m_targetWindow == m_win, "must be overridden" ); + + return size; + } + double m_scaleX; double m_scaleY; @@ -229,74 +264,150 @@ protected: wxScrollHelperEvtHandler *m_handler; + DECLARE_NO_COPY_CLASS(wxScrollHelper) }; // this macro can be used in a wxScrollHelper-derived class to forward wxWindow // methods to corresponding wxScrollHelper methods #define WX_FORWARD_TO_SCROLL_HELPER() \ +public: \ virtual void PrepareDC(wxDC& dc) { DoPrepareDC(dc); } \ virtual bool Layout() { return ScrollLayout(); } \ virtual void DoSetVirtualSize(int x, int y) \ { ScrollDoSetVirtualSize(x, y); } \ virtual wxSize GetBestVirtualSize() const \ - { return ScrollGetBestVirtualSize(); } \ - virtual wxSize GetWindowSizeForVirtualSize(const wxSize& size) const \ - { return ScrollGetWindowSizeForVirtualSize(size); } + { return ScrollGetBestVirtualSize(); } // include the declaration of wxScrollHelperNative if needed -#if defined(__WXGTK__) && !defined(__WXUNIVERSAL__) +#if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__) #include "wx/gtk/scrolwin.h" +#elif defined(__WXGTK__) && !defined(__WXUNIVERSAL__) + #include "wx/gtk1/scrolwin.h" #else typedef wxScrollHelper wxScrollHelperNative; #endif // ---------------------------------------------------------------------------- -// wxScrolledWindow: a wxWindow which knows how to scroll +// wxScrolled: a wxWindow which knows how to scroll // ---------------------------------------------------------------------------- -class WXDLLEXPORT 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(WXUINT nMsg, 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; - WX_FORWARD_TO_SCROLL_HELPER() +#ifdef __WXMAC__ + this->MacSetClipChildren(true); +#endif -protected: - // this is needed for wxEVT_PAINT processing hack described in - // wxScrollHelperEvtHandler::ProcessEvent() - void OnPaint(wxPaintEvent& event); + 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(nMsg, T::MSWWindowProc(nMsg, wParam, lParam)); + } #endif // __WXMSW__ + WX_FORWARD_TO_SCROLL_HELPER() + +protected: + virtual wxSize DoGetBestSize() const + { + return FilterBestSize(this, this, T::DoGetBestSize()); + } + private: + // 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(); + } + + // 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) +#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 ) +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) - DECLARE_EVENT_TABLE() }; -#endif // _WX_SCROLWIN_H_BASE_ +typedef wxScrolled wxScrolledCanvas; +#endif // _WX_SCROLWIN_H_BASE_