SetupItemSlider2 Class Reference

#include <setupitem.h>

Inheritance diagram for SetupItemSlider2:

Public Member Functions
	SetupItemSlider2 (const std::string &text, const std::string &description, const std::string &keyName, SetupTabScroll *const parent, const std::string &eventName, const int min, const int max, const int step, SetupItemNames *const values, const OnTheFly onTheFly, const MainConfig mainConfig, const DoNotAlign doNotAlign)
	SetupItemSlider2 (const std::string &text, const std::string &description, const std::string &keyName, SetupTabScroll *const parent, const std::string &eventName, const int min, const int max, const int step, SetupItemNames *const values, const std::string &def, const OnTheFly onTheFly, const MainConfig mainConfig, const DoNotAlign doNotAlign)
	~SetupItemSlider2 ()
void	createControls ()
void	fromWidget ()
void	toWidget ()
void	action (const ActionEvent &event)
void	apply (const std::string &eventName)
void	setInvertValue (const int v)
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 Member Functions
void	updateLabel ()
int	getMaxWidth ()
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)

Protected Attributes
HorizontContainer *	mHorizont
Label *	mLabel
Label *	mLabel2
Slider *	mSlider
SetupItemNames *	mValues
int	mMin
int	mMax
int	mStep
int	mInvertValue
bool	mInvert
OnTheFly	mOnTheFly
DoNotAlign	mDoNotAlign
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 }

Detailed Description

Definition at line 455 of file setupitem.h.

Constructor & Destructor Documentation

SetupItemSlider2() [1/2]

SetupItemSlider2::SetupItemSlider2	(	const std::string &	text,
		const std::string &	description,
		const std::string &	keyName,
		SetupTabScroll *const	parent,
		const std::string &	eventName,
		const int	min,
		const int	max,
		const int	step,
		SetupItemNames *const	values,
		const OnTheFly	onTheFly,
		const MainConfig	mainConfig,
		const DoNotAlign	doNotAlign
	)

Definition at line 991 of file setupitem.cpp.

 :
 SetupItem(text, description, keyName, parent, eventName, mainConfig),
 mHorizont(nullptr),
 mLabel(nullptr),
 mLabel2(nullptr),
 mSlider(nullptr),
 mValues(values),
 mMin(min),
 mMax(max),
 mStep(step),
 mInvertValue(0),
 mInvert(false),
 mOnTheFly(onTheFly),
 mDoNotAlign(doNotAlign)
{
 mValueType = VSTR;
 createControls();
}

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

SetupItemSlider2() [2/2]

SetupItemSlider2::SetupItemSlider2	(	const std::string &	text,
		const std::string &	description,
		const std::string &	keyName,
		SetupTabScroll *const	parent,
		const std::string &	eventName,
		const int	min,
		const int	max,
		const int	step,
		SetupItemNames *const	values,
		const std::string &	def,
		const OnTheFly	onTheFly,
		const MainConfig	mainConfig,
		const DoNotAlign	doNotAlign
	)

Definition at line 1021 of file setupitem.cpp.

 :
 SetupItem(text, description, keyName, parent, eventName, def, mainConfig),
 mHorizont(nullptr),
 mLabel(nullptr),
 mLabel2(nullptr),
 mSlider(nullptr),
 mValues(values),
 mMin(min),
 mMax(max),
 mStep(step),
 mInvertValue(0),
 mInvert(false),
 mOnTheFly(onTheFly),
 mDoNotAlign(doNotAlign)
{
 mValueType = VSTR;
 createControls();
}

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

~SetupItemSlider2()

SetupItemSlider2::~SetupItemSlider2

(

)

Definition at line 1052 of file setupitem.cpp.

{
 mHorizont = nullptr;
 mWidget = nullptr;
 mSlider = nullptr;
 mLabel = nullptr;
}

References mHorizont, mLabel, mSlider, and SetupItem::mWidget.

Member Function Documentation

action()

void SetupItemSlider2::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 1137 of file setupitem.cpp.

{
 fromWidget();
 updateLabel();
 if (mOnTheFly == OnTheFly_true)
 save();
}

References fromWidget(), mOnTheFly, OnTheFly_true, SetupItem::save(), and updateLabel().

apply()

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

virtual

Reimplemented from SetupItem.

Definition at line 1162 of file setupitem.cpp.

{
 if (eventName != mEventName)
 return;
 
 fromWidget();
 save();
}

References fromWidget(), SetupItem::mEventName, and SetupItem::save().

createControls()

void SetupItemSlider2::createControls

(

)

Definition at line 1060 of file setupitem.cpp.

{
 load();
 mHorizont = new HorizontContainer(this, 32, 2);
 
 const int width = getMaxWidth();
 
 mLabel = new Label(this, mText);
 mLabel->setToolTip(mDescription);
 mLabel2 = new Label(this, "");
 mLabel2->setWidth(width);
 mSlider = new Slider(this, mMin, mMax, mStep);
 mSlider->setActionEventId(mEventName);
 mSlider->addActionListener(mParent);
 mSlider->setValue(atof(mValue.c_str()));
 mSlider->setHeight(30);
 
 mWidget = mSlider;
 mSlider->setWidth(150);
 mSlider->setHeight(40);
 if (mDoNotAlign == DoNotAlign_false)
 fixFirstItemSize(mLabel);
 mHorizont->add(mLabel);
 mHorizont->add(mSlider, -10);
 mHorizont->add(mLabel2);
 
 mParent->getContainer()->add2(mHorizont, true, 4);
 mParent->addControl(this);
 mParent->addActionListener(this);
 mWidget->addActionListener(this);
 updateLabel();
}

References HorizontContainer::add(), VertContainer::add2(), Widget::addActionListener(), SetupTabScroll::addControl(), DoNotAlign_false, SetupItem::fixFirstItemSize(), SetupTabScroll::getContainer(), getMaxWidth(), SetupItem::load(), SetupItem::mDescription, mDoNotAlign, SetupItem::mEventName, mHorizont, mLabel, mLabel2, mMax, mMin, SetupItem::mParent, mSlider, mStep, SetupItem::mText, SetupItem::mValue, SetupItem::mWidget, Widget::setActionEventId(), Widget::setHeight(), ToolTipListener::setToolTip(), Slider::setValue(), Widget::setWidth(), and updateLabel().

Referenced by SetupItemSlider2().

fromWidget()

void SetupItemSlider2::fromWidget ( )

virtual

Implements SetupItem.

Definition at line 1114 of file setupitem.cpp.

{
 if (mSlider == nullptr)
 return;
 
 int val = roundDouble(mSlider->getValue());
 if (mInvert)
 val = mInvertValue - val;
 mValue = toString(val);
}

References Slider::getValue(), mInvert, mInvertValue, mSlider, SetupItem::mValue, roundDouble(), and Catch::toString().

Referenced by action(), and apply().

getMaxWidth()

int SetupItemSlider2::getMaxWidth ( )

protected

Definition at line 1093 of file setupitem.cpp.

{
 if ((mValues == nullptr) || (gui == nullptr))
 return 1;
 
 int maxWidth = 0;
 SetupItemNamesConstIter it = mValues->begin();
 const SetupItemNamesConstIter it_end = mValues->end();
 const Font *const font = gui->getFont();
 
 while (it != it_end)
 {
 const int w = font->getWidth(*it);
 if (w > maxWidth)
 maxWidth = w;
 
 ++ it;
 }
 return maxWidth;
}

References Gui::getFont(), Font::getWidth(), gui, and mValues.

Referenced by createControls().

setInvertValue()

void SetupItemSlider2::setInvertValue

(

const int

v

)

Definition at line 1171 of file setupitem.cpp.

{
 mInvert = true;
 mInvertValue = v;
 toWidget();
}

References mInvert, mInvertValue, and toWidget().

toWidget()

void SetupItemSlider2::toWidget ( )

virtual

Implements SetupItem.

Definition at line 1125 of file setupitem.cpp.

{
 if (mSlider == nullptr)
 return;
 
 int val = roundDouble(atof(mValue.c_str()));
 if (mInvert)
 val = mInvertValue - val;
 mSlider->setValue(val);
 updateLabel();
}

References mInvert, mInvertValue, mSlider, SetupItem::mValue, roundDouble(), Slider::setValue(), and updateLabel().

Referenced by setInvertValue().

updateLabel()

void SetupItemSlider2::updateLabel ( )

protected

Definition at line 1145 of file setupitem.cpp.

{
 int val = CAST_S32(mSlider->getValue()) - mMin;
 if (val < 0)
 {
 val = 0;
 }
 else
 {
 const int sz = CAST_S32(mValues->size());
 if (val >= sz)
 val = sz - 1;
 }
 std::string str = mValues->at(val);
 mLabel2->setCaption(str);
}

References CAST_S32, Slider::getValue(), mLabel2, mMin, mSlider, mValues, and Label::setCaption().

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

Field Documentation

mDoNotAlign

DoNotAlign SetupItemSlider2::mDoNotAlign

protected

Definition at line 513 of file setupitem.h.

Referenced by createControls().

mHorizont

HorizontContainer* SetupItemSlider2::mHorizont

protected

Definition at line 502 of file setupitem.h.

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

mInvert

bool SetupItemSlider2::mInvert

protected

Definition at line 511 of file setupitem.h.

Referenced by fromWidget(), setInvertValue(), and toWidget().

mInvertValue

int SetupItemSlider2::mInvertValue

protected

Definition at line 510 of file setupitem.h.

Referenced by fromWidget(), setInvertValue(), and toWidget().

mLabel

Label* SetupItemSlider2::mLabel

protected

Definition at line 503 of file setupitem.h.

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

mLabel2

Label* SetupItemSlider2::mLabel2

protected

Definition at line 504 of file setupitem.h.

Referenced by createControls(), and updateLabel().

mMax

int SetupItemSlider2::mMax

protected

Definition at line 508 of file setupitem.h.

Referenced by createControls().

mMin

int SetupItemSlider2::mMin

protected

Definition at line 507 of file setupitem.h.

Referenced by createControls(), and updateLabel().

mOnTheFly

OnTheFly SetupItemSlider2::mOnTheFly

protected

Definition at line 512 of file setupitem.h.

Referenced by action().

mSlider

Slider* SetupItemSlider2::mSlider

protected

Definition at line 505 of file setupitem.h.

Referenced by createControls(), fromWidget(), toWidget(), updateLabel(), and ~SetupItemSlider2().

mStep

int SetupItemSlider2::mStep

protected

Definition at line 509 of file setupitem.h.

Referenced by createControls().

mValues

SetupItemNames* SetupItemSlider2::mValues

protected

Definition at line 506 of file setupitem.h.

Referenced by getMaxWidth(), and updateLabel().

---

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

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