#include <setuptabscroll.h>

Inheritance diagram for SetupTabScroll:

Public Member Functions
	SetupTabScroll (const Widget2 *const widget)

	~SetupTabScroll ()

void	addControl (SetupItem *const widget)

void	addControl (SetupItem *const widget, const std::string &event)

VertContainer *	getContainer () const

void	apply ()

void	cancel ()

void	externalUpdated ()

void	externalUnloaded ()

void	action (const ActionEvent &event)

int	getPreferredFirstItemSize () const

void	widgetResized (const Event &event)

void	reread (const std::string &name)

void	clear ()

const std::set< SetupItem * > &	getAllItems () const

Public Member Functions inherited from SetupTab
const std::string &	getName () 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)

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

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)

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

virtual void	widgetMoved (const Event &event)

virtual void	widgetHidden (const Event &event)

virtual void	widgetShown (const Event &event)

Protected Member Functions
void	removeItems ()

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

void	setName (const std::string &name)

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

Protected Attributes
VertContainer *	mContainer

ScrollArea *	mScroll

std::map< std::string, SetupItem * >	mItems

std::set< SetupItem * >	mAllItems

int	mPreferredFirstItemSize

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 33 of file setuptabscroll.h.

Constructor & Destructor Documentation

◆ SetupTabScroll()

SetupTabScroll::SetupTabScroll ( const Widget2 *const widget )

explicit

Definition at line 32 of file setuptabscroll.cpp.

                                                           :
     SetupTab(widget),
     mContainer(new VertContainer(this, 25, false, 8)),
     mScroll(new ScrollArea(this, mContainer, Opaque_false, std::string())),
     mItems(),
     mAllItems(),
     mPreferredFirstItemSize(200)
 {
     mScroll->setHorizontalScrollPolicy(ScrollArea::SHOW_NEVER);
     mScroll->setVerticalScrollPolicy(ScrollArea::SHOW_AUTO);
     mScroll->setSelectable(false);
     mContainer->setSelectable(false);
 }

References mContainer, mScroll, ScrollArea::setHorizontalScrollPolicy(), Widget::setSelectable(), ScrollArea::setVerticalScrollPolicy(), ScrollArea::SHOW_AUTO, and ScrollArea::SHOW_NEVER.

◆ ~SetupTabScroll()

SetupTabScroll::~SetupTabScroll ( )

Definition at line 46 of file setuptabscroll.cpp.

 {
     mScroll = nullptr;
     delete2(mContainer)
     removeItems();
 }

References delete2, mContainer, mScroll, and removeItems().

Member Function Documentation

◆ action()

void SetupTabScroll::action ( const ActionEvent & actionEvent )

inlinevirtual

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 57 of file setuptabscroll.h.

58 { }

◆ addControl() [1/2]

void SetupTabScroll::addControl ( SetupItem *const widget )

Definition at line 74 of file setuptabscroll.cpp.

 {
     if (widget == nullptr)
         return;
     const std::string actionId = widget->getActionEventId();
     if (!actionId.empty())
     {
         const std::map<std::string, SetupItem*>::iterator iter
             = mItems.find(actionId);
         if (iter != mItems.end())
         {
             delete (*iter).second;
             mItems.erase(iter);
         }
         mItems[actionId] = widget;
     }
     mAllItems.insert(widget);
 }

References SetupItem::getActionEventId(), mAllItems, and mItems.

Referenced by SetupButtonItem::createControls(), SetupItemCheckBox::createControls(), SetupItemTextField::createControls(), SetupItemIntTextField::createControls(), SetupItemLabel::createControls(), SetupItemDropDown::createControls(), SetupItemDropDownStr::createControls(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), SetupItemSliderList::createControls(), SetupQuickItem::createControls(), and SetupActionDropDown::createControls().

◆ addControl() [2/2]

void SetupTabScroll::addControl	(	SetupItem *const	widget,
		const std::string &	event
	)

Definition at line 93 of file setuptabscroll.cpp.

 {
     const std::map<std::string, SetupItem*>::iterator iter
         = mItems.find(event);
     if (iter != mItems.end())
     {
         delete (*iter).second;
         mItems.erase(iter);
     }
     mItems[event] = widget;
     mAllItems.insert(widget);
 }

References mAllItems, and mItems.

◆ apply()

void SetupTabScroll::apply ( )

virtual

Called when the Apply button is pressed in the setup window.

Implements SetupTab.

Definition at line 107 of file setuptabscroll.cpp.

 {
     for (std::map<std::string, SetupItem*>::const_iterator
          iter = mItems.begin(), iter_end = mItems.end();
          iter != iter_end; ++ iter)
     {
         if ((*iter).second != nullptr)
             (*iter).second->apply((*iter).first);
     }
 }

References mItems.

Referenced by Setup_Audio::apply(), Setup_Chat::apply(), Setup_Misc::apply(), Setup_Mods::apply(), Setup_Players::apply(), and Setup_Visual::apply().

◆ cancel()

void SetupTabScroll::cancel ( )

virtual

Called when the Cancel button is pressed in the setup window.

Implements SetupTab.

Definition at line 118 of file setuptabscroll.cpp.

 {
     for (std::map<std::string, SetupItem*>::const_iterator
          iter = mItems.begin(), iter_end = mItems.end();
          iter != iter_end; ++ iter)
     {
         if ((*iter).second != nullptr)
             (*iter).second->cancel((*iter).first);
     }
 }

References mItems.

◆ clear()

void SetupTabScroll::clear ( )

virtual

Clears the basic container from all widgets.

See also: remove, clear

Reimplemented from BasicContainer.

Definition at line 67 of file setuptabscroll.cpp.

 {
     removeItems();
     mContainer->removeControls();
     mContainer->clear();
 }

References VertContainer::clear(), mContainer, Container::removeControls(), and removeItems().

Referenced by Setup_Mods::externalUnloaded(), and Setup_Mods::externalUpdated().

◆ externalUnloaded()

void SetupTabScroll::externalUnloaded ( )

virtual

Reimplemented from SetupTab.

Definition at line 141 of file setuptabscroll.cpp.

 {
     for (std::map<std::string, SetupItem*>::const_iterator
          iter = mItems.begin(), iter_end = mItems.end();
          iter != iter_end; ++ iter)
     {
         SetupItem *const widget = (*iter).second;
         if ((widget != nullptr) && widget->isMainConfig() == MainConfig_false)
             widget->externalUnloaded((*iter).first);
     }
 }

References SetupItem::externalUnloaded(), SetupItem::isMainConfig(), MainConfig_false, and mItems.

◆ externalUpdated()

void SetupTabScroll::externalUpdated ( )

virtual

Reimplemented from SetupTab.

Definition at line 129 of file setuptabscroll.cpp.

 {
     for (std::map<std::string, SetupItem*>::const_iterator
          iter = mItems.begin(), iter_end = mItems.end();
          iter != iter_end; ++ iter)
     {
         SetupItem *const widget = (*iter).second;
         if ((widget != nullptr) && widget->isMainConfig() == MainConfig_false)
             widget->externalUpdated((*iter).first);
     }
 }

References SetupItem::externalUpdated(), SetupItem::isMainConfig(), MainConfig_false, and mItems.

◆ getAllItems()

const std::set<SetupItem*>& SetupTabScroll::getAllItems ( ) const

inline

Definition at line 69 of file setuptabscroll.h.

70 { return mAllItems; }

References mAllItems.

Referenced by Setup_Mods::saveMods().

◆ getContainer()

VertContainer* SetupTabScroll::getContainer ( ) const

inline

Definition at line 46 of file setuptabscroll.h.

47 { return mContainer; }

References mContainer.

Referenced by SetupButtonItem::createControls(), SetupItemCheckBox::createControls(), SetupItemTextField::createControls(), SetupItemIntTextField::createControls(), SetupItemLabel::createControls(), SetupItemDropDown::createControls(), SetupItemDropDownStr::createControls(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), SetupItemSliderList::createControls(), SetupQuickItem::createControls(), and SetupActionDropDown::createControls().

◆ getPreferredFirstItemSize()

int SetupTabScroll::getPreferredFirstItemSize ( ) const

inline

Definition at line 60 of file setuptabscroll.h.

61 { return mPreferredFirstItemSize; }

References mPreferredFirstItemSize.

Referenced by SetupItem::fixFirstItemSize().

◆ removeItems()

void SetupTabScroll::removeItems ( )

protected

Definition at line 53 of file setuptabscroll.cpp.

 {
     std::set<SetupItem*>::iterator it = mAllItems.begin();
     const std::set<SetupItem*>::iterator it_end = mAllItems.end();
     while (it != it_end)
     {
         delete *it;
         ++ it;
     }
     mAllItems.clear();
  
     mItems.clear();
 }

References mAllItems, and mItems.

Referenced by clear(), and ~SetupTabScroll().

◆ reread()

void SetupTabScroll::reread ( const std::string & name )

Definition at line 159 of file setuptabscroll.cpp.

 {
     SetupItem *const item = mItems[name + "Event"];
     if (item != nullptr)
         item->rereadValue();
 }

References mItems, and SetupItem::rereadValue().

Referenced by Setup_Chat::externalUpdated(), Setup_Misc::externalUpdated(), and Setup_Players::externalUpdated().

◆ widgetResized()

void SetupTabScroll::widgetResized ( const Event & event )

virtual

Invoked when a widget changes its size.

Parameters

event Describes the event.

Reimplemented from WidgetListener.

Definition at line 153 of file setuptabscroll.cpp.

 {
     mScroll->setWidth(getWidth() - 12);
     mScroll->setHeight(getHeight() - 12 - 12);
 }

References Widget::getHeight(), Widget::getWidth(), mScroll, ScrollArea::setHeight(), and ScrollArea::setWidth().

Field Documentation

◆ mAllItems

std::set<SetupItem*> SetupTabScroll::mAllItems

protected

Definition at line 78 of file setuptabscroll.h.

Referenced by addControl(), getAllItems(), and removeItems().

◆ mContainer

VertContainer* SetupTabScroll::mContainer

protected

Definition at line 75 of file setuptabscroll.h.

Referenced by clear(), getContainer(), SetupTabScroll(), and ~SetupTabScroll().

◆ mItems

std::map<std::string, SetupItem*> SetupTabScroll::mItems

protected

Definition at line 77 of file setuptabscroll.h.

Referenced by addControl(), apply(), cancel(), externalUnloaded(), externalUpdated(), removeItems(), and reread().

◆ mPreferredFirstItemSize

int SetupTabScroll::mPreferredFirstItemSize

protected

Definition at line 79 of file setuptabscroll.h.

Referenced by getPreferredFirstItemSize(), and Setup_Visual::Setup_Visual().

◆ mScroll

ScrollArea* SetupTabScroll::mScroll

protected

Definition at line 76 of file setuptabscroll.h.

Referenced by Setup_Audio::Setup_Audio(), Setup_Chat::Setup_Chat(), Setup_Misc::Setup_Misc(), Setup_Mods::Setup_Mods(), Setup_Perfomance::Setup_Perfomance(), Setup_Players::Setup_Players(), Setup_Quick::Setup_Quick(), Setup_Touch::Setup_Touch(), Setup_Visual::Setup_Visual(), SetupTabScroll(), widgetResized(), and ~SetupTabScroll().

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

src/gui/widgets/tabs/setuptabscroll.h (986a3bf)
src/gui/widgets/tabs/setuptabscroll.cpp (986a3bf)

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SetupTabScroll()

◆ ~SetupTabScroll()

Member Function Documentation

◆ action()

◆ addControl() [1/2]

◆ addControl() [2/2]

◆ apply()

◆ cancel()

◆ clear()

◆ externalUnloaded()

◆ externalUpdated()

◆ getAllItems()

◆ getContainer()

◆ getPreferredFirstItemSize()

◆ removeItems()

◆ reread()

◆ widgetResized()

Field Documentation

◆ mAllItems

◆ mContainer

◆ mItems

◆ mPreferredFirstItemSize

◆ mScroll