a0580b361e
This warning was given many times and was very confusing as it wasn't given at all in the right location, but rather for all the other, subsequent declarations of wxControlRenderer which were correct -- unlike this one which used wrong order for the "class" keyword and the attribute.
283 lines
11 KiB
C++
283 lines
11 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/univ/scrolbar.h
|
|
// Purpose: wxScrollBar for wxUniversal
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 20.08.00
|
|
// Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_UNIV_SCROLBAR_H_
|
|
#define _WX_UNIV_SCROLBAR_H_
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxScrollTimer;
|
|
|
|
#include "wx/univ/scrarrow.h"
|
|
#include "wx/renderer.h"
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// the actions supported by this control
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// scroll the bar
|
|
#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 wxT("thumbdrag")
|
|
#define wxACTION_SCROLL_THUMB_MOVE wxT("thumbmove")
|
|
#define wxACTION_SCROLL_THUMB_RELEASE wxT("thumbrelease")
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxScrollBar
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxScrollBar : public wxScrollBarBase,
|
|
public wxControlWithArrows
|
|
{
|
|
public:
|
|
// scrollbar elements: they correspond to wxHT_SCROLLBAR_XXX constants but
|
|
// start from 0 which allows to use them as array indices
|
|
enum Element
|
|
{
|
|
Element_Arrow_Line_1,
|
|
Element_Arrow_Line_2,
|
|
Element_Arrow_Page_1,
|
|
Element_Arrow_Page_2,
|
|
Element_Thumb,
|
|
Element_Bar_1,
|
|
Element_Bar_2,
|
|
Element_Max
|
|
};
|
|
|
|
wxScrollBar();
|
|
wxScrollBar(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSB_HORIZONTAL,
|
|
const wxValidator& validator = wxDefaultValidator,
|
|
const wxString& name = wxScrollBarNameStr);
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSB_HORIZONTAL,
|
|
const wxValidator& validator = wxDefaultValidator,
|
|
const wxString& name = wxScrollBarNameStr);
|
|
|
|
virtual ~wxScrollBar();
|
|
|
|
// implement base class pure virtuals
|
|
virtual int GetThumbPosition() const wxOVERRIDE;
|
|
virtual int GetThumbSize() const wxOVERRIDE;
|
|
virtual int GetPageSize() const wxOVERRIDE;
|
|
virtual int GetRange() const wxOVERRIDE;
|
|
|
|
virtual void SetThumbPosition(int thumbPos) wxOVERRIDE;
|
|
virtual void SetScrollbar(int position, int thumbSize,
|
|
int range, int pageSize,
|
|
bool refresh = true) wxOVERRIDE;
|
|
|
|
// wxScrollBar actions
|
|
void ScrollToStart();
|
|
void ScrollToEnd();
|
|
bool ScrollLines(int nLines) wxOVERRIDE;
|
|
bool ScrollPages(int nPages) wxOVERRIDE;
|
|
|
|
virtual bool PerformAction(const wxControlAction& action,
|
|
long numArg = 0,
|
|
const wxString& strArg = wxEmptyString) wxOVERRIDE;
|
|
|
|
static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
|
|
virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef) wxOVERRIDE
|
|
{
|
|
return GetStdInputHandler(handlerDef);
|
|
}
|
|
|
|
// scrollbars around a normal window should not receive the focus
|
|
virtual bool AcceptsFocus() const wxOVERRIDE;
|
|
|
|
// wxScrollBar sub elements state (combination of wxCONTROL_XXX)
|
|
void SetState(Element which, int flags);
|
|
int GetState(Element which) const;
|
|
|
|
// implement wxControlWithArrows methods
|
|
virtual wxRenderer *GetRenderer() const wxOVERRIDE { return m_renderer; }
|
|
virtual wxWindow *GetWindow() wxOVERRIDE { return this; }
|
|
virtual bool IsVertical() const wxOVERRIDE { return wxScrollBarBase::IsVertical(); }
|
|
virtual int GetArrowState(wxScrollArrows::Arrow arrow) const wxOVERRIDE;
|
|
virtual void SetArrowFlag(wxScrollArrows::Arrow arrow, int flag, bool set) wxOVERRIDE;
|
|
virtual bool OnArrow(wxScrollArrows::Arrow arrow) wxOVERRIDE;
|
|
virtual wxScrollArrows::Arrow HitTestArrow(const wxPoint& pt) const wxOVERRIDE;
|
|
|
|
// 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() wxOVERRIDE;
|
|
|
|
protected:
|
|
virtual wxSize DoGetBestClientSize() const wxOVERRIDE;
|
|
virtual void DoDraw(wxControlRenderer *renderer) wxOVERRIDE;
|
|
virtual wxBorder GetDefaultBorder() const wxOVERRIDE { return wxBORDER_NONE; }
|
|
|
|
// forces update of thumb's visual appearence (does nothing if m_dirty=false)
|
|
void UpdateThumb();
|
|
|
|
// SetThumbPosition() helper
|
|
void DoSetThumb(int thumbPos);
|
|
|
|
// common part of all ctors
|
|
void Init();
|
|
|
|
// 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;
|
|
|
|
// the current and previous (after last refresh - this is used for
|
|
// repainting optimisation) size of the thumb in logical units (from 0 to
|
|
// m_range) and its position (from 0 to m_range - m_thumbSize)
|
|
int m_thumbSize,
|
|
m_thumbPos,
|
|
m_thumbPosOld;
|
|
|
|
// the page size, i.e. the number of lines by which to scroll when page
|
|
// up/down action is performed
|
|
int m_pageSize;
|
|
|
|
// the state of the sub elements
|
|
int m_elementsState[Element_Max];
|
|
|
|
// the dirty flag: if set, scrollbar must be updated
|
|
bool m_dirty;
|
|
|
|
// the object handling the arrows
|
|
wxScrollArrows m_arrows;
|
|
|
|
friend class WXDLLIMPEXP_FWD_CORE wxControlRenderer; // for geometry methods
|
|
friend class wxStdScrollBarInputHandler; // for geometry methods
|
|
|
|
wxDECLARE_EVENT_TABLE();
|
|
wxDECLARE_DYNAMIC_CLASS(wxScrollBar);
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// Standard scrollbar input handler which can be used as a base class
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxStdScrollBarInputHandler : public wxStdInputHandler
|
|
{
|
|
public:
|
|
// constructor takes a renderer (used for scrollbar hit testing) and the
|
|
// base handler to which all unhandled events are forwarded
|
|
wxStdScrollBarInputHandler(wxRenderer *renderer,
|
|
wxInputHandler *inphand);
|
|
|
|
virtual bool HandleKey(wxInputConsumer *consumer,
|
|
const wxKeyEvent& event,
|
|
bool pressed) wxOVERRIDE;
|
|
virtual bool HandleMouse(wxInputConsumer *consumer,
|
|
const wxMouseEvent& event) wxOVERRIDE;
|
|
virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event) wxOVERRIDE;
|
|
|
|
virtual ~wxStdScrollBarInputHandler();
|
|
|
|
// this method is called by wxScrollBarTimer only and may be overridden
|
|
//
|
|
// return true to continue scrolling, false to stop the timer
|
|
virtual bool OnScrollTimer(wxScrollBar *scrollbar,
|
|
const wxControlAction& action);
|
|
|
|
protected:
|
|
// 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
|
|
void SetElementState(wxScrollBar *scrollbar, int flag, bool doIt);
|
|
|
|
// [un]highlight the scrollbar element corresponding to m_htLast
|
|
virtual void Highlight(wxScrollBar *scrollbar, bool doIt)
|
|
{ SetElementState(scrollbar, wxCONTROL_CURRENT, doIt); }
|
|
|
|
// [un]press the scrollbar element corresponding to m_htLast
|
|
virtual void Press(wxScrollBar *scrollbar, bool doIt)
|
|
{ SetElementState(scrollbar, wxCONTROL_PRESSED, doIt); }
|
|
|
|
// stop scrolling because we reached the end point
|
|
void StopScrolling(wxScrollBar *scrollbar);
|
|
|
|
// get the mouse coordinates in the scrollbar direction from the event
|
|
wxCoord GetMouseCoord(const wxScrollBar *scrollbar,
|
|
const wxMouseEvent& event) const;
|
|
|
|
// 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;
|
|
bool m_winHasMouse;
|
|
int m_btnCapture; // the mouse button which has captured mouse
|
|
|
|
// the position where we started scrolling by page
|
|
wxPoint m_ptStartScrolling;
|
|
|
|
// one of wxHT_SCROLLBAR_XXX value: where has the mouse been last time?
|
|
wxHitTest m_htLast;
|
|
|
|
// the renderer (we use it only for hit testing)
|
|
wxRenderer *m_renderer;
|
|
|
|
// the offset of the top/left of the scrollbar relative to the mouse to
|
|
// keep during the thumb drag
|
|
int m_ofsMouse;
|
|
|
|
// the timer for generating scroll events when the mouse stays pressed on
|
|
// a scrollbar
|
|
wxScrollTimer *m_timerScroll;
|
|
};
|
|
|
|
#endif // _WX_UNIV_SCROLBAR_H_
|
|
|