#include <sliderlist.h>

Inheritance diagram for SliderList:

Public Member Functions
	SliderList (const Widget2 const widget, ListModel const listModel)

	~SliderList ()

void	postInit2 (ActionListener *const listener, const std::string &eventId)

void	updateAlpha ()

void	mouseWheelMovedUp (MouseEvent &event)

void	mouseWheelMovedDown (MouseEvent &event)

void	resize ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	action (const ActionEvent &event)

void	setSelectedString (const std::string &str)

std::string	getSelectedString () const

void	setSelected (const int idx)

void	adjustSize ()

int	getSelected () const

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

	~Container ()

bool	safeRemove (Widget *const widget)

void	removeControls ()

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

	~BasicContainer2 ()

void	setOpaque (Opaque opaque)

bool	isOpaque () const

virtual void	add (Widget *const widget)

void	addXY (Widget *const widget, const int x, const int y)

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

	~BasicContainer ()

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

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

Rect	getChildrenArea ()

void	focusNext ()

void	focusPrevious ()

void	logic ()

void	setFocusHandler (FocusHandler *const focusHandler)

void	setInternalFocusHandler (FocusHandler *const focusHandler)

Widget *	getWidgetAt (int x, int y)

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 ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

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)

virtual bool	isSelectable () const

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 ActionListener
virtual	~ActionListener ()

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseEntered (MouseEvent &event)

virtual void	mouseExited (MouseEvent &event)

virtual void	mousePressed (MouseEvent &event)

virtual void	mouseReleased (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseMoved (MouseEvent &event)

virtual void	mouseDragged (MouseEvent &event)

Protected Member Functions
void	updateLabel ()

int	getMaxLabelWidth () const

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 ActionListener
	ActionListener ()

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Attributes
Button *	mButtons [2]

Label *	mLabel

ListModel *	mListModel

std::string	mPrevEventId

std::string	mNextEventId

int	mOldWidth

int	mSelectedIndex

Protected Attributes inherited from BasicContainer2
Opaque	mOpaque

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

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

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

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

Detailed Description

Definition at line 36 of file sliderlist.h.

Constructor & Destructor Documentation

◆ SliderList()

SliderList::SliderList	(	const Widget2 *const	widget,
		ListModel *const	listModel
	)

Definition at line 39 of file sliderlist.cpp.

                                                    :
     Container(widget),
     ActionListener(),
     MouseListener(),
     mButtons(),
     mLabel(new Label(this)),
     mListModel(listModel),
     mPrevEventId(),
     mNextEventId(),
     mOldWidth(0),
     mSelectedIndex(0)
 {
     mAllowLogic = false;
     setHeight(sliderHeight);
 }

References Widget::mAllowLogic, Widget::setHeight(), and sliderHeight.

◆ ~SliderList()

SliderList::~SliderList ( )

Definition at line 87 of file sliderlist.cpp.

88 {

89 }

Member Function Documentation

◆ action()

void SliderList::action ( const ActionEvent & actionEvent )

virtual

Called when an action is recieved from a widget. It is used to be able to recieve a notification that an action has occured.

Parameters

actionEvent The event of the action.

Implements ActionListener.

Definition at line 168 of file sliderlist.cpp.

 {
     if (mListModel == nullptr)
         return;
  
     const std::string &eventId = event.getId();
     if (eventId == mPrevEventId)
     {
         mSelectedIndex --;
         if (mSelectedIndex < 0)
             mSelectedIndex = mListModel->getNumberOfElements() - 1;
     }
     else if (eventId == mNextEventId)
     {
         mSelectedIndex ++;
         if (mSelectedIndex >= mListModel->getNumberOfElements())
             mSelectedIndex = 0;
     }
     updateLabel();
     distributeActionEvent();
 }

References Widget::distributeActionEvent(), ListModel::getNumberOfElements(), mListModel, mNextEventId, mPrevEventId, mSelectedIndex, and updateLabel().

◆ adjustSize()

void SliderList::adjustSize ( )

Definition at line 227 of file sliderlist.cpp.

 {
     setWidth(getMaxLabelWidth() + 60);
     updateLabel();
 }

References getMaxLabelWidth(), Widget::setWidth(), and updateLabel().

Referenced by SetupItemSliderList::createControls().

◆ draw()

void SliderList::draw ( Graphics *const graphics )

virtual

Draws the widget. It is called by the parent widget when it is time for the widget to draw itself. The graphics object is set up so that all drawing is relative to the widget, i.e coordinate (0,0) is the top left corner of the widget. It is not possible to draw outside of a widget's dimension.

Parameters

graphics aA graphics object to draw with.

Reimplemented from BasicContainer2.

Definition at line 120 of file sliderlist.cpp.

 {
     BLOCK_START("SliderList::draw")
     const int width = mDimension.width;
     if (mOldWidth != width)
     {
         resize();
         mOldWidth = width;
     }
     Container::draw(graphics);
     BLOCK_END("SliderList::draw")
 }

References BLOCK_END, BLOCK_START, BasicContainer2::draw(), Widget::mDimension, mOldWidth, resize(), and Rect::width.

◆ getMaxLabelWidth()

int SliderList::getMaxLabelWidth ( ) const

protected

Definition at line 233 of file sliderlist.cpp.

 {
     if ((mListModel == nullptr) || (gui == nullptr))
         return 1;
  
     int maxWidth = 0;
     const Font *const font = getFont();
  
     const int num = mListModel->getNumberOfElements();
     for (int f = 0; f < num; f ++)
     {
         const int w = font->getWidth(mListModel->getElementAt(f));
         if (w > maxWidth)
             maxWidth = w;
     }
  
     return maxWidth;
 }

References ListModel::getElementAt(), Widget::getFont(), ListModel::getNumberOfElements(), Font::getWidth(), gui, and mListModel.

Referenced by adjustSize().

◆ getSelected()

int SliderList::getSelected ( ) const

inline

Definition at line 73 of file sliderlist.h.

74 { return mSelectedIndex; }

References mSelectedIndex.

Referenced by SetupItemSound::action(), and SetupItemSliderInt::fromWidget().

◆ getSelectedString()

std::string SliderList::getSelectedString ( ) const

Definition at line 205 of file sliderlist.cpp.

 {
     if (mListModel == nullptr)
         return std::string();
  
     return mListModel->getElementAt(mSelectedIndex);
 }

References ListModel::getElementAt(), mListModel, and mSelectedIndex.

Referenced by SetupItemSound::action(), and SetupItemSliderList::fromWidget().

◆ mouseWheelMovedDown()

void SliderList::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 103 of file sliderlist.cpp.

 {
     setSelected(mSelectedIndex + 1);
     event.consume();
 }

References mSelectedIndex, and setSelected().

◆ mouseWheelMovedUp()

void SliderList::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 97 of file sliderlist.cpp.

 {
     setSelected(mSelectedIndex - 1);
     event.consume();
 }

References mSelectedIndex, and setSelected().

◆ postInit2()

void SliderList::postInit2	(	ActionListener *const	listener,
		const std::string &	eventId
	)

Definition at line 56 of file sliderlist.cpp.

 {
     mPrevEventId = eventId + "_prev";
     mNextEventId = eventId + "_next";
  
     mButtons[0] = new Button(this,
         "<",
         mPrevEventId,
         BUTTON_SKIN,
         this);
     mButtons[1] = new Button(this,
         ">",
         mNextEventId,
         BUTTON_SKIN,
         this);
  
     add(mButtons[0]);
     add(mLabel);
     add(mButtons[1]);
  
     if (!eventId.empty())
         setActionEventId(eventId);
  
     if (listener != nullptr)
         addActionListener(listener);
  
     updateLabel();
     addMouseListener(this);
 }

References BasicContainer2::add(), Widget::addActionListener(), Widget::addMouseListener(), BUTTON_SKIN, anonymous_namespace{itemlinkhandler.cpp}::listener, mButtons, mLabel, mNextEventId, mPrevEventId, Widget::setActionEventId(), and updateLabel().

Referenced by SetupItemSliderList::createControls().

◆ resize()

void SliderList::resize ( )

Definition at line 109 of file sliderlist.cpp.

 {
     const int width = getWidth();
  
     mButtons[0]->setWidth(buttonWidth);
     mLabel->setWidth(width - buttonSpace * 2);
     mButtons[1]->setPosition(width - buttonSpace + 3, 0);
     mButtons[1]->setWidth(buttonWidth);
     updateLabel();
 }

References buttonSpace, buttonWidth, Widget::getWidth(), mButtons, mLabel, Widget::setPosition(), Widget::setWidth(), and updateLabel().

Referenced by draw(), and safeDraw().

◆ safeDraw()

void SliderList::safeDraw ( Graphics *const graphics )

virtual

Reimplemented from BasicContainer2.

Definition at line 133 of file sliderlist.cpp.

 {
     BLOCK_START("SliderList::draw")
     const int width = mDimension.width;
     if (mOldWidth != width)
     {
         resize();
         mOldWidth = width;
     }
     Container::draw(graphics);
     BLOCK_END("SliderList::draw")
 }

References BLOCK_END, BLOCK_START, BasicContainer2::draw(), Widget::mDimension, mOldWidth, resize(), and Rect::width.

◆ setSelected()

void SliderList::setSelected ( const int idx )

Definition at line 213 of file sliderlist.cpp.

 {
     if (mListModel == nullptr)
         return;
  
     mSelectedIndex = idx;
     const int num = mListModel->getNumberOfElements();
     if (mSelectedIndex >= num)
         mSelectedIndex = 0;
     if (mSelectedIndex < 0)
         mSelectedIndex = num - 1;
     updateLabel();
 }

References ListModel::getNumberOfElements(), mListModel, mSelectedIndex, and updateLabel().

Referenced by mouseWheelMovedDown(), mouseWheelMovedUp(), setSelectedString(), and SetupItemSliderInt::toWidget().

◆ setSelectedString()

void SliderList::setSelectedString ( const std::string & str )

Definition at line 190 of file sliderlist.cpp.

 {
     if (mListModel == nullptr)
         return;
  
     for (int f = 0; f < mListModel->getNumberOfElements(); f ++)
     {
         if (mListModel->getElementAt(f) == str)
         {
             setSelected(f);
             break;
         }
     }
 }

References ListModel::getElementAt(), ListModel::getNumberOfElements(), mListModel, and setSelected().

Referenced by SetupItemSliderList::createControls(), and SetupItemSliderList::toWidget().

◆ updateAlpha()

void SliderList::updateAlpha ( )

Definition at line 91 of file sliderlist.cpp.

 {
     mButtons[0]->updateAlpha();
     mButtons[1]->updateAlpha();
 }

References mButtons, and Button::updateAlpha().

◆ updateLabel()

void SliderList::updateLabel ( )

protected

Definition at line 146 of file sliderlist.cpp.

 {
     if ((mListModel == nullptr) || mSelectedIndex < 0
         || mSelectedIndex >= mListModel->getNumberOfElements())
     {
         return;
     }
  
     mLabel->setCaption(mListModel->getElementAt(mSelectedIndex));
     mLabel->adjustSize();
     const int space = mDimension.width - buttonSpace * 2;
     const int labelWidth = mLabel->getWidth();
     int labelY = (mDimension.height - mLabel->getHeight()) / 2;
     if (labelY < 0)
         labelY = 0;
  
     if (space < 0 || space < labelWidth)
         mLabel->setPosition(buttonSpace, labelY);
     else
         mLabel->setPosition(buttonSpace + (space - labelWidth) / 2, labelY);
 }

References Label::adjustSize(), buttonSpace, ListModel::getElementAt(), Widget::getHeight(), ListModel::getNumberOfElements(), Widget::getWidth(), Rect::height, Widget::mDimension, mLabel, mListModel, mSelectedIndex, Label::setCaption(), Widget::setPosition(), and Rect::width.

Referenced by action(), adjustSize(), postInit2(), resize(), and setSelected().

Field Documentation

◆ mButtons

Button* SliderList::mButtons[2]

protected

Definition at line 81 of file sliderlist.h.

Referenced by postInit2(), resize(), and updateAlpha().

◆ mLabel

Label* SliderList::mLabel

protected

Definition at line 82 of file sliderlist.h.

Referenced by postInit2(), resize(), and updateLabel().

◆ mListModel

ListModel* SliderList::mListModel

protected

Definition at line 83 of file sliderlist.h.

Referenced by action(), getMaxLabelWidth(), getSelectedString(), setSelected(), setSelectedString(), and updateLabel().

◆ mNextEventId

std::string SliderList::mNextEventId

protected

Definition at line 85 of file sliderlist.h.

Referenced by action(), and postInit2().

◆ mOldWidth

int SliderList::mOldWidth

protected

Definition at line 86 of file sliderlist.h.

Referenced by draw(), and safeDraw().

◆ mPrevEventId

std::string SliderList::mPrevEventId

protected

Definition at line 84 of file sliderlist.h.

Referenced by action(), and postInit2().

◆ mSelectedIndex

int SliderList::mSelectedIndex

protected

Definition at line 87 of file sliderlist.h.

Referenced by action(), getSelected(), getSelectedString(), mouseWheelMovedDown(), mouseWheelMovedUp(), setSelected(), and updateLabel().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SliderList()

◆ ~SliderList()

Member Function Documentation

◆ action()

◆ adjustSize()

◆ draw()

◆ getMaxLabelWidth()

◆ getSelected()

◆ getSelectedString()

◆ mouseWheelMovedDown()

◆ mouseWheelMovedUp()

◆ postInit2()

◆ resize()

◆ safeDraw()

◆ setSelected()

◆ setSelectedString()

◆ updateAlpha()

◆ updateLabel()

Field Documentation

◆ mButtons

◆ mLabel

◆ mListModel

◆ mNextEventId

◆ mOldWidth

◆ mPrevEventId

◆ mSelectedIndex