X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8907154c1a8a6882c6797d1f16393ddfb23e7f3a..438959cca892a7651634cc3a7aad4819ac49b23c:/include/wx/univ/scrolbar.h diff --git a/include/wx/univ/scrolbar.h b/include/wx/univ/scrolbar.h index 527455b40c..5963989dcf 100644 --- a/include/wx/univ/scrolbar.h +++ b/include/wx/univ/scrolbar.h @@ -12,7 +12,7 @@ #ifndef _WX_UNIV_SCROLBAR_H_ #define _WX_UNIV_SCROLBAR_H_ -class WXDLLEXPORT wxScrollTimer; +class WXDLLIMPEXP_FWD_CORE wxScrollTimer; #include "wx/univ/scrarrow.h" #include "wx/renderer.h" @@ -22,23 +22,23 @@ class WXDLLEXPORT wxScrollTimer; // ---------------------------------------------------------------------------- // scroll the bar -#define wxACTION_SCROLL_START _T("start") // to the beginning -#define wxACTION_SCROLL_END _T("end") // to the end -#define wxACTION_SCROLL_LINE_UP _T("lineup") // one line up/left -#define wxACTION_SCROLL_PAGE_UP _T("pageup") // one page up/left -#define wxACTION_SCROLL_LINE_DOWN _T("linedown") // one line down/right -#define wxACTION_SCROLL_PAGE_DOWN _T("pagedown") // one page down/right +#define wxACTION_SCROLL_START wxT("start") // to the beginning +#define wxACTION_SCROLL_END wxT("end") // to the end +#define wxACTION_SCROLL_LINE_UP wxT("lineup") // one line up/left +#define wxACTION_SCROLL_PAGE_UP wxT("pageup") // one page up/left +#define wxACTION_SCROLL_LINE_DOWN wxT("linedown") // one line down/right +#define wxACTION_SCROLL_PAGE_DOWN wxT("pagedown") // one page down/right // the scrollbar thumb may be dragged -#define wxACTION_SCROLL_THUMB_DRAG _T("thumbdrag") -#define wxACTION_SCROLL_THUMB_MOVE _T("thumbmove") -#define wxACTION_SCROLL_THUMB_RELEASE _T("thumbrelease") +#define wxACTION_SCROLL_THUMB_DRAG wxT("thumbdrag") +#define wxACTION_SCROLL_THUMB_MOVE wxT("thumbmove") +#define wxACTION_SCROLL_THUMB_RELEASE wxT("thumbrelease") // ---------------------------------------------------------------------------- // wxScrollBar // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxScrollBar : public wxScrollBarBase, +class WXDLLIMPEXP_CORE wxScrollBar : public wxScrollBarBase, public wxControlWithArrows { public: @@ -96,8 +96,13 @@ public: long numArg = 0, const wxString& strArg = wxEmptyString); - // The scrollbars around a normal window should not - // receive the focus. + static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef); + virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef) + { + return GetStdInputHandler(handlerDef); + } + + // scrollbars around a normal window should not receive the focus virtual bool AcceptsFocus() const; // wxScrollBar sub elements state (combination of wxCONTROL_XXX) @@ -111,11 +116,14 @@ public: virtual int GetArrowState(wxScrollArrows::Arrow arrow) const; virtual void SetArrowFlag(wxScrollArrows::Arrow arrow, int flag, bool set); virtual bool OnArrow(wxScrollArrows::Arrow arrow); - virtual wxScrollArrows::Arrow HitTest(const wxPoint& pt) const; + virtual wxScrollArrows::Arrow HitTestArrow(const wxPoint& pt) const; // for wxControlRenderer::DrawScrollbar() only const wxScrollArrows& GetArrows() const { return m_arrows; } + // returns one of wxHT_SCROLLBAR_XXX constants + wxHitTest HitTestBar(const wxPoint& pt) const; + // idle processing virtual void OnInternalIdle(); @@ -136,6 +144,30 @@ protected: // is this scrollbar attached to a window or a standalone control? bool IsStandalone() const; + // scrollbar geometry methods: + + // gets the bounding box for a scrollbar element for the given (by default + // - current) thumb position + wxRect GetScrollbarRect(wxScrollBar::Element elem, int thumbPos = -1) const; + + // returns the size of the scrollbar shaft excluding the arrows + wxCoord GetScrollbarSize() const; + + // translate the scrollbar position (in logical units) into physical + // coordinate (in pixels) and the other way round + wxCoord ScrollbarToPixel(int thumbPos = -1); + int PixelToScrollbar(wxCoord coord); + + // return the starting and ending positions, in pixels, of the thumb of a + // scrollbar with the given logical position, thumb size and range and the + // given physical length + static void GetScrollBarThumbSize(wxCoord length, + int thumbPos, + int thumbSize, + int range, + wxCoord *thumbStart, + wxCoord *thumbEnd); + private: // total range of the scrollbar in logical units int m_range; @@ -160,16 +192,18 @@ private: // the object handling the arrows wxScrollArrows m_arrows; + friend WXDLLIMPEXP_CORE class wxControlRenderer; // for geometry methods + friend class wxStdScrollBarInputHandler; // for geometry methods + DECLARE_EVENT_TABLE() DECLARE_DYNAMIC_CLASS(wxScrollBar) }; // ---------------------------------------------------------------------------- -// common scrollbar input handler: it manages clicks on the standard scrollbar -// elements (line arrows, bar, thumb) +// Standard scrollbar input handler which can be used as a base class // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxStdScrollBarInputHandler : public wxStdInputHandler +class WXDLLIMPEXP_CORE wxStdScrollBarInputHandler : public wxStdInputHandler { public: // constructor takes a renderer (used for scrollbar hit testing) and the @@ -193,12 +227,10 @@ public: const wxControlAction& action); protected: - // the methods which must be overridden in the derived class - // return true if the mouse button can be used to activate scrollbar, false - // if not (only left mouse button can do it under Windows, any button under - // GTK+) - virtual bool IsAllowedButton(int button) = 0; + // if not (any button under GTK+ unlike left button only which is default) + virtual bool IsAllowedButton(int button) const + { return button == wxMOUSE_BTN_LEFT; } // set or clear the specified flag on the scrollbar element corresponding // to m_htLast @@ -222,6 +254,7 @@ protected: // generate a "thumb move" action for this mouse event void HandleThumbMove(wxScrollBar *scrollbar, const wxMouseEvent& event); + // the window (scrollbar) which has capture or NULL and the flag telling if // the mouse is inside the element which captured it or not wxWindow *m_winCapture;