MyScrollbar Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/Scrollbar.hpp>

Inheritance diagram for MyScrollbar:

Collaboration diagram for MyScrollbar:

Public Member Functions
	MyScrollbar (wxWindow *parent, wxWindowID id, wxPoint position, wxSize size, ScrolledWindow *scrolledWindow, long direction, int scrollbarWidth, int tipLength=0)
void	SetViewStart (int start)
void	SetTipColor (wxColour color)
void	SetMarginColor (wxColour color)
void	SetScrollbarColor (wxColour color)
void	SetScrollbarTip (int len)
void	SetVirtualDim (int pixelsPerUnit, int noUnits)

Private Member Functions
void	OnPaint (wxPaintEvent &event)
void	OnSize (wxSizeEvent &WXUNUSED(event))
void	OnEraseBackground (wxEraseEvent &event)
void	OnMouseLeftDown (wxMouseEvent &event)
void	OnMouseLeftUp (wxMouseEvent &event)
void	OnMouseMove (wxMouseEvent &event)
void	OnMouseWheel (wxMouseEvent &event)

Private Attributes
long	m_direction
int	m_virtualDim
int	m_actualDim
int	m_pixelsPerUnit
int	m_viewStartInPixels
int	m_viewStartInScrollUnits
int	m_scrollbarWidth
int	m_marginWidth
int	m_previousMouse
int	m_mouseLocation
int	m_tipLength
int	m_minSliderSize
wxColour	m_tipColor
wxColour	m_marginColor
wxColour	m_scrollbarColor
ScrolledWindow *	m_scrolledWindow

Detailed Description

Constructor & Destructor Documentation

MyScrollbar()

MyScrollbar::MyScrollbar	(	wxWindow *	parent,
		wxWindowID	id,
		wxPoint	position,
		wxSize	size,
		ScrolledWindow *	scrolledWindow,
		long	direction,
		int	scrollbarWidth,
		int	tipLength = 0 )

                                                                                                                                                                          : wxPanel(parent, id, position, size)
{
  m_parent = parent;
  m_direction = direction;
  m_tipLength = tipLength;
  if (m_direction == wxVSCROLL)
    m_virtualDim = size.GetHeight();
  else
    m_virtualDim = size.GetWidth(); // default values
 
  m_actualDim = GetSize().GetHeight();
 
  m_viewStartInScrollUnits = 0;
  m_viewStartInPixels = 0;
  m_minSliderSize = 30;
 
  m_scrollbarWidth = scrollbarWidth;
    m_marginWidth    = scrollbarWidth;
 
  m_tipColor = m_parent->GetBackgroundColour(); // default value. Can be changed with SetTipColour
  m_marginColor = m_parent->GetBackgroundColour();  // default value. Can be changed with SetMarginColour
  m_scrollbarColor = wxColour(255,255,255); // default value. Can be changed with SetScrollbarColour
  m_scrolledWindow = scrolledWindow;
 
  Bind(wxEVT_PAINT, &MyScrollbar::OnPaint, this);
  Bind(wxEVT_SIZE, &MyScrollbar::OnSize, this);
  Bind(wxEVT_ERASE_BACKGROUND, &MyScrollbar::OnEraseBackground, this);
  Bind(wxEVT_LEFT_DOWN, &MyScrollbar::OnMouseLeftDown, this);
  Bind(wxEVT_LEFT_UP, &MyScrollbar::OnMouseLeftUp, this);
  Bind(wxEVT_MOTION, &MyScrollbar::OnMouseMove, this);
  Bind(wxEVT_MOUSEWHEEL, &MyScrollbar::OnMouseWheel, this);
}

References m_actualDim, m_direction, m_marginColor, m_marginWidth, m_minSliderSize, m_scrollbarColor, m_scrollbarWidth, m_scrolledWindow, m_tipColor, m_tipLength, m_viewStartInPixels, m_viewStartInScrollUnits, m_virtualDim, OnEraseBackground(), OnMouseLeftDown(), OnMouseLeftUp(), OnMouseMove(), OnMouseWheel(), OnPaint(), and OnSize().

Here is the call graph for this function:

Member Function Documentation

OnEraseBackground()

void MyScrollbar::OnEraseBackground ( wxEraseEvent & event )

private

{
  // necessary to avoid automatic background erasing
    SetBackgroundColour(wxColor(255,255,255));
}

Referenced by MyScrollbar().

Here is the caller graph for this function:

OnMouseLeftDown()

void MyScrollbar::OnMouseLeftDown ( wxMouseEvent & event )

private

{
  int scrollbarStart, scrollbarLength, eventPos ;
 
  if (m_direction == wxVSCROLL)
    eventPos = event.m_y;
  else
    eventPos = event.m_x;
 
  int actualDim = m_actualDim;
  scrollbarStart = (m_pixelsPerUnit*actualDim*m_viewStartInScrollUnits) / (float)m_virtualDim + 0.5;  // + 0.5 is a cheap way to round the float value 
  scrollbarLength = MAX((actualDim*actualDim) / (float)m_virtualDim + 0.5, m_minSliderSize);
 
  m_previousMouse = eventPos;
    /*eventPos >= scrollbarStart &&*/ 
  if (eventPos < scrollbarStart + scrollbarLength)
    m_mouseLocation = ON_SCROLLBAR;
  else
    m_mouseLocation = BEFORE_SCROLLBAR;
 
  CaptureMouse();
}

References BEFORE_SCROLLBAR, m_actualDim, m_direction, m_minSliderSize, m_mouseLocation, m_pixelsPerUnit, m_previousMouse, m_viewStartInScrollUnits, m_virtualDim, MAX, and ON_SCROLLBAR.

Referenced by MyScrollbar().

Here is the caller graph for this function:

OnMouseLeftUp()

void MyScrollbar::OnMouseLeftUp ( wxMouseEvent & event )

private

{
  if (HasCapture())
  {
    ReleaseMouse();
  }
  m_mouseLocation = NOWHERE;
}

References m_mouseLocation, and NOWHERE.

Referenced by MyScrollbar().

Here is the caller graph for this function:

OnMouseMove()

void MyScrollbar::OnMouseMove ( wxMouseEvent & event )

private

{ 
  int dMotion, actualDim; 
  if (!event.Dragging())
    return; // button is not pressed, the user doesn't scroll
 
  actualDim = m_actualDim;
 
  if (m_direction == wxVSCROLL && m_mouseLocation == ON_SCROLLBAR)
  {
    dMotion = event.m_y - m_previousMouse;
    m_viewStartInPixels += (dMotion*m_virtualDim) / (float)actualDim + 0.5; // in pixels
 
    if (m_viewStartInPixels < 0)
      m_viewStartInPixels = 0;
    else if (m_viewStartInPixels + actualDim >= m_virtualDim)
      m_viewStartInPixels = m_virtualDim - actualDim;
 
    m_viewStartInScrollUnits = m_viewStartInPixels / (float)m_pixelsPerUnit + 0.5;  // in scroll units
    m_scrolledWindow->Scroll(-1, m_viewStartInScrollUnits); // -1 means no change in this direction
    SetViewStart(m_viewStartInScrollUnits);
    m_previousMouse = event.m_y;
  }
  else if (m_direction == wxHSCROLL && m_mouseLocation == ON_SCROLLBAR)
  {
    if (m_scrolledWindow->IsBothDirections())  
      actualDim -= m_marginWidth; // must take into account the right margin
 
    dMotion = event.m_x - m_previousMouse;
    m_viewStartInPixels += (dMotion*m_virtualDim) / (float)actualDim + 0.5; // in pixels
 
    if (m_viewStartInPixels < 0)
      m_viewStartInPixels = 0;
    else if (m_viewStartInPixels + actualDim >= m_virtualDim)
      m_viewStartInPixels = m_virtualDim - actualDim;
 
    m_viewStartInScrollUnits = m_viewStartInPixels / (float)m_pixelsPerUnit + 0.5;  // in scroll units
    m_scrolledWindow->Scroll(m_viewStartInScrollUnits, -1); // -1 means no change in this direction
    SetViewStart(m_viewStartInScrollUnits);
    m_previousMouse = event.m_x;
  }
  Refresh();
  Update();
}

References m_actualDim, m_direction, m_marginWidth, m_mouseLocation, m_pixelsPerUnit, m_previousMouse, m_scrolledWindow, m_viewStartInPixels, m_viewStartInScrollUnits, m_virtualDim, ON_SCROLLBAR, and SetViewStart().

Referenced by MyScrollbar().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMouseWheel()

void MyScrollbar::OnMouseWheel ( wxMouseEvent & event )

private

{
  int dMotion, actualDim;
  if (event.GetWheelRotation() > 0)
    //dMotion = -m_pixelsPerUnit;
        dMotion = -SCROLL_D_MOTION;
  else 
    // dMotion = m_pixelsPerUnit;
        dMotion = SCROLL_D_MOTION;
    
  //m_previousMouse += dMotion;
  actualDim = m_actualDim;
 
  if (m_direction == wxVSCROLL)
  {
    m_viewStartInPixels += (dMotion*m_virtualDim) / (float)actualDim + 0.5; // in pixels
 
    if (m_viewStartInPixels < 0)
      m_viewStartInPixels = 0;
    else if (m_viewStartInPixels + actualDim >= m_virtualDim)
      m_viewStartInPixels = m_virtualDim - actualDim;
 
    m_viewStartInScrollUnits = m_viewStartInPixels / (float)m_pixelsPerUnit + 0.5;  // in scroll units
    m_scrolledWindow->Scroll(-1, m_viewStartInScrollUnits); // -1 means no change in this direction
    SetViewStart(m_viewStartInScrollUnits);
  }
  else
  {
    dMotion = -dMotion;
    if (m_scrolledWindow->IsBothDirections())
      actualDim -= m_marginWidth; // must take into account the right margin
 
    m_viewStartInPixels += (dMotion*m_virtualDim) / (float)actualDim + 0.5; // in pixels
 
    if (m_viewStartInPixels < 0)
      m_viewStartInPixels = 0;
    else if (m_viewStartInPixels + actualDim >= m_virtualDim)
      m_viewStartInPixels = m_virtualDim - actualDim;
 
    m_viewStartInScrollUnits = m_viewStartInPixels / (float)m_pixelsPerUnit + 0.5;  // in scroll units
    m_scrolledWindow->Scroll(m_viewStartInScrollUnits, -1); // -1 means no change in this direction
    SetViewStart(m_viewStartInScrollUnits);
  }
  Refresh();
  Update();
}

References m_actualDim, m_direction, m_marginWidth, m_pixelsPerUnit, m_scrolledWindow, m_viewStartInPixels, m_viewStartInScrollUnits, m_virtualDim, SCROLL_D_MOTION, and SetViewStart().

Referenced by MyScrollbar().

Here is the call graph for this function:

Here is the caller graph for this function:

OnPaint()

void MyScrollbar::OnPaint ( wxPaintEvent & event )

private

{
  int scrollbarStart, scrollbarLength, scrollbarSide;
    //wxBufferedPaintDC dc(this);
  wxClientDC dc(this);
  PrepareDC(dc);
  int actualDim = m_actualDim;
 
  //m_marginWidth = 10;
    //m_scrollbarWidth = 10;
 
  if (m_direction == wxVSCROLL && actualDim < m_virtualDim) // if actualDim >= m_virtualDim, the scrollbar is hidden, no need to paint it
  {
    scrollbarSide = (m_marginWidth - m_scrollbarWidth) / 2;
    scrollbarStart = (m_pixelsPerUnit*actualDim*m_viewStartInScrollUnits) / (float)m_virtualDim + 0.5;  // + 0.5 is a cheap way to round the float value 
    scrollbarLength = (actualDim*actualDim) / (float)m_virtualDim + 0.5;
 
    if (scrollbarLength < m_minSliderSize)
    {
      scrollbarStart = (actualDim - m_minSliderSize)*(m_viewStartInScrollUnits*m_pixelsPerUnit / (float)(m_virtualDim - actualDim)) + 0.5;
      scrollbarLength = m_minSliderSize;
    }
 
    if (scrollbarStart < 0) // the mouse is out of the panel
      scrollbarStart = 0;
    else if (scrollbarStart + scrollbarLength >= actualDim)
      scrollbarStart = actualDim - scrollbarLength;
 
    // draw the upper and lower tips
    dc.SetPen(m_tipColor);
    dc.SetBrush(m_tipColor);
    dc.DrawRectangle(scrollbarSide, 0, m_scrollbarWidth, m_tipLength);  // upper tip 
    dc.DrawRectangle(scrollbarSide, actualDim - m_tipLength, m_scrollbarWidth, m_tipLength);  // lower tip 
 
    // draw the margins
    dc.SetPen(m_marginColor);
    dc.SetBrush(m_marginColor);
    dc.DrawRectangle(scrollbarSide, m_tipLength, m_scrollbarWidth, scrollbarStart + m_tipLength); // above the scrollbar 
    dc.DrawRectangle(scrollbarSide, scrollbarStart + scrollbarLength - m_tipLength, m_scrollbarWidth, actualDim - scrollbarLength - scrollbarStart);  // below the scrollbar 
    dc.DrawRectangle(0, 0, scrollbarSide, actualDim); // left side of the scrollbar 
    dc.DrawRectangle(m_marginWidth - scrollbarSide, 0, scrollbarSide, actualDim); // right side of the scrollbar 
 
    // draw the scrollbar
    dc.SetPen(m_scrollbarColor);
    dc.SetBrush(m_scrollbarColor);
        dc.DrawRectangle(scrollbarSide, scrollbarStart + m_tipLength, m_scrollbarWidth, scrollbarLength - 2 * m_tipLength);  
  }
  else if (m_direction == wxHSCROLL && actualDim < m_virtualDim)  // if actualDim >= m_virtualDim, the scrollbar is hidden, no need to paint it
  {
    if (m_scrolledWindow->IsBothDirections())
      actualDim -= m_marginWidth; // must take into account the right margin
 
    scrollbarSide = (m_marginWidth - m_scrollbarWidth) / 2;
    scrollbarStart = (m_pixelsPerUnit*actualDim*m_viewStartInScrollUnits) / (float)m_virtualDim + 0.5;  // + 0.5 is a cheap way round the float value 
    scrollbarLength = (actualDim*actualDim) / (float)m_virtualDim + 0.5;
 
    if (scrollbarLength < m_minSliderSize)
    {
      scrollbarStart = (actualDim - m_minSliderSize)*(m_viewStartInScrollUnits*m_pixelsPerUnit / (float)(m_virtualDim - actualDim)) + 0.5;
      scrollbarLength = m_minSliderSize;
    }
 
    if (scrollbarStart < 0) // the mouse is out of the panel
      scrollbarStart = 0;
    else if (scrollbarStart + scrollbarLength >= actualDim)
      scrollbarStart = actualDim - scrollbarLength;
 
    // draw the left and right tips
    dc.SetPen(m_tipColor);
    dc.SetBrush(m_tipColor);
    dc.DrawRectangle(0, scrollbarSide, m_tipLength, m_scrollbarWidth);  // left tip 
    dc.DrawRectangle(actualDim - m_tipLength, scrollbarSide, m_tipLength, m_scrollbarWidth);  // right tip 
 
    // draw the margins
    dc.SetPen(m_marginColor);
    dc.SetBrush(m_marginColor);
    dc.DrawRectangle(m_tipLength, scrollbarSide, scrollbarStart + m_tipLength, m_scrollbarWidth); // left of the scrollbar 
    dc.DrawRectangle(scrollbarStart + scrollbarLength - m_tipLength, scrollbarSide, actualDim - scrollbarLength - scrollbarStart, m_scrollbarWidth);  // right of the scrollbar 
    dc.DrawRectangle(0, 0, actualDim, scrollbarSide); // above the scrollbar 
    dc.DrawRectangle(0, m_marginWidth - scrollbarSide, actualDim, scrollbarSide); // below the scrollbar 
    dc.DrawRectangle(actualDim, 0, m_marginWidth, m_marginWidth); // lower right corner of the scrolled window   
 
    // draw the scrollbar
    dc.SetPen(m_scrollbarColor);
    dc.SetBrush(m_scrollbarColor);
    dc.DrawRectangle(scrollbarStart + m_tipLength, scrollbarSide, scrollbarLength - 2 * m_tipLength, m_scrollbarWidth);
  }
}

References m_actualDim, m_direction, m_marginColor, m_marginWidth, m_minSliderSize, m_pixelsPerUnit, m_scrollbarColor, m_scrollbarWidth, m_scrolledWindow, m_tipColor, m_tipLength, m_viewStartInScrollUnits, and m_virtualDim.

Referenced by MyScrollbar().

Here is the caller graph for this function:

OnSize()

void MyScrollbar::OnSize ( wxSizeEvent & WXUNUSEDevent )

private

{
  if (m_direction == wxVSCROLL)
  {
    m_actualDim = GetSize().GetHeight();
    if (m_actualDim < m_virtualDim)
      m_marginWidth = GetSize().GetWidth(); 
    else
      m_marginWidth = 0;
  }
  else
  {
    m_actualDim = GetSize().GetWidth();
    if (m_actualDim < m_virtualDim)
      m_marginWidth = GetSize().GetHeight();
    else
      m_marginWidth = 0;
  }
}

References m_actualDim, m_direction, m_marginWidth, and m_virtualDim.

Referenced by MyScrollbar().

Here is the caller graph for this function:

SetMarginColor()

void MyScrollbar::SetMarginColor

(

wxColour

color

)

{
  m_marginColor = color;
}

References m_marginColor.

SetScrollbarColor()

void MyScrollbar::SetScrollbarColor

(

wxColour

color

)

{
  m_scrollbarColor = color;
}

References m_scrollbarColor.

SetScrollbarTip()

void MyScrollbar::SetScrollbarTip

(

int

len

)

{
  m_tipLength = len ;
}

References m_tipLength.

SetTipColor()

void MyScrollbar::SetTipColor

(

wxColour

color

)

{
  m_tipColor = color;
}

References m_tipColor.

SetViewStart()

void MyScrollbar::SetViewStart

(

int

start

)

{
  m_viewStartInScrollUnits = start;
    m_viewStartInPixels      = start;
}

References m_viewStartInPixels, and m_viewStartInScrollUnits.

Referenced by OnMouseMove(), and OnMouseWheel().

Here is the caller graph for this function:

SetVirtualDim()

void MyScrollbar::SetVirtualDim	(	int	pixelsPerUnit,
		int	noUnits )

{
  m_virtualDim = pixelsPerUnit* noUnits;
  m_pixelsPerUnit = pixelsPerUnit;
  Refresh();
}

References m_pixelsPerUnit, and m_virtualDim.

Member Data Documentation

m_actualDim

int MyScrollbar::m_actualDim

private

Referenced by MyScrollbar(), OnMouseLeftDown(), OnMouseMove(), OnMouseWheel(), OnPaint(), and OnSize().

m_direction

long MyScrollbar::m_direction

private

Referenced by MyScrollbar(), OnMouseLeftDown(), OnMouseMove(), OnMouseWheel(), OnPaint(), and OnSize().

m_marginColor

wxColour MyScrollbar::m_marginColor

private

Referenced by MyScrollbar(), OnPaint(), and SetMarginColor().

m_marginWidth

int MyScrollbar::m_marginWidth

private

Referenced by MyScrollbar(), OnMouseMove(), OnMouseWheel(), OnPaint(), and OnSize().

m_minSliderSize

int MyScrollbar::m_minSliderSize

private

Referenced by MyScrollbar(), OnMouseLeftDown(), and OnPaint().

m_mouseLocation

int MyScrollbar::m_mouseLocation

private

Referenced by OnMouseLeftDown(), OnMouseLeftUp(), and OnMouseMove().

m_pixelsPerUnit

int MyScrollbar::m_pixelsPerUnit

private

Referenced by OnMouseLeftDown(), OnMouseMove(), OnMouseWheel(), OnPaint(), and SetVirtualDim().

m_previousMouse

int MyScrollbar::m_previousMouse

private

Referenced by OnMouseLeftDown(), and OnMouseMove().

m_scrollbarColor

wxColour MyScrollbar::m_scrollbarColor

private

Referenced by MyScrollbar(), OnPaint(), and SetScrollbarColor().

m_scrollbarWidth

int MyScrollbar::m_scrollbarWidth

private

Referenced by MyScrollbar(), and OnPaint().

m_scrolledWindow

ScrolledWindow* MyScrollbar::m_scrolledWindow

private

Referenced by MyScrollbar(), OnMouseMove(), OnMouseWheel(), and OnPaint().

m_tipColor

wxColour MyScrollbar::m_tipColor

private

Referenced by MyScrollbar(), OnPaint(), and SetTipColor().

m_tipLength

int MyScrollbar::m_tipLength

private

Referenced by MyScrollbar(), OnPaint(), and SetScrollbarTip().

m_viewStartInPixels

int MyScrollbar::m_viewStartInPixels

private

Referenced by MyScrollbar(), OnMouseMove(), OnMouseWheel(), and SetViewStart().

m_viewStartInScrollUnits

int MyScrollbar::m_viewStartInScrollUnits

private

Referenced by MyScrollbar(), OnMouseLeftDown(), OnMouseMove(), OnMouseWheel(), OnPaint(), and SetViewStart().

m_virtualDim

int MyScrollbar::m_virtualDim

private

Referenced by MyScrollbar(), OnMouseLeftDown(), OnMouseMove(), OnMouseWheel(), OnPaint(), OnSize(), and SetVirtualDim().

---

The documentation for this class was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/Scrollbar.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/Scrollbar.cpp