CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
CFxUIAction Class Reference

#include <FxUIAction.h>

Inheritance diagram for CFxUIAction:
CFxUIObject

Public Member Functions

 CFxUIAction ()
 
 ~CFxUIAction ()
 
void setIcon (const CFxUIIcon &icon)
 
void setResourceIcon (const CFxUIString &str)
 
CFxUIString text () const
 
void setText (const CFxUIString &str)
 
void setEnabled (const bool bEnabled)
 
void setChecked (const bool bChecked)
 
bool isChecked () const
 
void setCheckable (bool bVal)
 
void setVisible (const bool bVisible)
 
void setData (const CFxUIVariant &data)
 
CFxUIVariant data ()
 
CFxUISignal< void(const bool)> & triggered ()
 
- Public Member Functions inherited from CFxUIObject
 CFxUIObject ()
 
virtual ~CFxUIObject ()
 
FxNativeHandle getHandle () const
 
void setHandle (FxNativeHandle handle)
 
void setParent (CFxUIObject *parent)
 
CFxUIObjectparent ()
 
const CFxUIObjectparent () const
 
void setObjectName (const CFxUIString &objectName)
 
CFxUIString objectName () const
 
bool setProperty (const char *name, const CFxUIVariant &value)
 
CFxUIVariant property (const char *name)
 
CFxUIList< CFxUIObject * > children () const
 
template<typename T >
CFxUIList< T > findChildren (const CFxUIString &name=CFxUIString())
 
void blockSignals (bool block)
 
bool signalsBlocked () const
 

Additional Inherited Members

- Protected Member Functions inherited from CFxUIObject
CFxUIObjectsender ()
 
- Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl * m_pImpl
 
CFxUIObjectData * m_pData
 

Detailed Description

Class CFxUIAction is the class for defining the actions.

Definition at line 25 of file FxUIAction.h.

Constructor & Destructor Documentation

◆ CFxUIAction()

CFxUIAction::CFxUIAction ( )

Constructor

◆ ~CFxUIAction()

CFxUIAction::~CFxUIAction ( )

Destructor

Member Function Documentation

◆ data()

CFxUIVariant CFxUIAction::data ( )

Get the data on action.

Returns
data.

◆ isChecked()

bool CFxUIAction::isChecked ( ) const

Returns if control is checked.

Returns
true if the control is checked, otherwise false.

◆ setCheckable()

void CFxUIAction::setCheckable ( bool  bVal)

Set the control checkable.

By default, the control is not checkable.

Parameters
bValInput

◆ setChecked()

void CFxUIAction::setChecked ( const bool  bChecked)

Set the control checked.

Only checkable controls can be checked.

Parameters
bCheckedThe control is set to checked only if the value of the parameter is true.

◆ setData()

void CFxUIAction::setData ( const CFxUIVariant data)

Sets the data on action.

Parameters
data.

◆ setEnabled()

void CFxUIAction::setEnabled ( const bool  bEnabled)

Sets whether the control is enabled.

Parameters
bEnabledThe control is enabled if the value of the parameter is true, otherwise it will be disabled.

◆ setIcon()

void CFxUIAction::setIcon ( const CFxUIIcon icon)

Sets the icon.

Parameters
icon

◆ setResourceIcon()

void CFxUIAction::setResourceIcon ( const CFxUIString str)

Sets the icon.

Parameters
strThe resource path is passed in parameter.

◆ setText()

void CFxUIAction::setText ( const CFxUIString str)

Sets the text.

Parameters
strInput

◆ setVisible()

void CFxUIAction::setVisible ( const bool  bVisible)

Set the visibility of control.

Parameters
bVisibleThe control is visible on widget if parameter is true, otherwise it is hidden.

◆ text()

CFxUIString CFxUIAction::text ( ) const

Returns the text.

Returns
string

◆ triggered()

CFxUISignal<void( const bool )>& CFxUIAction::triggered ( )

Signal is emitted when an action is activated


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