SetupQuickItem Class Reference

#include <setupquickitem.h>

Inheritance diagram for SetupQuickItem:

Public Member Functions
	SetupQuickItem (const std::string &description, SetupTabScroll *const parent, const std::string &eventName, ModifierGetFuncPtr getFunc, ModifierChangeFuncPtr changeFunc)
	~SetupQuickItem ()
void	createControls ()
void	fromWidget ()
void	toWidget ()
void	action (const ActionEvent &event)
void	apply (const std::string &eventName)
void	cancel (const std::string &eventName)
void	externalUpdated (const std::string &eventName)
void	rereadValue ()
void	save ()
void	gameModifiersChanged ()
Public Member Functions inherited from SetupItem
	~SetupItem ()
void	load ()
void	setWidget (Widget *widget)
Widget *	getWidget () const
Configuration *	getConfig () const
virtual std::string	getActionEventId () const
virtual void	doAction ()
virtual void	externalUnloaded (const std::string &eventName)
MainConfig	isMainConfig () const
void	fixFirstItemSize (Widget *const widget)
void	setValue (const std::string &str)
std::string	getValue () const
std::string	getEventName () const
Public Member Functions inherited from ActionListener
virtual	~ActionListener ()
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 GameModifierListener
	GameModifierListener ()
virtual	~ GameModifierListener ()

Protected Attributes
HorizontContainer *	mHorizont
Button *	mButton
Label *	mLabel
ModifierGetFuncPtr	mGetFunc
ModifierChangeFuncPtr	mChangeFunc
Protected Attributes inherited from SetupItem
std::string	mText
std::string	mDescription
std::string	mKeyName
SetupTabScroll *	mParent
std::string	mEventName
std::string	mValue
std::string	mDefault
Widget *	mWidget
std::list< Widget * >	mTempWidgets
int	mValueType
MainConfig	mMainConfig
bool	mUseDefault
Protected Attributes inherited from Widget2
int	mPaletteOffset
Widget *	mWindow
Color	mForegroundColor2

Additional Inherited Members
Public Types inherited from SetupItem
enum	{ VBOOL = 0 , VSTR , VINT , VNONE }
Static Public Member Functions inherited from GameModifierListener
static void	distributeEvent ()
static void	addListener (GameModifierListener *const listener)
static void	removeListener (const GameModifierListener *const listener)
Protected Member Functions inherited from SetupItem
	SetupItem (const std::string &text, const std::string &description, const std::string &keyName, SetupTabScroll *const parent, const std::string &eventName, const MainConfig mainConfig)
	SetupItem (const std::string &text, const std::string &description, const std::string &keyName, SetupTabScroll *const parent, const std::string &eventName, const std::string &def, const MainConfig mainConfig)
Protected Member Functions inherited from ActionListener
	ActionListener ()
Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Detailed Description

Definition at line 37 of file setupquickitem.h.

Constructor & Destructor Documentation

SetupQuickItem()

SetupQuickItem::SetupQuickItem	(	const std::string &	description,
		SetupTabScroll *const	parent,
		const std::string &	eventName,
		ModifierGetFuncPtr	getFunc,
		ModifierChangeFuncPtr	changeFunc
	)

Definition at line 33 of file setupquickitem.cpp.

                                                                       :
    SetupItem("", description, "", parent, eventName, MainConfig_false),
    GameModifierListener(),
    mHorizont(nullptr),
    mButton(nullptr),
    mLabel(nullptr),
    mGetFunc(getFunc),
    mChangeFunc(changeFunc)
{
    mValueType = VSTR;
    createControls();
}

References createControls(), SetupItem::mValueType, and SetupItem::VSTR.

~SetupQuickItem()

SetupQuickItem::~SetupQuickItem

(

)

Definition at line 50 of file setupquickitem.cpp.

{
    mHorizont = nullptr;
    mWidget = nullptr;
    mButton = nullptr;
}

References mButton, mHorizont, and SetupItem::mWidget.

Member Function Documentation

action()

void SetupQuickItem::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.

Reimplemented from SetupItem.

Definition at line 105 of file setupquickitem.cpp.

{
    if (event.getId() == mEventName + "_CHANGE")
    {
        // need change game modifier
        mChangeFunc(true);
        toWidget();
    }
}

References ActionEvent::getId(), mChangeFunc, SetupItem::mEventName, and toWidget().

apply()

void SetupQuickItem::apply ( const std::string &  eventName )

virtual

Reimplemented from SetupItem.

Definition at line 115 of file setupquickitem.cpp.

{
}

cancel()

void SetupQuickItem::cancel ( const std::string &  eventName )

virtual

Reimplemented from SetupItem.

Definition at line 61 of file setupquickitem.cpp.

{
}

createControls()

void SetupQuickItem::createControls

(

)

Definition at line 73 of file setupquickitem.cpp.

{
    mHorizont = new HorizontContainer(this, 32, 2);
 
    mWidget = new Button(this,
        ">",
        mEventName + "_CHANGE",
        BUTTON_SKIN,
        nullptr);
    mLabel = new Label(this, std::string());
    mLabel->setToolTip(mDescription);
    mLabel->adjustSize();
 
    mHorizont->add(mWidget, 5);
    mHorizont->add(mLabel);
 
    mParent->getContainer()->add2(mHorizont, true, 4);
    mParent->addControl(this);
    mWidget->addActionListener(this);
    toWidget();
}

References HorizontContainer::add(), VertContainer::add2(), Widget::addActionListener(), SetupTabScroll::addControl(), Label::adjustSize(), BUTTON_SKIN, SetupTabScroll::getContainer(), SetupItem::mDescription, SetupItem::mEventName, mHorizont, mLabel, SetupItem::mParent, SetupItem::mWidget, ToolTipListener::setToolTip(), and toWidget().

Referenced by SetupQuickItem().

externalUpdated()

void SetupQuickItem::externalUpdated ( const std::string &  eventName )

virtual

Reimplemented from SetupItem.

Definition at line 65 of file setupquickitem.cpp.

{
}

fromWidget()

void SetupQuickItem::fromWidget ( )

virtual

Implements SetupItem.

Definition at line 95 of file setupquickitem.cpp.

{
}

gameModifiersChanged()

void SetupQuickItem::gameModifiersChanged ( )

virtual

Implements GameModifierListener.

Definition at line 119 of file setupquickitem.cpp.

{
    toWidget();
}

References toWidget().

rereadValue()

void SetupQuickItem::rereadValue ( )

virtual

Reimplemented from SetupItem.

Definition at line 69 of file setupquickitem.cpp.

{
}

save()

void SetupQuickItem::save ( )

virtual

Reimplemented from SetupItem.

Definition at line 57 of file setupquickitem.cpp.

{
}

toWidget()

void SetupQuickItem::toWidget ( )

virtual

Implements SetupItem.

Definition at line 99 of file setupquickitem.cpp.

{
    mLabel->setCaption(mGetFunc());
    mLabel->adjustSize();
}

References Label::adjustSize(), mGetFunc, mLabel, and Label::setCaption().

Referenced by action(), createControls(), and gameModifiersChanged().

Field Documentation

mButton

Button* SetupQuickItem::mButton

protected

Definition at line 74 of file setupquickitem.h.

Referenced by ~SetupQuickItem().

mChangeFunc

ModifierChangeFuncPtr SetupQuickItem::mChangeFunc

protected

Definition at line 77 of file setupquickitem.h.

Referenced by action().

mGetFunc

ModifierGetFuncPtr SetupQuickItem::mGetFunc

protected

Definition at line 76 of file setupquickitem.h.

Referenced by toWidget().

mHorizont

HorizontContainer* SetupQuickItem::mHorizont

protected

Definition at line 73 of file setupquickitem.h.

Referenced by createControls(), and ~SetupQuickItem().

mLabel

Label* SetupQuickItem::mLabel

protected

Definition at line 75 of file setupquickitem.h.

Referenced by createControls(), and toWidget().

---

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

• src/gui/widgets/setupquickitem.h (986a3bf)
• src/gui/widgets/setupquickitem.cpp (986a3bf)