Frapper::WidgetPlugin Class Reference

#include <WidgetPlugin.h>

Inheritance diagram for Frapper::WidgetPlugin:

Collaboration diagram for Frapper::WidgetPlugin:

Signals
void	updateWidget ()
	is emitted if the widget must be redrawn

Public Member Functions
	WidgetPlugin (QWidget *parent, ParameterPlugin *parameter)
	Constructor of the WidgetPlugin class.
virtual	~WidgetPlugin (void)
	Destructor of the WidgetPlugin class.
QVariant	getParameterValue ()
	Returns the parameter´s value.
void	setParameterValue (QVariant value)
	sets the parameter´s value
QString	getParameterName ()
	returns the name of the associated parameter
void	widgetUpdate ()
	is called to emit the signal "updateWidget"
void	updateParameterValue (QVariant value)
	updates the parameter and forces a update of the widget
void	setFlags (QMap< QString, QVariant > flags)
	sets the flags of the parameter
void	setFlag (QString key, QVariant value)
	set a Flag
QMap< QString, QVariant >	getFlags ()
	returns the flags of the parameter
void	setParameterTriggersRedraw (bool trigger)
	Sets or deletes a connection between the parameter´s update and the widget´s update.
QStringList	getFlagList ()
	returns a list of all flag keys
bool	checkFlag (QString flag)
	cecks if a flag exists and has a value
QVariant	getFlag (QString flag)
	returns the value of a flag

Protected Attributes
ParameterPlugin *	m_parameter
	the associated parameter

Private Slots
void	redrawByParameterChange ()
	is called if parameter is changed

Private Attributes
bool	m_selfTriggered
	Flag if the parameter change was done by the widget.

Constructor & Destructor Documentation

Frapper::WidgetPlugin::WidgetPlugin	(	QWidget *	parent,
		ParameterPlugin *	parameter
	)

Constructor of the WidgetPlugin class.

Constructors and Destructors.

Parameters

parent	The parent widget.
parameter	The associated parameter.

Constructor of the WidgetPlugin class.

Parameters

parent	The parent widget.
parameter	The associated parameter.

Frapper::WidgetPlugin::~WidgetPlugin ( void  )

virtual

Destructor of the WidgetPlugin class.

Defined virtual to guarantee that the destructor of a derived class will be called if the instance of the derived class is saved in a variable of its parent class type.

Member Function Documentation

QVariant Frapper::WidgetPlugin::getParameterValue

(

)

Returns the parameter´s value.

Public Functions.

Returns

the QVariant value of the parameter

Returns the parameters value

Returns

the QVariant value of the parameter

void Frapper::WidgetPlugin::setParameterValue

(

QVariant

value

)

sets the parameter´s value

Parameters

value

The QVariant to be set as the parameter´s value

QString Frapper::WidgetPlugin::getParameterName

(

)

returns the name of the associated parameter

Returns

The name of the parameter as QString

void Frapper::WidgetPlugin::widgetUpdate

(

)

is called to emit the signal "updateWidget"

void Frapper::WidgetPlugin::updateParameterValue

(

QVariant

value

)

updates the parameter and forces a update of the widget

Parameters

value

The QVariant to be set as the parameter´s value

void Frapper::WidgetPlugin::setFlags

(

QMap< QString, QVariant >

flags

)

sets the flags of the parameter

Parameters

flags

The QMap of flags

void Frapper::WidgetPlugin::setFlag	(	QString	key,
		QVariant	value
	)

set a Flag

Parameters

key	Name of the flag
value	Value of the flag

QMap< QString, QVariant > Frapper::WidgetPlugin::getFlags

(

)

returns the flags of the parameter

Returns

The QMap of flags

void Frapper::WidgetPlugin::setParameterTriggersRedraw

(

bool

trigger

)

Sets or deletes a connection between the parameter´s update and the widget´s update.

Parameters

trigger

Controll if the connection should be created (true) or destroyed (false)

QStringList Frapper::WidgetPlugin::getFlagList

(

)

returns a list of all flag keys

Returns

QStringList of all flag names

bool Frapper::WidgetPlugin::checkFlag

(

QString

flag

)

cecks if a flag exists and has a value

Parameters

flag	Name of the flag

Returns

Boolean value, "true" if flag exists and has a value

QVariant Frapper::WidgetPlugin::getFlag

(

QString

flag

)

returns the value of a flag

Parameters

flag	Name of the flag

Returns

QVariant value of the flag

void Frapper::WidgetPlugin::redrawByParameterChange ( )

privateslot

is called if parameter is changed

is called if the parameter is changed

void Frapper::WidgetPlugin::updateWidget ( )

signal

is emitted if the widget must be redrawn

Member Data Documentation

ParameterPlugin* Frapper::WidgetPlugin::m_parameter

protected

the associated parameter

bool Frapper::WidgetPlugin::m_selfTriggered

private

Flag if the parameter change was done by the widget.

---

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

• WidgetPlugin.h
• WidgetPlugin.cpp