DtUiPushButtonElement Class Reference

UI Element for specify a push button that will trigger an action specified by the property "slot". More...

Inheritance diagram for DtUiPushButtonElement:

Public Types
typedef boost::function< void(makVrv::DtDe &, DtUiPushButtonElement *)>	PushButtonSlot
Public Types inherited from DtUiElement
typedef boost::function < DtUiElement *(makVrv::DtDe &)>	CreatorFunction
typedef std::map< std::string, CreatorFunction >	UiElementFactoryMap

Public Member Functions
	DtUiPushButtonElement (makVrv::DtDe &)
	Constructor.
virtual	~DtUiPushButtonElement ()
	Destructor.
virtual void	createControls (QWidget *)
	If additional widgets or connections need to be made do it here. The parent is the myWidget member.
virtual void	setSlot (const QString &)
virtual QString	slot () const
Public Member Functions inherited from DtUiElement
	DtUiElement (makVrv::DtDe &)
	Constructor.
virtual	~DtUiElement ()
	Destructor.
virtual bool	blockSignals (bool)
virtual void	init (QWidget *widget, QWidget *label, DtReaderWriter *originalData, DtReaderWriter *backupData, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual void	init (QWidget *widget, QWidget *label, const std::vector< DtReaderWriter * > &originalData, const std::vector< DtReaderWriter * > &backupData, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual void	init (QWidget *widget, QWidget *label, const DtObjectType &, const DtString &platformType, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual DtString	displayUnits () const
virtual void	setDisplayUnits (const DtString &units)
virtual void	setLabelText (const QString &)
virtual DtString	sourceUnits () const
virtual void	setSourceUnits (const DtString &units)
virtual void	setFromSystemParameterData (const DtSystemParameterData *data, const DtComponentSystemDefinition *)
	Sets data of this UiElement from the specified system parameter data.
virtual void	objectParametersModified ()
	This method is called any time that any of the parameters for the object are modified.
virtual void	connectedTo (QObject *)
	Called when this item is connected to any signal emitted by the given item.
virtual void	processUiEvent (const DtUiElementEvent &)
	Process ui event. Default does nothing.
virtual void	setModelModified (DtModelSetEntry *)
	Called when the model is modified. Default is no-op.
virtual DtString	uniqueName () const
	Returns a unique name for this element.
virtual bool	supportsSystems () const
	Returns true if this element supports systes.
virtual const DtString &	platformType () const
	Returns the type of platform this entity represents.
virtual void	setPlatformType (const DtString &)
	Sets the type of platform for this entity.
virtual void	setObjectTypes (const std::vector< DtObjectType > &)
	Sets the object type this element represents.
virtual void	aboutToShow ()
	Called when about to show as part of a properties dialog. Default is no-op.
const std::vector < DtReaderWriter * > &	values () const
const std::vector < DtReaderWriter * > &	backupValues () const
virtual bool	isModified () const
virtual void	decorateElement ()
	Sets element decoration depending on the isModified state of the element.
virtual void	setFromParameters (DtReaderWriter *parentRw)
	Calls setFromParameters with std::vector of parameter.
virtual void	setFromParameters (const std::vector< DtReaderWriter * > &parentRw)
virtual bool	restoreFromBackup ()
	Restores this element from a backup created with the specified name.
const std::vector< DtObjectType > &	objectTypes () const
virtual void	sendEvent (const DtUiElementEvent &)
virtual bool	allValuesTheSame () const
virtual bool	isMixedValue () const
	If widget is line edit and the value is mixedText returns true, else the subclass will need to return this value.
virtual void	setEnabled (bool)
	If this item is not enabled it cannot be modified.
virtual bool	enabled () const

Static Public Member Functions
static DtUiElement *	CreatorFunction (makVrv::DtDe &)
static void	addSlot (const std::string &, PushButtonSlot)
Static Public Member Functions inherited from DtUiElement
static void	registerUiTypes ()
	Factory methods for creating ui elements.
static DtUiElement *	createUiElement (makVrv::DtDe &, const DtString &type)
static bool	hasCreator (const DtString &)
static void	theNullFunction (DtUiElement *)
static UiElementFactoryMap &	elementFactory ()
static QString	mixedText ()
static void	setMixedText (const QString &)

Protected Slots
virtual void	buttonPressed ()
Protected Slots inherited from DtUiElement
virtual void	elementChanged ()
virtual void	enableIfChecked ()
	Connected to if the enable_if_checked property is set, and there is a matching check box for the enable_if_checked property.
virtual void	disableIfChecked ()
	Connected to if the disable_if_checked property is set, and there is a matching check box for the disable_if_checked property.

Protected Attributes
QString	mySlot
Protected Attributes inherited from DtUiElement
DtString	myDisplayUnits
DtString	mySourceUnits
std::vector< DtReaderWriter * >	myValues
	Assumes 1 - 1 order that original and backup are same index in lists.
std::vector< DtReaderWriter * >	myBackupValues
bool	myIsNew
DtElementChangedCallbackFcn	myElementChangedCallbackFunction
DtUnit	mySource
DtUnit	myDestination
makVrv::DtDe &	myDe
DtString	myPlatformType
std::vector< DtObjectType >	myObjectTypes
const DtComponentSystemDefinition *	mySystemDefinition
bool	myEnabled
std::vector< QObject * >	myConnectedTo
int	myUniqueId

Additional Inherited Members
Public Slots inherited from DtUiElement
virtual void	toggleDisplayed (bool display)
Signals inherited from DtUiElement
void	uiEvent (const DtUiElementEvent &)
Public Attributes inherited from DtUiElement
QWidget *	myWidget
QWidget *	myLabel
Protected Member Functions inherited from DtUiElement
virtual double	sourceToDisplayUnits (double) const
virtual double	displayToSourceUnits (double) const
virtual QString	units () const
virtual void	updateLabelTitle ()
	Updates label title based on valid units.
virtual QString	labelTitle () const
	Returns the unmodified label title.
Static Protected Attributes inherited from DtUiElement
static UiElementFactoryMap	theFactory

Detailed Description

UI Element for specify a push button that will trigger an action specified by the property "slot".

The slot must be registered with this class in order to be triggered. The slot can be registered via the addSlot static method.

Member Typedef Documentation

typedef boost::function<void (makVrv::DtDe&, DtUiPushButtonElement*)> DtUiPushButtonElement::PushButtonSlot

Constructor & Destructor Documentation

DtUiPushButtonElement::DtUiPushButtonElement

(

makVrv::DtDe &

)

Constructor.

virtual DtUiPushButtonElement::~DtUiPushButtonElement ( )

virtual

Destructor.

Member Function Documentation

virtual void DtUiPushButtonElement::createControls ( QWidget *  parent )

virtual

If additional widgets or connections need to be made do it here. The parent is the myWidget member.

Reimplemented from DtUiElement.

static DtUiElement* DtUiPushButtonElement::CreatorFunction ( makVrv::DtDe &  )

static

virtual void DtUiPushButtonElement::setSlot ( const QString &  )

virtual

virtual QString DtUiPushButtonElement::slot ( ) const

virtual

static void DtUiPushButtonElement::addSlot ( const std::string &  , PushButtonSlot    )

static

virtual void DtUiPushButtonElement::buttonPressed ( )

protectedvirtualslot

Member Data Documentation

QString DtUiPushButtonElement::mySlot

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/simulationObjectEditorImpl/uiPushButtonElement.h