use 6px as the default wxSizer border in wxGTK to be a little bit closer to GNOME HIG

[wxWidgets.git] / include / wx / univ / scrolbar.h

diff --git a/include/wx/univ/scrolbar.h b/include/wx/univ/scrolbar.h
index af937ebae4725f3f460eb2ba8340b43668a66810..a11cef70fee34b0de7a617edd495d228bf703cea 100644 (file)
--- a/include/wx/univ/scrolbar.h
+++ b/include/wx/univ/scrolbar.h
@@ -12,13 +12,10 @@
 #ifndef _WX_UNIV_SCROLBAR_H_
 #define _WX_UNIV_SCROLBAR_H_
 
 #ifndef _WX_UNIV_SCROLBAR_H_
 #define _WX_UNIV_SCROLBAR_H_
 

-#ifdef __GNUG__
-    #pragma interface "univscrolbar.h"
-#endif
-
-class WXDLLEXPORT wxScrollTimer;
+class WXDLLIMPEXP_FWD_CORE wxScrollTimer;

 
 #include "wx/univ/scrarrow.h"
 
 #include "wx/univ/scrarrow.h"

+#include "wx/renderer.h"

 
 // ----------------------------------------------------------------------------
 // the actions supported by this control
 
 // ----------------------------------------------------------------------------
 // the actions supported by this control


@@ -87,7 +84,7 @@ public:
     virtual void SetThumbPosition(int thumbPos);
     virtual void SetScrollbar(int position, int thumbSize,
                               int range, int pageSize,
     virtual void SetThumbPosition(int thumbPos);
     virtual void SetScrollbar(int position, int thumbSize,
                               int range, int pageSize,

-                              bool refresh = TRUE);
+                              bool refresh = true);

 
     // wxScrollBar actions
     void ScrollToStart();
 
     // wxScrollBar actions
     void ScrollToStart();


@@ -99,8 +96,13 @@ public:
                                long numArg = 0,
                                const wxString& strArg = wxEmptyString);
 
                                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)
     virtual bool AcceptsFocus() const;
 
     // wxScrollBar sub elements state (combination of wxCONTROL_XXX)


@@ -114,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 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; }
 
 
     // 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();
 
     // idle processing
     virtual void OnInternalIdle();
 


@@ -127,7 +132,7 @@ protected:
     virtual void DoDraw(wxControlRenderer *renderer);
     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
 
     virtual void DoDraw(wxControlRenderer *renderer);
     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
 

-    // forces update of thumb's visual appearence (does nothing if m_dirty=FALSE)
+    // forces update of thumb's visual appearence (does nothing if m_dirty=false)

     void UpdateThumb();
 
     // SetThumbPosition() helper
     void UpdateThumb();
 
     // SetThumbPosition() helper


@@ -139,6 +144,30 @@ protected:
     // is this scrollbar attached to a window or a standalone control?
     bool IsStandalone() const;
 
     // 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;
 private:
     // total range of the scrollbar in logical units
     int m_range;


@@ -163,13 +192,15 @@ private:
     // the object handling the arrows
     wxScrollArrows m_arrows;
 
     // the object handling the arrows
     wxScrollArrows m_arrows;
 

+    friend WXDLLEXPORT class wxControlRenderer; // for geometry methods
+    friend class wxStdScrollBarInputHandler; // for geometry methods
+

     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxScrollBar)
 };
 
 // ----------------------------------------------------------------------------
     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 WXDLLEXPORT wxStdScrollBarInputHandler : public wxStdInputHandler


@@ -191,17 +222,15 @@ public:
 
     // this method is called by wxScrollBarTimer only and may be overridden
     //
 
     // this method is called by wxScrollBarTimer only and may be overridden
     //

-    // return TRUE to continue scrolling, FALSE to stop the timer
+    // return true to continue scrolling, false to stop the timer

     virtual bool OnScrollTimer(wxScrollBar *scrollbar,
                                const wxControlAction& action);
 
 protected:
     virtual bool OnScrollTimer(wxScrollBar *scrollbar,
                                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;
+    // return true if the mouse button can be used to activate scrollbar, false
+    // 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
 
     // set or clear the specified flag on the scrollbar element corresponding
     // to m_htLast


@@ -225,6 +254,7 @@ protected:
     // generate a "thumb move" action for this mouse event
     void HandleThumbMove(wxScrollBar *scrollbar, const wxMouseEvent& event);
 
     // 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;
     // 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;