CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CFxUIObject Class Reference

#include <FxUIObject.h>

Inheritance diagram for CFxUIObject:
CFxAVAudioInput CFxAVAudioOutput CFxNANetworkAccessManager CFxNANetworkReply CFxNAWebSocket CFxUIAbstractItemModel CFxUIAction CFxUIBaseView CFxUICalendarWidget CFxUIDialog CFxUIMenu CFxUITimer

Public Member Functions

 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
 

Protected Member Functions

CFxUIObjectsender ()
 

Protected Attributes

CFxUIObjectImpl * m_pImpl
 
CFxUIObjectData * m_pData
 

Detailed Description

Class CFxUIObject is the base class for all CFxUI objects .

Definition at line 102 of file FxUIObject.h.

Constructor & Destructor Documentation

◆ CFxUIObject()

CFxUIObject::CFxUIObject ( )

Constructor

◆ ~CFxUIObject()

virtual CFxUIObject::~CFxUIObject ( )
virtual

Destructor

Member Function Documentation

◆ blockSignals()

void CFxUIObject::blockSignals ( bool  block)

Sets the signals in block and unblock state.

Parameters
blockAll signals will be blocked if it is true and unblocked if it is false.

◆ children()

CFxUIList<CFxUIObject*> CFxUIObject::children ( ) const

Returns list of all children of an object.

Returns
The list of all children;

◆ findChildren()

template<typename T >
CFxUIList<T> CFxUIObject::findChildren ( const CFxUIString name = CFxUIString())
inline

Returns all children of an object with specified name.

Parameters
nameInput will contain child's name.
Returns
The list of all children;

Definition at line 198 of file FxUIObject.h.

◆ getHandle()

FxNativeHandle CFxUIObject::getHandle ( ) const

Returns handle of an Object.

The objects of a class inherited from CFxUIObject will contain the handle of actual widget.

Returns
The FxNativeHandle;

◆ objectName()

CFxUIString CFxUIObject::objectName ( ) const

Returns name of an object.

Returns
The name string;

◆ parent() [1/2]

CFxUIObject* CFxUIObject::parent ( )

Returns parent of an Object.

Returns
The CFxUIObject* type object;

◆ parent() [2/2]

const CFxUIObject* CFxUIObject::parent ( ) const

Returns parent of an Object.

Returns
The const CFxUIObject* type object;

◆ property()

CFxUIVariant CFxUIObject::property ( const char *  name)

Returns property's value of an object.

Parameters
nameInput will contain property name.
Returns
The CFxUIVariant which will contain property's value;

◆ sender()

CFxUIObject* CFxUIObject::sender ( )
protected

Returns sender of a signal.

Returns
sender;

◆ setHandle()

void CFxUIObject::setHandle ( FxNativeHandle  handle)

Sets handle of an object.

Parameters
handleInput.

◆ setObjectName()

void CFxUIObject::setObjectName ( const CFxUIString objectName)

Sets name of an object.

Parameters
objectNameInput.

◆ setParent()

void CFxUIObject::setParent ( CFxUIObject parent)

Sets parent of an object.

Parameters
parentInput.

◆ setProperty()

bool CFxUIObject::setProperty ( const char *  name,
const CFxUIVariant value 
)

Sets property's value of an object.

Parameters
namewill contain property's name.
valuewill contain property's value.

◆ signalsBlocked()

bool CFxUIObject::signalsBlocked ( ) const

Returns if signals are blocked.

Returns
If signals are blocked then it is true otherwise false;

Member Data Documentation

◆ m_pData

CFxUIObjectData* CFxUIObject::m_pData
protected

Definition at line 252 of file FxUIObject.h.

◆ m_pImpl

CFxUIObjectImpl* CFxUIObject::m_pImpl
protected

Definition at line 251 of file FxUIObject.h.


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