SetupItem Class Reference

#include <setupitem.h>

Inheritance diagram for SetupItem:

Public Types
enum	{ VBOOL = 0 , VSTR , VINT , VNONE }

Public Member Functions
	~SetupItem ()
void	load ()
virtual void	save ()
virtual void	fromWidget ()=0
virtual void	toWidget ()=0
void	setWidget (Widget *widget)
Widget *	getWidget () const
Configuration *	getConfig () const
virtual std::string	getActionEventId () const
void	action (const ActionEvent &event)
virtual void	doAction ()
virtual void	apply (const std::string &eventName)
virtual void	cancel (const std::string &eventName)
virtual void	externalUpdated (const std::string &eventName)
virtual void	externalUnloaded (const std::string &eventName)
MainConfig	isMainConfig () const
void	fixFirstItemSize (Widget *const widget)
virtual void	rereadValue ()
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)

Protected Member Functions
	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)

Protected Attributes
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

Detailed Description

Definition at line 51 of file setupitem.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
VBOOL
VSTR
VINT
VNONE

Definition at line 55 of file setupitem.h.

        {
            VBOOL = 0,
            VSTR,
            VINT,
            VNONE
        };

Constructor & Destructor Documentation

~SetupItem()

SetupItem::~SetupItem

(

)

Definition at line 102 of file setupitem.cpp.

{
}

SetupItem() [1/2]

SetupItem::SetupItem ( const std::string &  text, const std::string &  description, const std::string &  keyName, SetupTabScroll *const  parent, const std::string &  eventName, const MainConfig  mainConfig  )

protected

Definition at line 55 of file setupitem.cpp.

                                                  :
    ActionListener(),
    Widget2(parent),
    mText(text),
    mDescription(description),
    mKeyName(keyName),
    mParent(parent),
    mEventName(eventName),
    mValue(),
    mDefault(),
    mWidget(nullptr),
    mTempWidgets(),
    mValueType(VBOOL),
    mMainConfig(mainConfig),
    mUseDefault(false)
{
}

SetupItem() [2/2]

SetupItem::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

Definition at line 78 of file setupitem.cpp.

                                                  :
    ActionListener(),
    Widget2(parent),
    mText(text),
    mDescription(description),
    mKeyName(keyName),
    mParent(parent),
    mEventName(eventName),
    mValue(),
    mDefault(def),
    mWidget(nullptr),
    mTempWidgets(),
    mValueType(VBOOL),
    mMainConfig(mainConfig),
    mUseDefault(true)
{
}

Member Function Documentation

action()

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

Reimplemented in SetupQuickItem, SetupItemSound, SetupItemSliderList, SetupItemSlider2, SetupItemSlider, SetupItemLabel, SetupItemIntTextField, and SetupItemTextField.

Definition at line 163 of file setupitem.cpp.

{
    if (mWidget == nullptr)
        return;
 
    if (event.getId() == mWidget->getActionEventId())
        doAction();
}

References doAction(), Widget::getActionEventId(), ActionEvent::getId(), and mWidget.

apply()

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

virtual

Reimplemented in SetupQuickItem, SetupItemSliderList, SetupItemSlider2, SetupItemSlider, SetupItemLabel, SetupItemIntTextField, SetupItemTextField, and SetupButtonItem.

Definition at line 177 of file setupitem.cpp.

{
    save();
}

References save().

cancel()

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

virtual

Reimplemented in SetupQuickItem, SetupItemTextField, and SetupButtonItem.

Definition at line 182 of file setupitem.cpp.

{
    load();
    toWidget();
}

References load(), and toWidget().

doAction()

void SetupItem::doAction ( )

virtual

Definition at line 172 of file setupitem.cpp.

{
    fromWidget();
}

References fromWidget().

Referenced by action().

externalUnloaded()

void SetupItem::externalUnloaded ( const std::string &  eventName )

virtual

Definition at line 194 of file setupitem.cpp.

{
}

Referenced by SetupTabScroll::externalUnloaded().

externalUpdated()

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

virtual

Reimplemented in SetupQuickItem, SetupItemTextField, and SetupButtonItem.

Definition at line 188 of file setupitem.cpp.

{
    load();
    toWidget();
}

References load(), and toWidget().

Referenced by SetupTabScroll::externalUpdated().

fixFirstItemSize()

void SetupItem::fixFirstItemSize

(

Widget *const

widget

)

Definition at line 198 of file setupitem.cpp.

{
    if (widget == nullptr)
        return;
    const int maxSize = mParent->getPreferredFirstItemSize();
    if (widget->getWidth() < maxSize)
        widget->setWidth(maxSize);
}

References SetupTabScroll::getPreferredFirstItemSize(), Widget::getWidth(), mParent, and Widget::setWidth().

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

fromWidget()

virtual void SetupItem::fromWidget ( )

pure virtual

Implemented in SetupActionDropDown, SetupQuickItem, SetupItemSliderInt, SetupItemSliderList, SetupItemSlider2, SetupItemSlider, SetupItemDropDownStr, SetupItemDropDown, SetupItemLabel, SetupItemIntTextField, SetupItemTextField, SetupItemCheckBox, and SetupButtonItem.

Referenced by doAction().

getActionEventId()

std::string SetupItem::getActionEventId ( ) const

virtual

Definition at line 155 of file setupitem.cpp.

{
    if (mWidget == nullptr)
        return std::string();
 
    return mWidget->getActionEventId();
}

References Widget::getActionEventId(), and mWidget.

Referenced by SetupTabScroll::addControl().

getConfig()

Configuration * SetupItem::getConfig

(

)

const

Definition at line 106 of file setupitem.cpp.

{
    if (mMainConfig == MainConfig_true)
        return &config;
    return &serverConfig;
}

References config, MainConfig_true, mMainConfig, and serverConfig.

Referenced by load(), and save().

getEventName()

std::string SetupItem::getEventName ( ) const

inline

Definition at line 110 of file setupitem.h.

        { return mEventName; }

References mEventName.

Referenced by Setup_Mods::saveMods().

getValue()

std::string SetupItem::getValue ( ) const

inline

Definition at line 107 of file setupitem.h.

        { return mValue; }

References mValue.

Referenced by Setup_Mods::saveMods().

getWidget()

Widget* SetupItem::getWidget ( ) const

inline

Definition at line 78 of file setupitem.h.

        { return mWidget; }

References mWidget.

isMainConfig()

MainConfig SetupItem::isMainConfig ( ) const

inline

Definition at line 97 of file setupitem.h.

        { return mMainConfig; }

References mMainConfig.

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

load()

void SetupItem::load

(

)

Definition at line 113 of file setupitem.cpp.

{
    if (mKeyName.empty())
        return;
 
    const Configuration *const cfg = getConfig();
    if (mUseDefault)
    {
        mValue = cfg->getValue(mKeyName, mDefault);
    }
    else
    {
        switch (mValueType)
        {
            case VBOOL:
                if (cfg->getBoolValue(mKeyName))
                    mValue = "1";
                else
                    mValue = "0";
                break;
            case VSTR:
            default:
                mValue = cfg->getStringValue(mKeyName);
                break;
            case VINT:
                mValue = toString(cfg->getIntValue(mKeyName));
                break;
            case VNONE:
                break;
        }
    }
}

References Configuration::getBoolValue(), getConfig(), Configuration::getIntValue(), Configuration::getStringValue(), ConfigurationObject::getValue(), mDefault, mKeyName, mUseDefault, mValue, mValueType, Catch::toString(), VBOOL, VINT, VNONE, and VSTR.

Referenced by cancel(), SetupItemTextField::cancel(), SetupItemCheckBox::createControls(), SetupItemTextField::createControls(), SetupItemIntTextField::createControls(), SetupItemDropDown::createControls(), SetupItemDropDownStr::createControls(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), SetupItemSliderList::createControls(), SetupActionDropDown::createControls(), externalUpdated(), SetupItemTextField::externalUpdated(), rereadValue(), and SetupItemTextField::rereadValue().

rereadValue()

void SetupItem::rereadValue ( )

virtual

Reimplemented in SetupQuickItem, SetupItemTextField, and SetupButtonItem.

Definition at line 207 of file setupitem.cpp.

{
    load();
    toWidget();
}

References load(), and toWidget().

Referenced by SetupTabScroll::reread().

save()

void SetupItem::save ( )

virtual

Reimplemented in SetupQuickItem, SetupItemTextField, and SetupButtonItem.

Definition at line 146 of file setupitem.cpp.

{
    if (mKeyName.empty())
        return;
 
    Configuration *const cfg = getConfig();
    cfg->setValue(mKeyName, mValue);
}

References getConfig(), mKeyName, mValue, and Configuration::setValue().

Referenced by SetupItemSlider::action(), SetupItemSlider2::action(), SetupItemSliderList::action(), apply(), SetupItemIntTextField::apply(), SetupItemSlider::apply(), SetupItemSlider2::apply(), SetupItemSliderList::apply(), and SetupItemTextField::save().

setValue()

void SetupItem::setValue ( const std::string &  str )

inline

Definition at line 104 of file setupitem.h.

        { mValue = str; }

References mValue.

Referenced by Setup_Mods::loadMods().

setWidget()

void SetupItem::setWidget ( Widget *  widget )

inline

Definition at line 75 of file setupitem.h.

        { mWidget = widget; }

References mWidget.

toWidget()

virtual void SetupItem::toWidget ( )

pure virtual

Implemented in SetupActionDropDown, SetupQuickItem, SetupItemSliderInt, SetupItemSliderList, SetupItemSlider2, SetupItemSlider, SetupItemDropDownStr, SetupItemDropDown, SetupItemLabel, SetupItemIntTextField, SetupItemTextField, SetupItemCheckBox, and SetupButtonItem.

Referenced by cancel(), externalUpdated(), Setup_Mods::loadMods(), and rereadValue().

Field Documentation

mDefault

std::string SetupItem::mDefault

protected

Definition at line 141 of file setupitem.h.

Referenced by load().

mDescription

std::string SetupItem::mDescription

protected

Definition at line 131 of file setupitem.h.

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

mEventName

std::string SetupItem::mEventName

protected

Definition at line 137 of file setupitem.h.

Referenced by SetupItemTextField::action(), SetupItemIntTextField::action(), SetupItemSound::action(), SetupQuickItem::action(), SetupItemSound::addMoreControls(), SetupItemTextField::apply(), SetupItemIntTextField::apply(), SetupItemSlider::apply(), SetupItemSlider2::apply(), SetupItemSliderList::apply(), SetupItemCheckBox::createControls(), SetupItemTextField::createControls(), SetupItemIntTextField::createControls(), SetupItemDropDown::createControls(), SetupItemDropDownStr::createControls(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), SetupItemSliderList::createControls(), SetupQuickItem::createControls(), SetupActionDropDown::createControls(), and getEventName().

mKeyName

std::string SetupItem::mKeyName

protected

Definition at line 133 of file setupitem.h.

Referenced by load(), and save().

mMainConfig

MainConfig SetupItem::mMainConfig

protected

Definition at line 149 of file setupitem.h.

Referenced by getConfig(), and isMainConfig().

mParent

SetupTabScroll* SetupItem::mParent

protected

Definition at line 135 of file setupitem.h.

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

mTempWidgets

std::list<Widget*> SetupItem::mTempWidgets

protected

Definition at line 145 of file setupitem.h.

mText

std::string SetupItem::mText

protected

Definition at line 129 of file setupitem.h.

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

mUseDefault

bool SetupItem::mUseDefault

protected

Definition at line 151 of file setupitem.h.

Referenced by load().

mValue

std::string SetupItem::mValue

protected

Definition at line 139 of file setupitem.h.

Referenced by SetupItemTextField::cancel(), SetupItemCheckBox::createControls(), SetupItemTextField::createControls(), SetupItemIntTextField::createControls(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), SetupItemSliderList::createControls(), SetupActionDropDown::createControls(), SetupItemTextField::externalUpdated(), SetupItemCheckBox::fromWidget(), SetupItemTextField::fromWidget(), SetupItemIntTextField::fromWidget(), SetupItemDropDown::fromWidget(), SetupItemDropDownStr::fromWidget(), SetupItemSlider::fromWidget(), SetupItemSlider2::fromWidget(), SetupItemSliderList::fromWidget(), SetupItemSliderInt::fromWidget(), SetupActionDropDown::fromWidget(), getValue(), load(), SetupItemTextField::rereadValue(), save(), SetupItemTextField::save(), SetupItemDropDown::selectionByValue(), SetupItemDropDownStr::selectionByValue(), setValue(), SetupItemCheckBox::toWidget(), SetupItemTextField::toWidget(), SetupItemIntTextField::toWidget(), SetupItemSlider::toWidget(), SetupItemSlider2::toWidget(), SetupItemSliderList::toWidget(), SetupItemSliderInt::toWidget(), and SetupActionDropDown::toWidget().

mValueType

int SetupItem::mValueType

protected

Definition at line 147 of file setupitem.h.

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

mWidget

Widget* SetupItem::mWidget

protected

Definition at line 143 of file setupitem.h.

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

---

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

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