SetupItemLabel Class Reference

#include <setupitem.h>

Inheritance diagram for SetupItemLabel:

Public Member Functions
	SetupItemLabel (const std::string &text, const std::string &description, SetupTabScroll *const parent, const Separator separator)
	~SetupItemLabel ()
void	createControls ()
void	fromWidget ()
void	toWidget ()
void	action (const ActionEvent &event)
void	apply (const std::string &eventName)
Public Member Functions inherited from SetupItem
	~SetupItem ()
void	load ()
virtual void	save ()
void	setWidget (Widget *widget)
Widget *	getWidget () const
Configuration *	getConfig () const
virtual std::string	getActionEventId () const
virtual void	doAction ()
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 Attributes
Label *	mLabel
Separator	mIsSeparator
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 }
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 285 of file setupitem.h.

Constructor & Destructor Documentation

SetupItemLabel()

SetupItemLabel::SetupItemLabel	(	const std::string &	text,
		const std::string &	description,
		SetupTabScroll *const	parent,
		const Separator	separator
	)

Definition at line 598 of file setupitem.cpp.

                                                          :
    SetupItem(text, description, "", parent, "", "", MainConfig_true),
    mLabel(nullptr),
    mIsSeparator(separator)
{
    mValueType = VNONE;
    createControls();
}

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

~SetupItemLabel()

SetupItemLabel::~SetupItemLabel

(

)

Definition at line 610 of file setupitem.cpp.

{
    mWidget = nullptr;
    mLabel = nullptr;
}

References mLabel, and SetupItem::mWidget.

Member Function Documentation

action()

void SetupItemLabel::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 645 of file setupitem.cpp.

{
}

apply()

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

virtual

Reimplemented from SetupItem.

Definition at line 649 of file setupitem.cpp.

{
}

createControls()

void SetupItemLabel::createControls

(

)

Definition at line 616 of file setupitem.cpp.

{
    if (mIsSeparator == Separator_true)
    {
        const std::string str(" \342\200\225\342\200\225\342\200\225"
            "\342\200\225\342\200\225 ");
        mLabel = new Label(this, std::string(str).append(mText).append(str));
    }
    else
    {
        mLabel = new Label(this, mText);
    }
    mLabel->setToolTip(mDescription);
 
    mWidget = mLabel;
    mParent->getContainer()->add1(mWidget, -1);
    mParent->addControl(this);
    mParent->addActionListener(this);
    mWidget->addActionListener(this);
}

References VertContainer::add1(), Widget::addActionListener(), SetupTabScroll::addControl(), SetupTabScroll::getContainer(), SetupItem::mDescription, mIsSeparator, mLabel, SetupItem::mParent, SetupItem::mText, SetupItem::mWidget, Separator_true, and ToolTipListener::setToolTip().

Referenced by SetupItemLabel().

fromWidget()

void SetupItemLabel::fromWidget ( )

virtual

Implements SetupItem.

Definition at line 637 of file setupitem.cpp.

{
}

toWidget()

void SetupItemLabel::toWidget ( )

virtual

Implements SetupItem.

Definition at line 641 of file setupitem.cpp.

{
}

Field Documentation

mIsSeparator

Separator SetupItemLabel::mIsSeparator

protected

Definition at line 309 of file setupitem.h.

Referenced by createControls().

mLabel

Label* SetupItemLabel::mLabel

protected

Definition at line 308 of file setupitem.h.

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

---

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

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