#include <scrollarea.h>

Inheritance diagram for ScrollArea:

Public Types
enum	ScrollPolicy { SHOW_ALWAYS = 0 , SHOW_NEVER , SHOW_AUTO }

Public Member Functions
	ScrollArea (Widget2 const widget2, Widget const widget, const Opaque opaque, const std::string &skin)

	~ScrollArea ()

void	logic ()

void	updateAlpha ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	drawFrame (Graphics *const graphics)

void	safeDrawFrame (Graphics *const graphics)

void	setOpaque (Opaque opaque)

bool	isOpaque () const

void	mouseMoved (MouseEvent &event)

void	mouseEntered (MouseEvent &event)

void	mouseExited (MouseEvent &event)

void	mousePressed (MouseEvent &event)

void	mouseReleased (MouseEvent &event)

void	mouseDragged (MouseEvent &event)

void	widgetResized (const Event &event)

void	widgetMoved (const Event &event)

Rect	getVerticalBarDimension () const

Rect	getHorizontalBarDimension () const

Rect	getVerticalMarkerDimension ()

Rect	getHorizontalMarkerDimension ()

Rect	getUpButtonDimension () const

Rect	getDownButtonDimension () const

Rect	getLeftButtonDimension () const

Rect	getRightButtonDimension () const

void	setContent (Widget *widget)

Widget *	getContent ()

void	setHorizontalScrollPolicy (const ScrollPolicy hPolicy)

ScrollPolicy	getHorizontalScrollPolicy () const

void	setVerticalScrollPolicy (const ScrollPolicy vPolicy)

ScrollPolicy	getVerticalScrollPolicy () const

void	setScrollPolicy (const ScrollPolicy hPolicy, const ScrollPolicy vPolicy)

void	setVerticalScrollAmount (const int vScroll)

int	getVerticalScrollAmount () const

void	setHorizontalScrollAmount (int hScroll)

int	getHorizontalScrollAmount () const

void	setScrollAmount (const int hScroll, const int vScroll)

int	getHorizontalMaxScroll ()

int	getVerticalMaxScroll ()

void	setScrollbarWidth (const int width)

int	getScrollbarWidth () const

void	setLeftButtonScrollAmount (const int amount)

void	setRightButtonScrollAmount (const int amount)

void	setUpButtonScrollAmount (const int amount)

void	setDownButtonScrollAmount (const int amount)

int	getLeftButtonScrollAmount () const

int	getRightButtonScrollAmount () const

int	getUpButtonScrollAmount () const

int	getDownButtonScrollAmount () const

void	showWidgetPart (Widget *const widget, const Rect &area)

Rect	getChildrenArea ()

Widget *	getWidgetAt (int x, int y)

void	setWidth (int width)

void	setHeight (int height)

void	setDimension (const Rect &dimension)

void	mouseWheelMovedUp (MouseEvent &event)

void	mouseWheelMovedDown (MouseEvent &event)

bool	isSelectable () const

Public Member Functions inherited from BasicContainer
	BasicContainer (const Widget2 *const widget)

	~BasicContainer ()

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

void	focusNext ()

void	focusPrevious ()

void	setFocusHandler (FocusHandler *const focusHandler)

void	setInternalFocusHandler (FocusHandler *const focusHandler)

void	death (const Event &event)

Widget *	findFirstWidget (const std::set< Widget * > &list)

void	add (Widget *const widget)

virtual void	remove (Widget *const widget)

virtual void	clear ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseClicked (MouseEvent &event)

Public Member Functions inherited from WidgetListener
virtual	~WidgetListener ()

virtual void	widgetHidden (const Event &event)

virtual void	widgetShown (const Event &event)

Protected Types
enum	BUTTON_DIR { UP = 0 , DOWN , LEFT , RIGHT , BUTTONS_DIR }

Protected Types inherited from BasicContainer
typedef std::vector< Widget * >	WidgetList

typedef WidgetList::iterator	WidgetListIterator

typedef WidgetList::const_iterator	WidgetListConstIterator

typedef WidgetList::reverse_iterator	WidgetListReverseIterator

typedef WidgetList::const_reverse_iterator	WidgetListCReverseIterator

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Member Functions
void	init (std::string skinName)

void	checkPolicies ()

void	drawButton (Graphics *const graphics, const BUTTON_DIR dir)

void	calcButton (Graphics *const graphics, const BUTTON_DIR dir)

void	drawVBar (Graphics *const graphics) const

void	drawHBar (Graphics *const graphics) const

void	drawVMarker (Graphics *const graphics)

void	drawHMarker (Graphics *const graphics)

void	calcVBar (const Graphics *const graphics)

void	calcHBar (const Graphics *const graphics)

void	calcVMarker (Graphics *const graphics)

void	calcHMarker (Graphics *const graphics)

Image *	getImageByState (Rect &dim, const BUTTON_DIR dir)

void	updateCalcFlag (const Graphics *const graphics)

Protected Member Functions inherited from BasicContainer
virtual void	drawChildren (Graphics *const graphics)

virtual void	safeDrawChildren (Graphics *const graphics)

virtual void	logicChildren ()

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from WidgetDeathListener
	WidgetDeathListener ()

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Protected Attributes
ImageCollection *	mVertexes

ImageCollection *	mVertexes2

ScrollPolicy	mHPolicy

ScrollPolicy	mVPolicy

int	mVScroll

int	mHScroll

int	mScrollbarWidth

int	mUpButtonScrollAmount

int	mDownButtonScrollAmount

int	mLeftButtonScrollAmount

int	mRightButtonScrollAmount

int	mHorizontalMarkerDragOffset

int	mVerticalMarkerDragOffset

int	mX

int	mY

int	mClickX

int	mClickY

int	mXOffset

int	mYOffset

int	mDrawWidth

int	mDrawHeight

bool	mVBarVisible

bool	mHBarVisible

bool	mUpButtonPressed

bool	mDownButtonPressed

bool	mLeftButtonPressed

bool	mRightButtonPressed

bool	mIsVerticalMarkerDragged

bool	mIsHorizontalMarkerDragged

Opaque	mOpaque

bool	mHasMouse

Protected Attributes inherited from BasicContainer
WidgetList	mWidgets

WidgetList	mLogicWidgets

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes
static int	instances = 0

static float	mAlpha = 1.0

static bool	mShowButtons = true

static int	mMarkerSize = 0

static int	mScrollbarSize = 12

static ImageRect	background

static ImageRect	vMarker

static ImageRect	vMarkerHi

static ImageRect	vBackground

static ImageRect	hBackground

static Image *	buttons [4][2]

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Detailed Description

A scroll area.

Contrary to Guichan's scroll area, this scroll area takes ownership over its content. However, it won't delete a previously set content widget when setContent is called!

Definition at line 91 of file scrollarea.h.

Member Enumeration Documentation

◆ BUTTON_DIR

enum ScrollArea::BUTTON_DIR

protected

Enumerator
UP
DOWN
LEFT
RIGHT
BUTTONS_DIR

Definition at line 434 of file scrollarea.h.

         {
             UP = 0,
             DOWN,
             LEFT,
             RIGHT,
             BUTTONS_DIR
         };

◆ ScrollPolicy

enum ScrollArea::ScrollPolicy

Scrollpolicies for the horizontal and vertical scrollbar. The policies are:

SHOW_ALWAYS - Always show the scrollbars no matter what. SHOW_NEVER - Never show the scrollbars no matter waht. SHOW_AUTO - Show the scrollbars only when needed. That is if the content grows larger then the ScrollArea.

Enumerator
SHOW_ALWAYS
SHOW_NEVER
SHOW_AUTO

Definition at line 105 of file scrollarea.h.

         {
             SHOW_ALWAYS = 0,
             SHOW_NEVER,
             SHOW_AUTO
         };

Constructor & Destructor Documentation

◆ ScrollArea()

ScrollArea::ScrollArea	(	Widget2 *const	widget2,
		Widget *const	widget,
		const Opaque	opaque,
		const std::string &	skin
	)

Definition at line 105 of file scrollarea.cpp.

                                               :
     BasicContainer(widget2),
     MouseListener(),
     WidgetListener(),
     mVertexes(new ImageCollection),
     mVertexes2(new ImageCollection),
     mHPolicy(SHOW_AUTO),
     mVPolicy(SHOW_AUTO),
     mVScroll(0),
     mHScroll(0),
     mScrollbarWidth(12),
     mUpButtonScrollAmount(10),
     mDownButtonScrollAmount(10),
     mLeftButtonScrollAmount(10),
     mRightButtonScrollAmount(10),
     mHorizontalMarkerDragOffset(0),
     mVerticalMarkerDragOffset(0),
     mX(0),
     mY(0),
     mClickX(0),
     mClickY(0),
     mXOffset(0),
     mYOffset(0),
     mDrawWidth(0),
     mDrawHeight(0),
     mVBarVisible(false),
     mHBarVisible(false),
     mUpButtonPressed(false),
     mDownButtonPressed(false),
     mLeftButtonPressed(false),
     mRightButtonPressed(false),
     mIsVerticalMarkerDragged(false),
     mIsHorizontalMarkerDragged(false),
     mOpaque(Opaque_true),
     mHasMouse(false)
 {
     setContent(widget);
     addMouseListener(this);
     mOpaque = opaque;
     init(skin);
 }

References Widget::addMouseListener(), init(), mOpaque, and setContent().

◆ ~ScrollArea()

ScrollArea::~ScrollArea ( )

Destructor. Also deletes the content.

Definition at line 150 of file scrollarea.cpp.

 {
     if (gui != nullptr)
         gui->removeDragged(this);
  
     // Garbage collection
     delete getContent();
  
     instances--;
     if (instances == 0)
     {
         Theme::unloadRect(background, 0, 8);
         Theme::unloadRect(vMarker, 0, 8);
         Theme::unloadRect(vMarkerHi, 0, 8);
         Theme::unloadRect(vBackground, 0, 8);
         Theme::unloadRect(hBackground, 0, 8);
         for (int i = 0; i < 2; i ++)
         {
             for (int f = UP; f < BUTTONS_DIR; f ++)
             {
                 if (buttons[f][i] != nullptr)
                     buttons[f][i]->decRef();
             }
         }
     }
  
     delete2(mVertexes)
     delete2(mVertexes2)
  
     setContent(nullptr);
 }

References background, buttons, BUTTONS_DIR, delete2, getContent(), gui, hBackground, instances, mVertexes, mVertexes2, Gui::removeDragged(), setContent(), Theme::unloadRect(), UP, vBackground, vMarker, and vMarkerHi.

Member Function Documentation

◆ calcButton()

void ScrollArea::calcButton	(	Graphics *const	graphics,
		const BUTTON_DIR	dir
	)

protected

Definition at line 544 of file scrollarea.cpp.

 {
     Rect dim;
     const Image *const image = getImageByState(dim, dir);
  
     if (image != nullptr)
     {
         static_cast<Graphics*>(graphics)->calcTileCollection(
             mVertexes, image, dim.x, dim.y);
     }
 }

References calcTileCollection(), getImageByState(), mVertexes, Rect::x, and Rect::y.

Referenced by draw().

◆ calcHBar()

void ScrollArea::calcHBar ( const Graphics *const graphics )

protected

Definition at line 635 of file scrollarea.cpp.

 {
     const Rect &dim = getHorizontalBarDimension();
  
     if (hBackground.grid[4] != nullptr)
     {
         graphics->calcPattern(mVertexes,
             hBackground.grid[4],
             dim.x, dim.y,
             dim.width, dim.height);
     }
  
     if (hBackground.grid[3] != nullptr)
     {
         graphics->calcPattern(mVertexes,
             hBackground.grid[3],
             dim.x, dim.y,
             hBackground.grid[3]->getWidth(), dim.height);
     }
  
     if (hBackground.grid[5] != nullptr)
     {
         graphics->calcPattern(mVertexes,
             hBackground.grid[5],
             dim.x + dim.width - hBackground.grid[5]->getWidth(),
             dim.y,
             hBackground.grid[5]->getWidth(),
             dim.height);
     }
 }

References Graphics::calcPattern(), getHorizontalBarDimension(), ImageRect::grid, hBackground, Rect::height, mVertexes, Rect::width, Rect::x, and Rect::y.

Referenced by draw().

◆ calcHMarker()

void ScrollArea::calcHMarker ( Graphics *const graphics )

protected

Definition at line 723 of file scrollarea.cpp.

 {
     const Rect dim = getHorizontalMarkerDimension();
  
     if ((mHasMouse) && (mY > (mDimension.height - mScrollbarWidth)))
     {
         graphics->calcWindow(mVertexes,
             dim.x, dim.y,
             dim.width, dim.height,
             vMarkerHi);
     }
     else
     {
         graphics->calcWindow(mVertexes,
             dim.x, dim.y,
             dim.width, dim.height,
             vMarker);
     }
 }

References Graphics::calcWindow(), getHorizontalMarkerDimension(), Rect::height, Widget::mDimension, mHasMouse, mScrollbarWidth, mVertexes, mY, vMarker, vMarkerHi, Rect::width, Rect::x, and Rect::y.

Referenced by draw().

◆ calcVBar()

void ScrollArea::calcVBar ( const Graphics *const graphics )

protected

Definition at line 580 of file scrollarea.cpp.

 {
     const Rect &dim = getVerticalBarDimension();
  
     if (vBackground.grid[4] != nullptr)
     {
         graphics->calcPattern(mVertexes,
             vBackground.grid[4],
             dim.x, dim.y,
             dim.width, dim.height);
     }
     if (vBackground.grid[1] != nullptr)
     {
         graphics->calcPattern(mVertexes,
             vBackground.grid[1],
             dim.x, dim.y,
             dim.width, vBackground.grid[1]->getHeight());
     }
     if (vBackground.grid[7] != nullptr)
     {
         graphics->calcPattern(mVertexes,
             vBackground.grid[7],
             dim.x, dim.height - vBackground.grid[7]->getHeight() + dim.y,
             dim.width, vBackground.grid[7]->getHeight());
     }
 }

References Graphics::calcPattern(), getVerticalBarDimension(), ImageRect::grid, Rect::height, mVertexes, vBackground, Rect::width, Rect::x, and Rect::y.

Referenced by draw().

◆ calcVMarker()

void ScrollArea::calcVMarker ( Graphics *const graphics )

protected

Definition at line 684 of file scrollarea.cpp.

 {
     const Rect &dim = getVerticalMarkerDimension();
  
     if ((mHasMouse) && (mX > (mDimension.width - mScrollbarWidth)))
     {
         graphics->calcWindow(mVertexes,
             dim.x, dim.y,
             dim.width, dim.height,
             vMarkerHi);
     }
     else
     {
         graphics->calcWindow(mVertexes,
             dim.x, dim.y,
             dim.width, dim.height,
             vMarker);
     }
 }

References Graphics::calcWindow(), getVerticalMarkerDimension(), Rect::height, Widget::mDimension, mHasMouse, mScrollbarWidth, mVertexes, mX, vMarker, vMarkerHi, Rect::width, Rect::x, and Rect::y.

Referenced by draw().

◆ checkPolicies()

void ScrollArea::checkPolicies ( )

protected

Checks the policies for the scroll bars.

Definition at line 1382 of file scrollarea.cpp.

 {
     const int w = getWidth();
     const int h = getHeight();
  
     mHBarVisible = false;
     mVBarVisible = false;
  
     const Widget *const content = getContent();
     if (content == nullptr)
     {
         mHBarVisible = (mHPolicy == SHOW_ALWAYS);
         mVBarVisible = (mVPolicy == SHOW_ALWAYS);
         return;
     }
  
     if (mHPolicy == SHOW_AUTO &&
         mVPolicy == SHOW_AUTO)
     {
         if (content->getWidth() <= w
             && content->getHeight() <= h)
         {
             mHBarVisible = false;
             mVBarVisible = false;
         }
  
         if (content->getWidth() > w)
         {
             mHBarVisible = true;
         }
  
         if ((content->getHeight() > h)
             || (mHBarVisible && content->getHeight()
             > h - mScrollbarWidth))
         {
             mVBarVisible = true;
         }
  
         if (mVBarVisible && content->getWidth() > w - mScrollbarWidth)
             mHBarVisible = true;
  
         return;
     }
  
     switch (mHPolicy)
     {
         case SHOW_NEVER:
             mHBarVisible = false;
             break;
  
         case SHOW_ALWAYS:
             mHBarVisible = true;
             break;
  
         case SHOW_AUTO:
             if (mVPolicy == SHOW_NEVER)
             {
                 mHBarVisible = (content->getWidth() > w);
             }
             else  // (mVPolicy == SHOW_ALWAYS)
             {
                 mHBarVisible = (content->getWidth()
                     > w - mScrollbarWidth);
             }
             break;
  
         default:
             break;
     }
  
     switch (mVPolicy)
     {
         case SHOW_NEVER:
             mVBarVisible = false;
             break;
  
         case SHOW_ALWAYS:
             mVBarVisible = true;
             break;
  
         case SHOW_AUTO:
             if (mHPolicy == SHOW_NEVER)
             {
                 mVBarVisible = (content->getHeight() > h);
             }
             else  // (mHPolicy == SHOW_ALWAYS)
             {
                 mVBarVisible = (content->getHeight()
                     > h - mScrollbarWidth);
             }
             break;
         default:
             break;
     }
 }

References getContent(), Widget::getHeight(), Widget::getWidth(), mHBarVisible, mHPolicy, mScrollbarWidth, mVBarVisible, mVPolicy, SHOW_ALWAYS, SHOW_AUTO, and SHOW_NEVER.

Referenced by getHorizontalMaxScroll(), getVerticalMaxScroll(), logic(), setContent(), setDimension(), setHeight(), setHorizontalScrollPolicy(), setScrollPolicy(), setVerticalScrollPolicy(), and setWidth().

◆ draw()

void ScrollArea::draw ( Graphics *const graphics )

virtual

Draws the scroll area.

Implements Widget.

Definition at line 344 of file scrollarea.cpp.

 {
     BLOCK_START("ScrollArea::draw")
     if (mVBarVisible || mHBarVisible)
     {
         if (mOpaque == Opaque_false)
             updateCalcFlag(graphics);
         // need add caching or remove calc calls.
 //        if (mRedraw)
         {
             mVertexes->clear();
             if (mVBarVisible)
             {
                 if (mShowButtons)
                 {
                     calcButton(graphics, UP);
                     calcButton(graphics, DOWN);
                 }
                 calcVBar(graphics);
                 calcVMarker(graphics);
             }
  
             if (mHBarVisible)
             {
                 if (mShowButtons)
                 {
                     calcButton(graphics, LEFT);
                     calcButton(graphics, RIGHT);
                 }
                 calcHBar(graphics);
                 calcHMarker(graphics);
             }
             graphics->finalize(mVertexes);
         }
         graphics->drawTileCollection(mVertexes);
     }
  
     updateAlpha();
  
     if (mRedraw)
     {
         const bool redraw = graphics->getRedraw();
         graphics->setRedraw(true);
         drawChildren(graphics);
         graphics->setRedraw(redraw);
     }
     else
     {
         drawChildren(graphics);
     }
     mRedraw = false;
     BLOCK_END("ScrollArea::draw")
 }

References BLOCK_END, BLOCK_START, calcButton(), calcHBar(), calcHMarker(), calcVBar(), calcVMarker(), ImageCollection::clear(), DOWN, BasicContainer::drawChildren(), Graphics::drawTileCollection(), Graphics::finalize(), Graphics::getRedraw(), LEFT, mHBarVisible, mOpaque, Widget::mRedraw, mShowButtons, mVBarVisible, mVertexes, Opaque_false, RIGHT, Graphics::setRedraw(), UP, updateAlpha(), and updateCalcFlag().

◆ drawButton()

void ScrollArea::drawButton	(	Graphics *const	graphics,
		const BUTTON_DIR	dir
	)

protected

Definition at line 534 of file scrollarea.cpp.

 {
     Rect dim;
     const Image *const image = getImageByState(dim, dir);
  
     if (image != nullptr)
         graphics->drawImage(image, dim.x, dim.y);
 }

References Graphics::drawImage(), getImageByState(), Rect::x, and Rect::y.

Referenced by safeDraw().

◆ drawFrame()

void ScrollArea::drawFrame ( Graphics *const graphics )

virtual

Draws the background and border of the scroll area.

Reimplemented from Widget.

Definition at line 456 of file scrollarea.cpp.

 {
     BLOCK_START("ScrollArea::drawFrame")
     if (mOpaque == Opaque_true)
     {
         updateCalcFlag(graphics);
  
         if (mRedraw)
         {
             const int bs = mFrameSize * 2;
             const int w = mDimension.width + bs;
             const int h = mDimension.height + bs;
             mVertexes2->clear();
             graphics->calcWindow(mVertexes2,
                 0, 0,
                 w, h,
                 background);
             graphics->finalize(mVertexes2);
         }
         graphics->drawTileCollection(mVertexes2);
     }
     BLOCK_END("ScrollArea::drawFrame")
 }

References background, BLOCK_END, BLOCK_START, Graphics::calcWindow(), ImageCollection::clear(), Graphics::drawTileCollection(), Graphics::finalize(), Rect::height, Widget::mDimension, Widget::mFrameSize, mOpaque, Widget::mRedraw, mVertexes2, Opaque_true, updateCalcFlag(), and Rect::width.

◆ drawHBar()

void ScrollArea::drawHBar ( Graphics *const graphics ) const

protected

Definition at line 607 of file scrollarea.cpp.

 {
     const Rect &dim = getHorizontalBarDimension();
  
     if (hBackground.grid[4] != nullptr)
     {
         graphics->drawPattern(hBackground.grid[4],
             dim.x, dim.y,
             dim.width, dim.height);
     }
  
     if (hBackground.grid[3] != nullptr)
     {
         graphics->drawPattern(hBackground.grid[3],
             dim.x, dim.y,
             hBackground.grid[3]->getWidth(), dim.height);
     }
  
     if (hBackground.grid[5] != nullptr)
     {
         graphics->drawPattern(hBackground.grid[5],
             dim.x + dim.width - hBackground.grid[5]->getWidth(),
             dim.y,
             hBackground.grid[5]->getWidth(),
             dim.height);
     }
 }

References Graphics::drawPattern(), getHorizontalBarDimension(), ImageRect::grid, hBackground, Rect::height, Rect::width, Rect::x, and Rect::y.

Referenced by safeDraw().

◆ drawHMarker()

void ScrollArea::drawHMarker ( Graphics *const graphics )

protected

Definition at line 704 of file scrollarea.cpp.

 {
     const Rect dim = getHorizontalMarkerDimension();
  
     if ((mHasMouse) && (mY > (mDimension.height - mScrollbarWidth)))
     {
         graphics->drawImageRect(dim.x, dim.y,
             dim.width, dim.height,
             vMarkerHi);
     }
     else
     {
         graphics->drawImageRect(
             dim.x, dim.y,
             dim.width, dim.height,
             vMarker);
     }
 }

References Graphics::drawImageRect(), getHorizontalMarkerDimension(), Rect::height, Widget::mDimension, mHasMouse, mScrollbarWidth, mY, vMarker, vMarkerHi, Rect::width, Rect::x, and Rect::y.

Referenced by safeDraw().

◆ drawVBar()

void ScrollArea::drawVBar ( Graphics *const graphics ) const

protected

Definition at line 557 of file scrollarea.cpp.

 {
     const Rect &dim = getVerticalBarDimension();
  
     if (vBackground.grid[4] != nullptr)
     {
         graphics->drawPattern(vBackground.grid[4],
             dim.x, dim.y, dim.width, dim.height);
     }
     if (vBackground.grid[1] != nullptr)
     {
         graphics->drawPattern(vBackground.grid[1],
             dim.x, dim.y,
             dim.width, vBackground.grid[1]->getHeight());
     }
     if (vBackground.grid[7] != nullptr)
     {
         graphics->drawPattern(vBackground.grid[7],
             dim.x, dim.height - vBackground.grid[7]->getHeight() + dim.y,
             dim.width, vBackground.grid[7]->getHeight());
     }
 }

References Graphics::drawPattern(), getVerticalBarDimension(), ImageRect::grid, Rect::height, vBackground, Rect::width, Rect::x, and Rect::y.

Referenced by safeDraw().

◆ drawVMarker()

void ScrollArea::drawVMarker ( Graphics *const graphics )

protected

Definition at line 666 of file scrollarea.cpp.

 {
     const Rect &dim = getVerticalMarkerDimension();
  
     if ((mHasMouse) && (mX > (mDimension.width - mScrollbarWidth)))
     {
         graphics->drawImageRect(dim.x, dim.y,
             dim.width, dim.height,
             vMarkerHi);
     }
     else
     {
         graphics->drawImageRect(dim.x, dim.y,
             dim.width, dim.height,
             vMarker);
     }
 }

References Graphics::drawImageRect(), getVerticalMarkerDimension(), Rect::height, Widget::mDimension, mHasMouse, mScrollbarWidth, mX, vMarker, vMarkerHi, Rect::width, Rect::x, and Rect::y.

Referenced by safeDraw().

◆ getChildrenArea()

Rect ScrollArea::getChildrenArea ( )

virtual

Gets the area of the widget occupied by the widget's children. By default this method returns an empty rectangle as not all widgets are containers. If you want to make a container this method should return the area where the children resides. This method is used when drawing children of a widget when computing clip rectangles for the children.

An example of a widget that overloads this method is ScrollArea. A ScrollArea has a view of its contant and that view is the children area. The size of a ScrollArea's children area might vary depending on if the scroll bars of the ScrollArea is shown or not.

Returns: The area of the widget occupied by the widget's children.

See also: BasicContainer; BasicContainer::getChildrenArea; BasicContainer::drawChildren

Reimplemented from BasicContainer.

Definition at line 1322 of file scrollarea.cpp.

 {
     const Rect area = Rect(0, 0,
         mVBarVisible ? (getWidth() - mScrollbarWidth) : getWidth(),
         mHBarVisible ? (getHeight() - mScrollbarWidth) : getHeight());
  
     if (area.width < 0 || area.height < 0)
         return Rect();
  
     return area;
 }

References Widget::getHeight(), Widget::getWidth(), Rect::height, mHBarVisible, mScrollbarWidth, mVBarVisible, and Rect::width.

Referenced by getHorizontalMarkerDimension(), getHorizontalMaxScroll(), getVerticalMarkerDimension(), getVerticalMaxScroll(), getWidgetAt(), mousePressed(), mouseWheelMovedDown(), and mouseWheelMovedUp().

◆ getContent()

Widget * ScrollArea::getContent ( )

Gets the content.

Returns: The content of the scroll area.

Definition at line 1207 of file scrollarea.cpp.

 {
     if (!mWidgets.empty())
         return *mWidgets.begin();
  
     return nullptr;
 }

References BasicContainer::mWidgets.

Referenced by checkPolicies(), getHorizontalMaxScroll(), getVerticalMaxScroll(), getWidgetAt(), logic(), showWidgetPart(), ShortcutWindow::widgetHidden(), widgetResized(), ~ScrollArea(), and Setup_Colors::~Setup_Colors().

◆ getDownButtonDimension()

Rect ScrollArea::getDownButtonDimension ( ) const

Definition at line 1144 of file scrollarea.cpp.

 {
     if (!mVBarVisible || !mShowButtons)
         return Rect(0, 0, 0, 0);
  
     if (mHBarVisible)
     {
         return Rect(mDimension.width - mScrollbarWidth,
             mDimension.height - mScrollbarWidth * 2,
             mScrollbarWidth,
             mScrollbarWidth);
     }
  
     return Rect(mDimension.width - mScrollbarWidth,
         mDimension.height - mScrollbarWidth,
         mScrollbarWidth,
         mScrollbarWidth);
 }

References Rect::height, Widget::mDimension, mHBarVisible, mScrollbarWidth, mShowButtons, mVBarVisible, and Rect::width.

Referenced by getImageByState(), and mousePressed().

◆ getDownButtonScrollAmount()

int ScrollArea::getDownButtonScrollAmount ( ) const

inline

Gets the amount to scroll in pixels when the down scroll button is pushed.

Returns: The amount to scroll in pixels.

See also: setDownButtonScrollAmount

Definition at line 411 of file scrollarea.h.

412 { return mDownButtonScrollAmount; }

References mDownButtonScrollAmount.

◆ getHorizontalBarDimension()

Rect ScrollArea::getHorizontalBarDimension ( ) const

Definition at line 995 of file scrollarea.cpp.

 {
     if (!mHBarVisible)
         return Rect(0, 0, 0, 0);
  
     const int width = mShowButtons ? mScrollbarWidth : 0;
     if (mVBarVisible)
     {
         return Rect(width,
             mDimension.height - mScrollbarWidth,
             mDimension.width - 2 * width - mScrollbarWidth,
             mScrollbarWidth);
     }
  
     return Rect(width,
                       mDimension.height - mScrollbarWidth,
                       mDimension.width - 2 * width,
                       mScrollbarWidth);
 }

References Rect::height, Widget::mDimension, mHBarVisible, mScrollbarWidth, mShowButtons, mVBarVisible, and Rect::width.

Referenced by calcHBar(), drawHBar(), mouseDragged(), and mousePressed().

◆ getHorizontalMarkerDimension()

Rect ScrollArea::getHorizontalMarkerDimension ( )

Definition at line 1073 of file scrollarea.cpp.

 {
     if (!mHBarVisible)
         return Rect(0, 0, 0, 0);
  
     int length;
     int pos;
     int width;
     const int w2 = mShowButtons
         ? mScrollbarWidth : mMarkerSize / 2;
     const Widget *content;
     if (!mWidgets.empty())
         content = *mWidgets.begin();
     else
         content = nullptr;
  
     if (mVBarVisible)
         width = mDimension.width - 2 * w2 - mScrollbarWidth;
     else
         width = mDimension.width - w2 - mScrollbarWidth;
  
     const int maxH = getHorizontalMaxScroll();
     if (mMarkerSize != 0 && maxH != 0)
     {
         pos = (mHScroll * width / maxH - mMarkerSize / 2);
         length = mMarkerSize;
     }
     else
     {
         if (content != nullptr)
         {
             const int w3 = content->getWidth();
             if (w3 != 0)
                 length = (width * getChildrenArea().width) / w3;
             else
                 length = width;
         }
         else
         {
             length = width;
         }
  
         if (length < mScrollbarWidth)
             length = mScrollbarWidth;
  
         if (length > width)
             length = width;
  
         if (maxH != 0)
         {
             pos = ((width - length) * mHScroll) / maxH;
         }
         else
         {
             pos = 0;
         }
     }
  
     return Rect(w2 + pos, mDimension.height - mScrollbarWidth,
         length, mScrollbarWidth);
 }

References getChildrenArea(), getHorizontalMaxScroll(), Widget::getWidth(), Rect::height, Widget::mDimension, mHBarVisible, mHScroll, mMarkerSize, mScrollbarWidth, mShowButtons, mVBarVisible, BasicContainer::mWidgets, and Rect::width.

Referenced by calcHMarker(), drawHMarker(), mouseDragged(), and mousePressed().

◆ getHorizontalMaxScroll()

int ScrollArea::getHorizontalMaxScroll ( )

Gets the maximum amount of horizontal scroll.

Returns: The horizontal max scroll.

Definition at line 1266 of file scrollarea.cpp.

 {
     checkPolicies();
  
     const Widget *const content = getContent();
     if (content == nullptr)
         return 0;
  
     const int value = content->getWidth() - getChildrenArea().width +
         2 * content->getFrameSize();
  
     if (value < 0)
         return 0;
  
     return value;
 }

References checkPolicies(), getChildrenArea(), getContent(), Widget::getFrameSize(), Widget::getWidth(), and Rect::width.

Referenced by getHorizontalMarkerDimension(), mouseDragged(), mouseReleased(), and setHorizontalScrollAmount().

◆ getHorizontalScrollAmount()

int ScrollArea::getHorizontalScrollAmount ( ) const

inline

Gets the amount that is scrolled horizontally.

Returns: The scroll amount on horizontal scroll.

See also: setHorizontalScrollAmount, setScrollAmount

Definition at line 291 of file scrollarea.h.

292 { return mHScroll; }

References mHScroll.

◆ getHorizontalScrollPolicy()

ScrollPolicy ScrollArea::getHorizontalScrollPolicy ( ) const

inline

Gets the horizontal scrollbar policy. See enum with policies.

Returns: The policy for the horizontal scrollbar policy.

See also: setHorizontalScrollPolicy, setScrollPolicy

Definition at line 230 of file scrollarea.h.

231 { return mHPolicy; }

References mHPolicy.

◆ getImageByState()

Image * ScrollArea::getImageByState	(	Rect &	dim,
		const BUTTON_DIR	dir
	)

protected

Definition at line 503 of file scrollarea.cpp.

 {
     int state = 0;
  
     switch (dir)
     {
         case UP:
             state = mUpButtonPressed ? 1 : 0;
             dim = getUpButtonDimension();
             break;
         case DOWN:
             state = mDownButtonPressed ? 1 : 0;
             dim = getDownButtonDimension();
             break;
         case LEFT:
             state = mLeftButtonPressed ? 1 : 0;
             dim = getLeftButtonDimension();
             break;
         case RIGHT:
             state = mRightButtonPressed ? 1 : 0;
             dim = getRightButtonDimension();
             break;
         case BUTTONS_DIR:
         default:
             logger->log("ScrollArea::drawButton unknown dir: "
                         + toString(CAST_U32(dir)));
             return nullptr;
     }
     return buttons[CAST_SIZE(dir)][state];
 }

References buttons, BUTTONS_DIR, CAST_SIZE, CAST_U32, DOWN, getDownButtonDimension(), getLeftButtonDimension(), getRightButtonDimension(), getUpButtonDimension(), LEFT, Logger::log(), logger, mDownButtonPressed, mLeftButtonPressed, mRightButtonPressed, mUpButtonPressed, RIGHT, Catch::toString(), and UP.

Referenced by calcButton(), and drawButton().

◆ getLeftButtonDimension()

Rect ScrollArea::getLeftButtonDimension ( ) const

Definition at line 1163 of file scrollarea.cpp.

 {
     if (!mHBarVisible || !mShowButtons)
         return Rect(0, 0, 0, 0);
  
     return Rect(0, mDimension.height - mScrollbarWidth,
         mScrollbarWidth, mScrollbarWidth);
 }

References Rect::height, Widget::mDimension, mHBarVisible, mScrollbarWidth, and mShowButtons.

Referenced by getImageByState(), and mousePressed().

◆ getLeftButtonScrollAmount()

int ScrollArea::getLeftButtonScrollAmount ( ) const

inline

Gets the amount to scroll in pixels when the left scroll button is pushed.

Returns: The amount to scroll in pixels.

See also: setLeftButtonScrollAmount

Definition at line 381 of file scrollarea.h.

382 { return mLeftButtonScrollAmount; }

References mLeftButtonScrollAmount.

◆ getRightButtonDimension()

Rect ScrollArea::getRightButtonDimension ( ) const

Definition at line 1172 of file scrollarea.cpp.

 {
     if (!mHBarVisible || !mShowButtons)
         return Rect(0, 0, 0, 0);
  
     if (mVBarVisible)
     {
         return Rect(mDimension.width - mScrollbarWidth*2,
             mDimension.height - mScrollbarWidth,
             mScrollbarWidth,
             mScrollbarWidth);
     }
  
     return Rect(mDimension.width - mScrollbarWidth,
         mDimension.height - mScrollbarWidth,
         mScrollbarWidth,
         mScrollbarWidth);
 }

References Rect::height, Widget::mDimension, mHBarVisible, mScrollbarWidth, mShowButtons, mVBarVisible, and Rect::width.

Referenced by getImageByState(), and mousePressed().

◆ getRightButtonScrollAmount()

int ScrollArea::getRightButtonScrollAmount ( ) const

inline

Gets the amount to scroll in pixels when the right scroll button is pushed.

Returns: The amount to scroll in pixels.

See also: setRightButtonScrollAmount

Definition at line 391 of file scrollarea.h.

392 { return mRightButtonScrollAmount; }

References mRightButtonScrollAmount.

◆ getScrollbarWidth()

int ScrollArea::getScrollbarWidth ( ) const

inline

Gets the width of the scroll bars.

Returns: the width of the ScrollBar.

See also: setScrollbarWidth

Definition at line 331 of file scrollarea.h.

332 { return mScrollbarWidth; }

References mScrollbarWidth.

◆ getUpButtonDimension()

Rect ScrollArea::getUpButtonDimension ( ) const

Definition at line 1135 of file scrollarea.cpp.

 {
     if (!mVBarVisible || !mShowButtons)
         return Rect(0, 0, 0, 0);
  
     return Rect(mDimension.width - mScrollbarWidth, 0,
         mScrollbarWidth, mScrollbarWidth);
 }

References Widget::mDimension, mScrollbarWidth, mShowButtons, mVBarVisible, and Rect::width.

Referenced by getImageByState(), and mousePressed().

◆ getUpButtonScrollAmount()

int ScrollArea::getUpButtonScrollAmount ( ) const

inline

Gets the amount to scroll in pixels when the up scroll button is pushed.

Returns: The amount to scroll in pixels.

See also: setUpButtonScrollAmount

Definition at line 401 of file scrollarea.h.

402 { return mUpButtonScrollAmount; }

References mUpButtonScrollAmount.

◆ getVerticalBarDimension()

Rect ScrollArea::getVerticalBarDimension ( ) const

Definition at line 975 of file scrollarea.cpp.

 {
     if (!mVBarVisible)
         return Rect(0, 0, 0, 0);
  
     const int height = mShowButtons ? mScrollbarWidth : 0;
     if (mHBarVisible)
     {
         return Rect(mDimension.width - mScrollbarWidth,
             height,
             mScrollbarWidth,
             mDimension.height - 2 * height - mScrollbarWidth);
     }
  
     return Rect(mDimension.width - mScrollbarWidth,
         height,
         mScrollbarWidth,
         mDimension.height - 2 * height);
 }

References Rect::height, Widget::mDimension, mHBarVisible, mScrollbarWidth, mShowButtons, mVBarVisible, and Rect::width.

Referenced by calcVBar(), drawVBar(), mouseDragged(), and mousePressed().

◆ getVerticalMarkerDimension()

Rect ScrollArea::getVerticalMarkerDimension ( )

Definition at line 1015 of file scrollarea.cpp.

 {
     if (!mVBarVisible)
         return Rect(0, 0, 0, 0);
  
     int length;
     int pos;
     int height;
     const int h2 = mShowButtons
         ? mScrollbarWidth : mMarkerSize / 2;
     const Widget *content;
     if (!mWidgets.empty())
         content = *mWidgets.begin();
     else
         content = nullptr;
  
     if (mHBarVisible)
         height = mDimension.height - 2 * h2 - mScrollbarWidth;
     else
         height = mDimension.height - 2 * h2;
  
     const int maxV = getVerticalMaxScroll();
     if ((mMarkerSize != 0) && (maxV != 0))
     {
         pos = (mVScroll * height / maxV - mMarkerSize / 2);
         length = mMarkerSize;
     }
     else
     {
         if (content != nullptr)
         {
             const int h3 = content->getHeight();
             if (h3 != 0)
                 length = (height * getChildrenArea().height) / h3;
             else
                 length = height;
         }
         else
         {
             length = height;
         }
  
         if (length < mScrollbarWidth)
             length = mScrollbarWidth;
  
         if (length > height)
             length = height;
  
         if (maxV != 0)
             pos = ((height - length) * mVScroll) / maxV;
         else
             pos = 0;
     }
  
     return Rect(mDimension.width - mScrollbarWidth, h2 + pos,
         mScrollbarWidth, length);
 }

References getChildrenArea(), Widget::getHeight(), getVerticalMaxScroll(), Rect::height, Widget::mDimension, mHBarVisible, mMarkerSize, mScrollbarWidth, mShowButtons, mVBarVisible, mVScroll, BasicContainer::mWidgets, and Rect::width.

Referenced by calcVMarker(), drawVMarker(), mouseDragged(), and mousePressed().

◆ getVerticalMaxScroll()

int ScrollArea::getVerticalMaxScroll ( )

Gets the maximum amount of vertical scroll.

Returns: The vertical max scroll.

Definition at line 1283 of file scrollarea.cpp.

 {
     checkPolicies();
  
     const Widget *const content = getContent();
     if (content == nullptr)
         return 0;
  
     int value;
  
     value = content->getHeight() - getChildrenArea().height +
         2 * content->getFrameSize();
  
     if (value < 0)
         return 0;
  
     return value;
 }

References checkPolicies(), getChildrenArea(), getContent(), Widget::getFrameSize(), Widget::getHeight(), and Rect::height.

Referenced by ChatTab::addNewRow(), NpcDialog::addText(), NpcDialog::buildLayout(), ChatTab::chatLog(), getVerticalMarkerDimension(), UpdaterWindow::logic(), mouseDragged(), mouseReleased(), setVerticalScrollAmount(), WhoIsOnline::updateWindow(), and TabbedArea::widgetResized().

◆ getVerticalScrollAmount()

int ScrollArea::getVerticalScrollAmount ( ) const

inline

Gets the amount that is scrolled vertically.

Returns: The scroll amount on vertical scroll.

See also: setVerticalScrollAmount, setScrollAmount

Definition at line 274 of file scrollarea.h.

275 { return mVScroll; }

References mVScroll.

Referenced by ChatTab::addNewRow(), ChatTab::chatLog(), ChatTab::scroll(), WhoIsOnline::updateWindow(), and TabbedArea::widgetResized().

◆ getVerticalScrollPolicy()

ScrollPolicy ScrollArea::getVerticalScrollPolicy ( ) const

inline

Gets the vertical scrollbar policy. See enum with policies.

Returns: The policy for the vertical scrollbar.

See also: setVerticalScrollPolicy, setScrollPolicy

Definition at line 247 of file scrollarea.h.

248 { return mVPolicy; }

References mVPolicy.

◆ getWidgetAt()

Widget * ScrollArea::getWidgetAt	(	int	x,
		int	y
	)

virtual

Gets a widget from a certain position in the widget. This function is used to decide which gets mouse input, thus it can be overloaded to change that behaviour.

NOTE: This always returns NULL if the widget is not a container.

Parameters

x	The x coordinate of the widget to get.
y	The y coordinate of the widget to get.

Returns: The widget at the specified coodinate, NULL if no widget is found.

Reimplemented from BasicContainer.

Definition at line 1334 of file scrollarea.cpp.

 {
     if (getChildrenArea().isPointInRect(x, y))
         return getContent();
  
     return nullptr;
 }

References getChildrenArea(), getContent(), x, and y.

◆ init()

void ScrollArea::init ( std::string skinName )

protected

Initializes the scroll area.

Definition at line 182 of file scrollarea.cpp.

 {
     setOpaque(mOpaque);
  
     setUpButtonScrollAmount(2);
     setDownButtonScrollAmount(2);
     setLeftButtonScrollAmount(2);
     setRightButtonScrollAmount(2);
  
     if (instances == 0)
     {
         for (int f = 0; f < 9; f ++)
         {
             background.grid[f] = nullptr;
             vMarker.grid[f] = nullptr;
             vMarkerHi.grid[f] = nullptr;
             vBackground.grid[f] = nullptr;
             hBackground.grid[f] = nullptr;
         }
  
         // +++ here probably need move background from static
         if (skinName.empty())
             skinName = "scroll_background.xml";
         if (theme != nullptr)
         {
             theme->loadRect(background,
                 skinName,
                 "scroll_background.xml",
                 0,
                 8);
             theme->loadRect(vMarker,
                 "scroll.xml",
                 "",
                 0,
                 8);
             theme->loadRect(vMarkerHi,
                 "scroll_highlighted.xml",
                 "scroll.xml",
                 0,
                 8);
             theme->loadRect(vBackground,
                 "scroll_vbackground.xml",
                 "",
                 0,
                 8);
             theme->loadRect(hBackground,
                 "scroll_hbackground.xml",
                 "",
                 0,
                 8);
         }
  
         for (int i = 0; i < 2; i ++)
         {
             Skin *skin = nullptr;
             if (theme != nullptr)
             {
                 skin = theme->load(buttonFiles[i],
                     "scrollbuttons.xml",
                     true,
                     Theme::getThemePath());
             }
             if (skin != nullptr)
             {
                 const ImageRect &rect = skin->getBorder();
                 for (int f = UP; f < BUTTONS_DIR; f ++)
                 {
                     if (rect.grid[f] != nullptr)
                         rect.grid[f]->incRef();
                     buttons[f][i] = rect.grid[f];
                 }
                 if (i == 0)
                 {
                     mShowButtons = (skin->getOption("showbuttons", 1) == 1);
                     mMarkerSize = skin->getOption("markersize", 0);
                     mScrollbarSize = skin->getOption("scrollbarsize", 12);
                 }
             }
             else
             {
                 for (int f = UP; f < BUTTONS_DIR; f ++)
                     buttons[f][i] = nullptr;
             }
             if (theme != nullptr)
                 theme->unload(skin);
         }
     }
     mScrollbarWidth = mScrollbarSize;
     instances++;
 }

References background, buttonFiles, buttons, BUTTONS_DIR, Skin::getBorder(), Skin::getOption(), Theme::getThemePath(), ImageRect::grid, hBackground, instances, Theme::load(), Theme::loadRect(), mMarkerSize, mOpaque, mScrollbarSize, mScrollbarWidth, mShowButtons, setDownButtonScrollAmount(), setLeftButtonScrollAmount(), setOpaque(), setRightButtonScrollAmount(), setUpButtonScrollAmount(), theme, Theme::unload(), UP, vBackground, vMarker, and vMarkerHi.

Referenced by ScrollArea().

◆ isOpaque()

bool ScrollArea::isOpaque ( ) const

inline

Returns whether the widget draws its background or not.

Definition at line 158 of file scrollarea.h.

159 { return mOpaque == Opaque_true; }

References mOpaque, and Opaque_true.

◆ isSelectable()

bool ScrollArea::isSelectable ( ) const

virtual

Reimplemented from Widget.

Definition at line 1478 of file scrollarea.cpp.

 {
     if (mVBarVisible || mHBarVisible)
         return true;
     return Widget::isSelectable();
 }

References Widget::isSelectable(), mHBarVisible, and mVBarVisible.

◆ logic()

void ScrollArea::logic ( )

virtual

Logic function optionally adapts width or height of contents. This depends on the scrollbar settings.

Reimplemented from BasicContainer.

Definition at line 273 of file scrollarea.cpp.

 {
     BLOCK_START("ScrollArea::logic")
     if (!isVisible())
     {
         BLOCK_END("ScrollArea::logic")
         return;
     }
  
     checkPolicies();
  
     setVerticalScrollAmount(mVScroll);
     setHorizontalScrollAmount(mHScroll);
  
     Widget *const content = getContent();
     if (content != nullptr)
     {
         unsigned int frameSize = content->getFrameSize();
         content->setPosition(-mHScroll + frameSize, -mVScroll + frameSize);
         content->logic();
  
         // When no scrollbar in a certain direction,
         // adapt content size to match the content dimension exactly.
         frameSize = 2 * content->getFrameSize();
         if (mHPolicy == ScrollArea::SHOW_NEVER)
         {
             content->setWidth((mVBarVisible ? (mDimension.width
                 - mScrollbarWidth) : mDimension.width) - frameSize);
         }
         if (mVPolicy == ScrollArea::SHOW_NEVER)
         {
             content->setHeight((mHBarVisible ? (mDimension.height
                 - mScrollbarWidth) : mDimension.height) - frameSize);
         }
     }
  
     if (mUpButtonPressed)
         setVerticalScrollAmount(mVScroll - mUpButtonScrollAmount);
     else if (mDownButtonPressed)
         setVerticalScrollAmount(mVScroll + mDownButtonScrollAmount);
     else if (mLeftButtonPressed)
         setHorizontalScrollAmount(mHScroll - mLeftButtonScrollAmount);
     else if (mRightButtonPressed)
         setHorizontalScrollAmount(mHScroll + mRightButtonScrollAmount);
     BLOCK_END("ScrollArea::logic")
 }

References BLOCK_END, BLOCK_START, checkPolicies(), getContent(), Widget::getFrameSize(), Rect::height, Widget::isVisible(), Widget::logic(), Widget::mDimension, mDownButtonPressed, mDownButtonScrollAmount, mHBarVisible, mHPolicy, mHScroll, mLeftButtonPressed, mLeftButtonScrollAmount, mRightButtonPressed, mRightButtonScrollAmount, mScrollbarWidth, mUpButtonPressed, mUpButtonScrollAmount, mVBarVisible, mVPolicy, mVScroll, Widget::setHeight(), setHorizontalScrollAmount(), Widget::setPosition(), setVerticalScrollAmount(), Widget::setWidth(), SHOW_NEVER, and Rect::width.

Referenced by ChatTab::addNewRow(), ChatTab::chatLog(), UpdaterWindow::logic(), and WhoIsOnline::logic().

◆ mouseDragged()

void ScrollArea::mouseDragged ( MouseEvent & event )

virtual

Called when the mouse has moved and the mouse has previously been pressed on the widget.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 933 of file scrollarea.cpp.

 {
     if (mIsVerticalMarkerDragged)
     {
         const Rect barDim = getVerticalBarDimension();
         const int length = getVerticalMarkerDimension().height;
  
         if ((barDim.height - length) > 0)
         {
             const int pos = event.getY() - barDim.y
                 - mVerticalMarkerDragOffset;
             setVerticalScrollAmount((getVerticalMaxScroll() * pos)
                                       / (barDim.height - length));
         }
         else
         {
             setVerticalScrollAmount(0);
         }
     }
  
     if (mIsHorizontalMarkerDragged)
     {
         const Rect barDim = getHorizontalBarDimension();
         const int length = getHorizontalMarkerDimension().width;
  
         if ((barDim.width - length) > 0)
         {
             const int pos = event.getX() - barDim.x
                 - mHorizontalMarkerDragOffset;
             setHorizontalScrollAmount((getHorizontalMaxScroll() * pos)
                                       / (barDim.width - length));
         }
         else
         {
             setHorizontalScrollAmount(0);
         }
     }
  
     event.consume();
     mRedraw = true;
 }

References getHorizontalBarDimension(), getHorizontalMarkerDimension(), getHorizontalMaxScroll(), getVerticalBarDimension(), getVerticalMarkerDimension(), getVerticalMaxScroll(), Rect::height, mHorizontalMarkerDragOffset, mIsHorizontalMarkerDragged, mIsVerticalMarkerDragged, Widget::mRedraw, mVerticalMarkerDragOffset, setHorizontalScrollAmount(), setVerticalScrollAmount(), Rect::width, Rect::x, and Rect::y.

◆ mouseEntered()

void ScrollArea::mouseEntered ( MouseEvent & event )

virtual

Called when the mouse enteres the widget area.

Reimplemented from MouseListener.

Definition at line 749 of file scrollarea.cpp.

 {
     mHasMouse = true;
 }

References mHasMouse.

◆ mouseExited()

void ScrollArea::mouseExited ( MouseEvent & event )

virtual

Called when the mouse leaves the widget area.

Reimplemented from MouseListener.

Definition at line 754 of file scrollarea.cpp.

 {
     mHasMouse = false;
 }

References mHasMouse.

◆ mouseMoved()

void ScrollArea::mouseMoved ( MouseEvent & event )

virtual

Called when the mouse moves in the widget area.

Reimplemented from MouseListener.

Definition at line 743 of file scrollarea.cpp.

 {
     mX = event.getX();
     mY = event.getY();
 }

References mX, and mY.

◆ mousePressed()

void ScrollArea::mousePressed ( MouseEvent & event )

virtual

Called when a mouse button has been pressed on the widget area.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 776 of file scrollarea.cpp.

 {
     const int x = event.getX();
     const int y = event.getY();
  
     if (getUpButtonDimension().isPointInRect(x, y))
     {
         setVerticalScrollAmount(mVScroll
                                 - mUpButtonScrollAmount);
         mUpButtonPressed = true;
         event.consume();
     }
     else if (getDownButtonDimension().isPointInRect(x, y))
     {
         setVerticalScrollAmount(mVScroll
                                 + mDownButtonScrollAmount);
         mDownButtonPressed = true;
         event.consume();
     }
     else if (getLeftButtonDimension().isPointInRect(x, y))
     {
         setHorizontalScrollAmount(mHScroll
                                   - mLeftButtonScrollAmount);
         mLeftButtonPressed = true;
         event.consume();
     }
     else if (getRightButtonDimension().isPointInRect(x, y))
     {
         setHorizontalScrollAmount(mHScroll
                                   + mRightButtonScrollAmount);
         mRightButtonPressed = true;
         event.consume();
     }
     else if (getVerticalMarkerDimension().isPointInRect(x, y))
     {
         mIsHorizontalMarkerDragged = false;
         mIsVerticalMarkerDragged = true;
  
         mVerticalMarkerDragOffset = y - getVerticalMarkerDimension().y;
         event.consume();
     }
     else if (getVerticalBarDimension().isPointInRect(x, y))
     {
         if (y < getVerticalMarkerDimension().y)
         {
             setVerticalScrollAmount(mVScroll
                 - CAST_S32(getChildrenArea().height * 0.1));
         }
         else
         {
             setVerticalScrollAmount(mVScroll
                 + CAST_S32(getChildrenArea().height * 0.1));
         }
         event.consume();
     }
     else if (getHorizontalMarkerDimension().isPointInRect(x, y))
     {
         mIsHorizontalMarkerDragged = true;
         mIsVerticalMarkerDragged = false;
         mHorizontalMarkerDragOffset = x - getHorizontalMarkerDimension().x;
         event.consume();
     }
     else if (getHorizontalBarDimension().isPointInRect(x, y))
     {
         if (x < getHorizontalMarkerDimension().x)
         {
             setHorizontalScrollAmount(mHScroll
                 - CAST_S32(getChildrenArea().width * 0.1));
         }
         else
         {
             setHorizontalScrollAmount(mHScroll
                 + CAST_S32(getChildrenArea().width * 0.1));
         }
         event.consume();
     }
  
     if (event.getButton() == MouseButton::LEFT &&
         !event.isConsumed())
     {
         mClickX = event.getX();
         mClickY = event.getY();
     }
 }

References CAST_S32, MouseEvent::getButton(), getChildrenArea(), getDownButtonDimension(), getHorizontalBarDimension(), getHorizontalMarkerDimension(), getLeftButtonDimension(), getRightButtonDimension(), getUpButtonDimension(), getVerticalBarDimension(), getVerticalMarkerDimension(), InputGuiEvent::isConsumed(), MouseButton::LEFT, mClickX, mClickY, mDownButtonPressed, mDownButtonScrollAmount, mHorizontalMarkerDragOffset, mHScroll, mIsHorizontalMarkerDragged, mIsVerticalMarkerDragged, mLeftButtonPressed, mLeftButtonScrollAmount, mRightButtonPressed, mRightButtonScrollAmount, mUpButtonPressed, mUpButtonScrollAmount, mVerticalMarkerDragOffset, mVScroll, setHorizontalScrollAmount(), setVerticalScrollAmount(), Rect::x, x, Rect::y, and y.

◆ mouseReleased()

void ScrollArea::mouseReleased ( MouseEvent & event )

virtual

Called when a mouse button has been released on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 861 of file scrollarea.cpp.

 {
     if (event.getButton() == MouseButton::LEFT &&
         mClickX != 0 &&
         mClickY != 0)
     {
         if (!event.isConsumed())
         {
 #ifdef ANDROID
             int dx = mClickX - event.getX();
             int dy = mClickY - event.getY();
 #else  // ANDROID
  
             int dx = event.getX() - mClickX;
             int dy = event.getY() - mClickY;
 #endif  // ANDROID
  
             if ((dx < 20 && dx > 0) || (dx > -20 && dx < 0))
                 dx = 0;
  
             if ((dy < 20 && dy > 0) || (dy > -20 && dy < 0))
                 dy = 0;
  
             if (abs(dx) > abs(dy))
             {
                 int s = mHScroll + dx;
                 if (s < 0)
                 {
                     s = 0;
                 }
                 else
                 {
                     const int maxH = getHorizontalMaxScroll();
                     if (s > maxH)
                         s = maxH;
                 }
  
                 setHorizontalScrollAmount(s);
             }
             else if (dy != 0)
             {
                 int s = mVScroll + dy;
                 if (s < 0)
                 {
                     s = 0;
                 }
                 else
                 {
                     const int maxV = getVerticalMaxScroll();
                     if (s > maxV)
                         s = maxV;
                 }
  
                 setVerticalScrollAmount(s);
             }
             mClickX = 0;
             mClickY = 0;
             if (mMouseConsume && ((dx != 0) || (dy != 0)))
                 event.consume();
         }
     }
     mUpButtonPressed = false;
     mDownButtonPressed = false;
     mLeftButtonPressed = false;
     mRightButtonPressed = false;
     mIsHorizontalMarkerDragged = false;
     mIsVerticalMarkerDragged = false;
     if (mMouseConsume)
         event.consume();
     mRedraw = true;
 }

References MouseEvent::getButton(), getHorizontalMaxScroll(), getVerticalMaxScroll(), InputGuiEvent::isConsumed(), MouseButton::LEFT, mClickX, mClickY, mDownButtonPressed, mHScroll, mIsHorizontalMarkerDragged, mIsVerticalMarkerDragged, mLeftButtonPressed, Widget::mMouseConsume, Widget::mRedraw, mRightButtonPressed, mUpButtonPressed, mVScroll, setHorizontalScrollAmount(), and setVerticalScrollAmount().

◆ mouseWheelMovedDown()

void ScrollArea::mouseWheelMovedDown ( MouseEvent & event )

virtual

Called when the mouse wheel has moved down on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 1371 of file scrollarea.cpp.

 {
     if (event.isConsumed())
         return;
  
     setVerticalScrollAmount(mVScroll
         + getChildrenArea().height / 8);
  
     event.consume();
 }

References getChildrenArea(), InputGuiEvent::isConsumed(), mVScroll, and setVerticalScrollAmount().

◆ mouseWheelMovedUp()

void ScrollArea::mouseWheelMovedUp ( MouseEvent & event )

virtual

Called when the mouse wheel has moved up on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 1360 of file scrollarea.cpp.

 {
     if (event.isConsumed())
         return;
  
     setVerticalScrollAmount(mVScroll
         - getChildrenArea().height / 8);
  
     event.consume();
 }

References getChildrenArea(), InputGuiEvent::isConsumed(), mVScroll, and setVerticalScrollAmount().

◆ safeDraw()

void ScrollArea::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 398 of file scrollarea.cpp.

 {
     BLOCK_START("ScrollArea::draw")
     if (mVBarVisible)
     {
         if (mShowButtons)
         {
             drawButton(graphics, UP);
             drawButton(graphics, DOWN);
         }
         drawVBar(graphics);
         drawVMarker(graphics);
     }
  
     if (mHBarVisible)
     {
         if (mShowButtons)
         {
             drawButton(graphics, LEFT);
             drawButton(graphics, RIGHT);
         }
         drawHBar(graphics);
         drawHMarker(graphics);
     }
  
     updateAlpha();
  
     safeDrawChildren(graphics);
     mRedraw = false;
     BLOCK_END("ScrollArea::draw")
 }

References BLOCK_END, BLOCK_START, DOWN, drawButton(), drawHBar(), drawHMarker(), drawVBar(), drawVMarker(), LEFT, mHBarVisible, Widget::mRedraw, mShowButtons, mVBarVisible, RIGHT, BasicContainer::safeDrawChildren(), UP, and updateAlpha().

◆ safeDrawFrame()

void ScrollArea::safeDrawFrame ( Graphics *const graphics )

virtual

Reimplemented from Widget.

Definition at line 480 of file scrollarea.cpp.

 {
     BLOCK_START("ScrollArea::drawFrame")
     if (mOpaque == Opaque_true)
     {
         const int bs = mFrameSize * 2;
         const int w = mDimension.width + bs;
         const int h = mDimension.height + bs;
  
         updateCalcFlag(graphics);
         graphics->drawImageRect(0, 0,
             w, h,
             background);
     }
     BLOCK_END("ScrollArea::drawFrame")
 }

References background, BLOCK_END, BLOCK_START, Graphics::drawImageRect(), Rect::height, Widget::mDimension, Widget::mFrameSize, mOpaque, Opaque_true, updateCalcFlag(), and Rect::width.

◆ setContent()

void ScrollArea::setContent ( Widget * widget )

Sets the content.

Parameters

widget The content of the scroll area.

Definition at line 1191 of file scrollarea.cpp.

 {
     if (widget != nullptr)
     {
         clear();
         add(widget);
         widget->setPosition(0, 0);
     }
     else
     {
         clear();
     }
  
     checkPolicies();
 }

References BasicContainer::add(), checkPolicies(), BasicContainer::clear(), and Widget::setPosition().

Referenced by ScrollArea(), ShopWindow::updateSelection(), Setup_Colors::valueChanged(), and ~ScrollArea().

◆ setDimension()

void ScrollArea::setDimension ( const Rect & dimension )

Definition at line 1354 of file scrollarea.cpp.

 {
     Widget::setDimension(dimension);
     checkPolicies();
 }

References checkPolicies(), and Widget::setDimension().

Referenced by WhoIsOnline::postInit().

◆ setDownButtonScrollAmount()

void ScrollArea::setDownButtonScrollAmount ( const int amount )

inline

Sets the amount to scroll in pixels when the down scroll button is pushed.

Parameters

amount The amount to scroll in pixels.

See also: getDownButtonScrollAmount

Definition at line 371 of file scrollarea.h.

372 { mDownButtonScrollAmount = amount; }

References mDownButtonScrollAmount.

Referenced by init().

◆ setHeight()

void ScrollArea::setHeight ( int height )

Definition at line 1348 of file scrollarea.cpp.

 {
     Widget::setHeight(height);
     checkPolicies();
 }

References checkPolicies(), and Widget::setHeight().

Referenced by PopupList::adjustSize(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), Setup_Colors::Setup_Colors(), PopupMenu::showPopup(), and SetupTabScroll::widgetResized().

◆ setHorizontalScrollAmount()

void ScrollArea::setHorizontalScrollAmount ( int hScroll )

Sets the amount to scroll horizontally.

Parameters

hScroll The amount to scroll.

See also: getHorizontalScrollAmount

Definition at line 1248 of file scrollarea.cpp.

 {
     const int max = getHorizontalMaxScroll();
  
     mHScroll = hScroll;
  
     if (hScroll > max)
         mHScroll = max;
     else if (hScroll < 0)
         mHScroll = 0;
 }

References getHorizontalMaxScroll(), and mHScroll.

Referenced by logic(), mouseDragged(), mousePressed(), mouseReleased(), setScrollAmount(), and showWidgetPart().

◆ setHorizontalScrollPolicy()

void ScrollArea::setHorizontalScrollPolicy ( const ScrollPolicy hPolicy )

Sets the horizontal scrollbar policy. See enum with policies.

Parameters

hPolicy The policy for the horizontal scrollbar.

See also: getHorizontalScrollPolicy

Definition at line 1215 of file scrollarea.cpp.

 {
     mHPolicy = hPolicy;
     checkPolicies();
 }

References checkPolicies(), and mHPolicy.

Referenced by SkillDialog::addDefaultTab(), ShortcutWindow::addTab(), SocialTab::createControls(), BuyDialog::init(), InventoryWindow::InventoryWindow(), SkillDialog::loadXmlFile(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), NpcDialog::NpcDialog(), SellDialog::postInit(), EmoteWindow::postInit(), TextSelectDialog::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), Setup_Colors::Setup_Colors(), Setup_Input::Setup_Input(), Setup_Relations::Setup_Relations(), Setup_Video::Setup_Video(), SetupTabScroll::SetupTabScroll(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), StatsPage::StatsPage(), StatsPageBasic::StatsPageBasic(), TradeWindow::TradeWindow(), and WorldSelectDialog::WorldSelectDialog().

◆ setLeftButtonScrollAmount()

void ScrollArea::setLeftButtonScrollAmount ( const int amount )

inline

Sets the amount to scroll in pixels when the left scroll button is pushed.

Parameters

amount The amount to scroll in pixels.

See also: getLeftButtonScrollAmount

Definition at line 341 of file scrollarea.h.

342 { mLeftButtonScrollAmount = amount; }

References mLeftButtonScrollAmount.

Referenced by init().

◆ setOpaque()

void ScrollArea::setOpaque ( Opaque opaque )

Sets whether the widget should draw its background or not.

Definition at line 497 of file scrollarea.cpp.

 {
     mOpaque = opaque;
     setFrameSize(mOpaque == Opaque_true ? 2 : 0);
 }

References mOpaque, Opaque_true, and Widget::setFrameSize().

Referenced by init().

◆ setRightButtonScrollAmount()

void ScrollArea::setRightButtonScrollAmount ( const int amount )

inline

Sets the amount to scroll in pixels when the right scroll button is pushed.

Parameters

amount The amount to scroll in pixels.

See also: getRightButtonScrollAmount

Definition at line 351 of file scrollarea.h.

352 { mRightButtonScrollAmount = amount; }

References mRightButtonScrollAmount.

Referenced by init().

◆ setScrollAmount()

void ScrollArea::setScrollAmount	(	const int	hScroll,
		const int	vScroll
	)

Sets the amount to scroll horizontally and vertically.

Parameters

hScroll	The amount to scroll on horizontal scroll.
vScroll	The amount to scroll on vertical scroll.

See also: getHorizontalScrollAmount, getVerticalScrollAmount

Definition at line 1260 of file scrollarea.cpp.

 {
     setHorizontalScrollAmount(hScroll);
     setVerticalScrollAmount(vScroll);
 }

References setHorizontalScrollAmount(), and setVerticalScrollAmount().

Referenced by ChatTab::ChatTab().

◆ setScrollbarWidth()

void ScrollArea::setScrollbarWidth ( const int width )

Sets the width of the scroll bars.

Parameters

width The width of the scroll bars.

See also: getScrollbarWidth

Definition at line 1302 of file scrollarea.cpp.

 {
     if (width > 0)
         mScrollbarWidth = width;
 }

References mScrollbarWidth.

◆ setScrollPolicy()

void ScrollArea::setScrollPolicy	(	const ScrollPolicy	hPolicy,
		const ScrollPolicy	vPolicy
	)

Sets the horizontal and vertical scrollbar policy.

Parameters

hPolicy	The policy for the horizontal scrollbar.
vPolicy	The policy for the vertical scrollbar.

See also: getVerticalScrollPolicy, getHorizontalScrollPolicy

Definition at line 1227 of file scrollarea.cpp.

 {
     mHPolicy = hPolicy;
     mVPolicy = vPolicy;
     checkPolicies();
 }

References checkPolicies(), mHPolicy, and mVPolicy.

Referenced by ChatTab::ChatTab(), NpcDialog::NpcDialog(), and Setup_Colors::Setup_Colors().

◆ setUpButtonScrollAmount()

void ScrollArea::setUpButtonScrollAmount ( const int amount )

inline

Sets the amount to scroll in pixels when the up scroll button is pushed.

Parameters

amount The amount to scroll in pixels.

See also: getUpButtonScrollAmount

Definition at line 361 of file scrollarea.h.

362 { mUpButtonScrollAmount = amount; }

References mUpButtonScrollAmount.

Referenced by init().

◆ setVerticalScrollAmount()

void ScrollArea::setVerticalScrollAmount ( const int vScroll )

Sets the amount to scroll vertically.

Parameters

vScroll The amount to scroll.

See also: getVerticalScrollAmount

Definition at line 1235 of file scrollarea.cpp.

 {
     const int max = getVerticalMaxScroll();
  
     mVScroll = vScroll;
  
     if (vScroll > max)
         mVScroll = max;
  
     if (vScroll < 0)
         mVScroll = 0;
 }

References getVerticalMaxScroll(), and mVScroll.

Referenced by ChatTab::addNewRow(), NpcDialog::addText(), NpcDialog::buildLayout(), ChatTab::chatLog(), DidYouKnowWindow::loadData(), HelpWindow::loadHelp(), HelpWindow::loadHelpSimple(), UpdaterWindow::loadNews(), UpdaterWindow::loadPatch(), logic(), UpdaterWindow::logic(), mouseDragged(), mousePressed(), mouseReleased(), mouseWheelMovedDown(), mouseWheelMovedUp(), HelpWindow::search(), ServerDialog::ServerDialog(), setScrollAmount(), showWidgetPart(), WhoIsOnline::updateWindow(), and TabbedArea::widgetResized().

◆ setVerticalScrollPolicy()

void ScrollArea::setVerticalScrollPolicy ( const ScrollPolicy vPolicy )

Sets the vertical scrollbar policy. See enum with policies.

Parameters

vPolicy The policy for the vertical scrollbar.

See also: getVerticalScrollPolicy

Definition at line 1221 of file scrollarea.cpp.

 {
     mVPolicy = vPolicy;
     checkPolicies();
 }

References checkPolicies(), and mVPolicy.

Referenced by SkillDialog::addDefaultTab(), SocialTab::createControls(), SkillDialog::loadXmlFile(), NpcDialog::NpcDialog(), PopupMenu::PopupMenu(), EmoteWindow::postInit(), SetupTabScroll::SetupTabScroll(), StatsPage::StatsPage(), and StatsPageBasic::StatsPageBasic().

◆ setWidth()

void ScrollArea::setWidth ( int width )

Definition at line 1342 of file scrollarea.cpp.

 {
     Widget::setWidth(width);
     checkPolicies();
 }

References checkPolicies(), and Widget::setWidth().

Referenced by PopupList::adjustSize(), Setup_Video::Setup_Video(), PopupMenu::showPopup(), and SetupTabScroll::widgetResized().

◆ showWidgetPart()

void ScrollArea::showWidgetPart	(	Widget *const	widget,
		const Rect &	area
	)

virtual

Shows a certain part of a widget in the basic container. Used when widgets want a specific part to be visible in its parent. An example is a TextArea that wants a specific part of its text to be visible when a TextArea is a child of a ScrollArea.

Parameters

widget	The widget whom wants a specific part of itself to be visible.
area	The rectangle to be visible.

Reimplemented from BasicContainer.

Definition at line 1308 of file scrollarea.cpp.

 {
     const Widget *const content = getContent();
     if (widget != content || (content == nullptr))
         return;
  
     BasicContainer::showWidgetPart(widget, area);
  
     setHorizontalScrollAmount(content->getFrameSize()
         - content->getX());
     setVerticalScrollAmount(content->getFrameSize()
         - content->getY());
 }

References getContent(), Widget::getFrameSize(), Widget::getX(), Widget::getY(), setHorizontalScrollAmount(), setVerticalScrollAmount(), and BasicContainer::showWidgetPart().

◆ updateAlpha()

void ScrollArea::updateAlpha ( )

Update the alpha value to the graphic components.

Definition at line 320 of file scrollarea.cpp.

 {
     const float alpha = std::max(settings.guiAlpha,
         theme->getMinimumOpacity());
  
     if (alpha != mAlpha)
     {
         mAlpha = alpha;
         for (int a = 0; a < 9; a++)
         {
             if (background.grid[a] != nullptr)
                 background.grid[a]->setAlpha(mAlpha);
             if (hBackground.grid[a] != nullptr)
                 hBackground.grid[a]->setAlpha(mAlpha);
             if (vBackground.grid[a] != nullptr)
                 vBackground.grid[a]->setAlpha(mAlpha);
             if (vMarker.grid[a] != nullptr)
                 vMarker.grid[a]->setAlpha(mAlpha);
             if (vMarkerHi.grid[a] != nullptr)
                 vMarkerHi.grid[a]->setAlpha(mAlpha);
         }
     }
 }

References background, Theme::getMinimumOpacity(), ImageRect::grid, Settings::guiAlpha, hBackground, mAlpha, settings, theme, vBackground, vMarker, and vMarkerHi.

Referenced by draw(), and safeDraw().

◆ updateCalcFlag()

void ScrollArea::updateCalcFlag ( const Graphics *const graphics )

protected

Definition at line 430 of file scrollarea.cpp.

 {
     if (!mRedraw)
     {
         // because we don't know where parent windows was moved,
         // need recalc vertexes
         const ClipRect &rect = graphics->getTopClip();
         if (rect.xOffset != mXOffset || rect.yOffset != mYOffset)
         {
             mRedraw = true;
             mXOffset = rect.xOffset;
             mYOffset = rect.yOffset;
         }
         else if (rect.width != mDrawWidth || rect.height != mDrawHeight)
         {
             mRedraw = true;
             mDrawWidth = rect.width;
             mDrawHeight = rect.height;
         }
         else if (graphics->getRedraw())
         {
             mRedraw = true;
         }
     }
 }

References Graphics::getRedraw(), Graphics::getTopClip(), Rect::height, mDrawHeight, mDrawWidth, Widget::mRedraw, mXOffset, mYOffset, Rect::width, ClipRect::xOffset, and ClipRect::yOffset.

Referenced by draw(), drawFrame(), and safeDrawFrame().

◆ widgetMoved()

void ScrollArea::widgetMoved ( const Event & event )

virtual

Invoked when a widget is moved.

Parameters

event Describes the event.

Reimplemented from WidgetListener.

Definition at line 771 of file scrollarea.cpp.

 {
     mRedraw = true;
 }

References Widget::mRedraw.

◆ widgetResized()

void ScrollArea::widgetResized ( const Event & event )

virtual

Invoked when a widget changes its size.

Parameters

event Describes the event.

Reimplemented from WidgetListener.

Definition at line 759 of file scrollarea.cpp.

 {
     mRedraw = true;
     Widget *const content = getContent();
     if (content != nullptr)
     {
         const unsigned int frameSize = 2 * mFrameSize;
         content->setSize(mDimension.width - frameSize,
             mDimension.height - frameSize);
     }
 }

References getContent(), Rect::height, Widget::mDimension, Widget::mFrameSize, Widget::mRedraw, Widget::setSize(), and Rect::width.

Field Documentation

◆ background

ImageRect ScrollArea::background

staticprotected

Definition at line 476 of file scrollarea.h.

Referenced by drawFrame(), init(), safeDrawFrame(), updateAlpha(), and ~ScrollArea().

◆ buttons

Image * ScrollArea::buttons

staticprotected

Definition at line 481 of file scrollarea.h.

Referenced by getImageByState(), init(), and ~ScrollArea().

◆ hBackground

ImageRect ScrollArea::hBackground

staticprotected

Definition at line 480 of file scrollarea.h.

Referenced by calcHBar(), drawHBar(), init(), updateAlpha(), and ~ScrollArea().

◆ instances

int ScrollArea::instances = 0

staticprotected

Definition at line 471 of file scrollarea.h.

Referenced by init(), and ~ScrollArea().

◆ mAlpha

float ScrollArea::mAlpha = 1.0

staticprotected

Definition at line 472 of file scrollarea.h.

Referenced by updateAlpha().

◆ mClickX

int ScrollArea::mClickX

protected

Definition at line 543 of file scrollarea.h.

Referenced by mousePressed(), and mouseReleased().

◆ mClickY

int ScrollArea::mClickY

protected

Definition at line 544 of file scrollarea.h.

Referenced by mousePressed(), and mouseReleased().

◆ mDownButtonPressed

bool ScrollArea::mDownButtonPressed

protected

True if the down button is pressed, false otherwise.

Definition at line 568 of file scrollarea.h.

Referenced by getImageByState(), logic(), mousePressed(), and mouseReleased().

◆ mDownButtonScrollAmount

int ScrollArea::mDownButtonScrollAmount

protected

Holds the down button scroll amount.

Definition at line 519 of file scrollarea.h.

Referenced by getDownButtonScrollAmount(), logic(), mousePressed(), and setDownButtonScrollAmount().

◆ mDrawHeight

int ScrollArea::mDrawHeight

protected

Definition at line 548 of file scrollarea.h.

Referenced by updateCalcFlag().

◆ mDrawWidth

int ScrollArea::mDrawWidth

protected

Definition at line 547 of file scrollarea.h.

Referenced by updateCalcFlag().

◆ mHasMouse

bool ScrollArea::mHasMouse

protected

Definition at line 596 of file scrollarea.h.

Referenced by calcHMarker(), calcVMarker(), drawHMarker(), drawVMarker(), mouseEntered(), and mouseExited().

◆ mHBarVisible

bool ScrollArea::mHBarVisible

protected

True if the horizontal scroll bar is visible, false otherwise.

Definition at line 558 of file scrollarea.h.

Referenced by checkPolicies(), draw(), getChildrenArea(), getDownButtonDimension(), getHorizontalBarDimension(), getHorizontalMarkerDimension(), getLeftButtonDimension(), getRightButtonDimension(), getVerticalBarDimension(), getVerticalMarkerDimension(), isSelectable(), logic(), and safeDraw().

◆ mHorizontalMarkerDragOffset

int ScrollArea::mHorizontalMarkerDragOffset

protected

Holds the horizontal markers drag offset.

Definition at line 534 of file scrollarea.h.

Referenced by mouseDragged(), and mousePressed().

◆ mHPolicy

ScrollPolicy ScrollArea::mHPolicy

protected

Holds the horizontal scroll bar policy.

Definition at line 489 of file scrollarea.h.

Referenced by checkPolicies(), getHorizontalScrollPolicy(), logic(), setHorizontalScrollPolicy(), and setScrollPolicy().

◆ mHScroll

int ScrollArea::mHScroll

protected

Holds the horizontal scroll amount.

Definition at line 504 of file scrollarea.h.

Referenced by getHorizontalMarkerDimension(), getHorizontalScrollAmount(), logic(), mousePressed(), mouseReleased(), and setHorizontalScrollAmount().

◆ mIsHorizontalMarkerDragged

bool ScrollArea::mIsHorizontalMarkerDragged

protected

True if the horizontal marked is dragged.

Definition at line 588 of file scrollarea.h.

Referenced by mouseDragged(), mousePressed(), and mouseReleased().

◆ mIsVerticalMarkerDragged

bool ScrollArea::mIsVerticalMarkerDragged

protected

True if the vertical marked is dragged.

Definition at line 583 of file scrollarea.h.

Referenced by mouseDragged(), mousePressed(), and mouseReleased().

◆ mLeftButtonPressed

bool ScrollArea::mLeftButtonPressed

protected

True if the left button is pressed, false otherwise.

Definition at line 573 of file scrollarea.h.

Referenced by getImageByState(), logic(), mousePressed(), and mouseReleased().

◆ mLeftButtonScrollAmount

int ScrollArea::mLeftButtonScrollAmount

protected

Holds the left button scroll amount.

Definition at line 524 of file scrollarea.h.

Referenced by getLeftButtonScrollAmount(), logic(), mousePressed(), and setLeftButtonScrollAmount().

◆ mMarkerSize

int ScrollArea::mMarkerSize = 0

staticprotected

Definition at line 474 of file scrollarea.h.

Referenced by getHorizontalMarkerDimension(), getVerticalMarkerDimension(), and init().

◆ mOpaque

Opaque ScrollArea::mOpaque

protected

True if the scroll area should be opaque (that is display its background), false otherwise.

Definition at line 594 of file scrollarea.h.

Referenced by draw(), drawFrame(), init(), isOpaque(), safeDrawFrame(), ScrollArea(), and setOpaque().

◆ mRightButtonPressed

bool ScrollArea::mRightButtonPressed

protected

True if the right button is pressed, false otherwise.

Definition at line 578 of file scrollarea.h.

Referenced by getImageByState(), logic(), mousePressed(), and mouseReleased().

◆ mRightButtonScrollAmount

int ScrollArea::mRightButtonScrollAmount

protected

Holds the right button scroll amount.

Definition at line 529 of file scrollarea.h.

Referenced by getRightButtonScrollAmount(), logic(), mousePressed(), and setRightButtonScrollAmount().

◆ mScrollbarSize

int ScrollArea::mScrollbarSize = 12

staticprotected

Definition at line 475 of file scrollarea.h.

Referenced by init().

◆ mScrollbarWidth

int ScrollArea::mScrollbarWidth

protected

Holds the width of the scroll bars.

Definition at line 509 of file scrollarea.h.

Referenced by calcHMarker(), calcVMarker(), checkPolicies(), drawHMarker(), drawVMarker(), getChildrenArea(), getDownButtonDimension(), getHorizontalBarDimension(), getHorizontalMarkerDimension(), getLeftButtonDimension(), getRightButtonDimension(), getScrollbarWidth(), getUpButtonDimension(), getVerticalBarDimension(), getVerticalMarkerDimension(), init(), logic(), and setScrollbarWidth().

◆ mShowButtons

bool ScrollArea::mShowButtons = true

staticprotected

Definition at line 473 of file scrollarea.h.

Referenced by draw(), getDownButtonDimension(), getHorizontalBarDimension(), getHorizontalMarkerDimension(), getLeftButtonDimension(), getRightButtonDimension(), getUpButtonDimension(), getVerticalBarDimension(), getVerticalMarkerDimension(), init(), and safeDraw().

◆ mUpButtonPressed

bool ScrollArea::mUpButtonPressed

protected

True if the up button is pressed, false otherwise.

Definition at line 563 of file scrollarea.h.

Referenced by getImageByState(), logic(), mousePressed(), and mouseReleased().

◆ mUpButtonScrollAmount

int ScrollArea::mUpButtonScrollAmount

protected

Holds the up button scroll amount.

Definition at line 514 of file scrollarea.h.

Referenced by getUpButtonScrollAmount(), logic(), mousePressed(), and setUpButtonScrollAmount().

◆ mVBarVisible

bool ScrollArea::mVBarVisible

protected

True if the vertical scroll bar is visible, false otherwise.

Definition at line 553 of file scrollarea.h.

Referenced by checkPolicies(), draw(), getChildrenArea(), getDownButtonDimension(), getHorizontalBarDimension(), getHorizontalMarkerDimension(), getRightButtonDimension(), getUpButtonDimension(), getVerticalBarDimension(), getVerticalMarkerDimension(), isSelectable(), logic(), and safeDraw().

◆ mVertexes

ImageCollection* ScrollArea::mVertexes

protected

Definition at line 483 of file scrollarea.h.

Referenced by calcButton(), calcHBar(), calcHMarker(), calcVBar(), calcVMarker(), draw(), and ~ScrollArea().

◆ mVertexes2

ImageCollection* ScrollArea::mVertexes2

protected

Definition at line 484 of file scrollarea.h.

Referenced by drawFrame(), and ~ScrollArea().

◆ mVerticalMarkerDragOffset

int ScrollArea::mVerticalMarkerDragOffset

protected

Holds the vertical markers drag offset.

Definition at line 539 of file scrollarea.h.

Referenced by mouseDragged(), and mousePressed().

◆ mVPolicy

ScrollPolicy ScrollArea::mVPolicy

protected

Holds the vertical scroll bar policy.

Definition at line 494 of file scrollarea.h.

Referenced by checkPolicies(), getVerticalScrollPolicy(), logic(), setScrollPolicy(), and setVerticalScrollPolicy().

◆ mVScroll

int ScrollArea::mVScroll

protected

Holds the vertical scroll amount.

Definition at line 499 of file scrollarea.h.

Referenced by getVerticalMarkerDimension(), getVerticalScrollAmount(), logic(), mousePressed(), mouseReleased(), mouseWheelMovedDown(), mouseWheelMovedUp(), and setVerticalScrollAmount().

◆ mX

int ScrollArea::mX

protected

Definition at line 541 of file scrollarea.h.

Referenced by calcVMarker(), drawVMarker(), and mouseMoved().

◆ mXOffset

int ScrollArea::mXOffset

protected

Definition at line 545 of file scrollarea.h.

Referenced by updateCalcFlag().

◆ mY

int ScrollArea::mY

protected

Definition at line 542 of file scrollarea.h.

Referenced by calcHMarker(), drawHMarker(), and mouseMoved().

◆ mYOffset

int ScrollArea::mYOffset

protected

Definition at line 546 of file scrollarea.h.

Referenced by updateCalcFlag().

◆ vBackground

ImageRect ScrollArea::vBackground

staticprotected

Definition at line 479 of file scrollarea.h.

Referenced by calcVBar(), drawVBar(), init(), updateAlpha(), and ~ScrollArea().

◆ vMarker

ImageRect ScrollArea::vMarker

staticprotected

Definition at line 477 of file scrollarea.h.

Referenced by calcHMarker(), calcVMarker(), drawHMarker(), drawVMarker(), init(), updateAlpha(), and ~ScrollArea().

◆ vMarkerHi

ImageRect ScrollArea::vMarkerHi

staticprotected

Definition at line 478 of file scrollarea.h.

Referenced by calcHMarker(), calcVMarker(), drawHMarker(), drawVMarker(), init(), updateAlpha(), and ~ScrollArea().

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

src/gui/widgets/scrollarea.h (986a3bf)
src/gui/widgets/scrollarea.cpp (986a3bf)

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BUTTON_DIR

◆ ScrollPolicy

Constructor & Destructor Documentation

◆ ScrollArea()

◆ ~ScrollArea()

Member Function Documentation

◆ calcButton()

◆ calcHBar()

◆ calcHMarker()

◆ calcVBar()

◆ calcVMarker()

◆ checkPolicies()

◆ draw()

◆ drawButton()

◆ drawFrame()

◆ drawHBar()

◆ drawHMarker()

◆ drawVBar()

◆ drawVMarker()

◆ getChildrenArea()

◆ getContent()

◆ getDownButtonDimension()

◆ getDownButtonScrollAmount()

◆ getHorizontalBarDimension()

◆ getHorizontalMarkerDimension()

◆ getHorizontalMaxScroll()

◆ getHorizontalScrollAmount()

◆ getHorizontalScrollPolicy()

◆ getImageByState()

◆ getLeftButtonDimension()

◆ getLeftButtonScrollAmount()

◆ getRightButtonDimension()

◆ getRightButtonScrollAmount()

◆ getScrollbarWidth()

◆ getUpButtonDimension()

◆ getUpButtonScrollAmount()

◆ getVerticalBarDimension()

◆ getVerticalMarkerDimension()

◆ getVerticalMaxScroll()

◆ getVerticalScrollAmount()

◆ getVerticalScrollPolicy()

◆ getWidgetAt()

◆ init()

◆ isOpaque()

◆ isSelectable()

◆ logic()

◆ mouseDragged()

◆ mouseEntered()

◆ mouseExited()

◆ mouseMoved()

◆ mousePressed()

◆ mouseReleased()

◆ mouseWheelMovedDown()

◆ mouseWheelMovedUp()

◆ safeDraw()

◆ safeDrawFrame()

◆ setContent()

◆ setDimension()

◆ setDownButtonScrollAmount()

◆ setHeight()

◆ setHorizontalScrollAmount()

◆ setHorizontalScrollPolicy()

◆ setLeftButtonScrollAmount()

◆ setOpaque()

◆ setRightButtonScrollAmount()

◆ setScrollAmount()

◆ setScrollbarWidth()

◆ setScrollPolicy()

◆ setUpButtonScrollAmount()

◆ setVerticalScrollAmount()

◆ setVerticalScrollPolicy()