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

#include <FxUISwitchButton.h>

Inheritance diagram for CFxUISwitchButton:
CFxUIBaseView CFxUIObject

Public Member Functions

 CFxUISwitchButton ()
 
virtual ~CFxUISwitchButton ()
 
void setText (const CFxUIString &str)
 
void setChecked (bool bChecked)
 
bool isChecked () const
 
void setTextSize (float size)
 
CFxUISignal< void(int)> & stateChanged ()
 
CFxUISignal< void(bool)> & toggled ()
 
CFxUISignal< void(void)> & clicked ()
 
- Public Member Functions inherited from CFxUIBaseView
 CFxUIBaseView ()
 
virtual ~CFxUIBaseView ()
 
void setDisabled (bool on)
 
void setEnabled (bool on)
 
bool isEnabled () const
 
CFxUIPalette::ColorRole backgroundRole ()
 
void setPalette (const CFxUIPalette &)
 
const CFxUIPalettepalette () const
 
bool isVisible ()
 
void setVisible (bool bVisible)
 
bool hasFocus () const
 
void setFocus ()
 
void setFocus (int iReason)
 
void setFocusPolicy (int iPolicy)
 
int width ()
 
void setWidth (int w)
 
int height ()
 
void setHeight (int h)
 
void update ()
 
void setBusyState (bool bBusy=false)
 
void resize (int w, int h)
 
void setCornerRadius (float radius)
 
void setBorderWidth (float width)
 
void setBorderWidth (float left, float top, float right, float bottom)
 
void setBorderColor (int r, int g, int b)
 
virtual void showEvent (CFxUIShowEvent *event)
 
virtual void hideEvent (CFxUIHideEvent *event)
 
virtual void paintEvent (CFxUIPaintEvent *event)
 
virtual void resizeEvent (CFxUIResizeEvent *event)
 
virtual void focusInEvent (CFxUIFocusEvent *focusInEvent)
 
virtual void focusOutEvent (CFxUIFocusEvent *focusOutEvent)
 
void setEventAccepted (bool bAccepted=false)
 
void addView (CFxUIBaseView *pChild, float fWeight=0.0)
 
void insertView (CFxUIBaseView *pChild, int index=0, float fWeight=0.0)
 
int indexOf (CFxUIBaseView *pChild)
 
void removeView (CFxUIBaseView *pChild)
 
void setPreferableSize (int w, int h)
 
void setMinimumWidth (int iWidth)
 
void setMinimumHeight (int iHeight)
 
void setMinimumSize (const CFxUISize &size)
 
void setMaximumWidth (int iWidth)
 
void setMaximumHeight (int iHeight)
 
void setMaximumSize (const CFxUISize &size)
 
int minimumWidth ()
 
int minimumHeight ()
 
int maximumWidth ()
 
int maximumHeight ()
 
void setToolTip (const CFxUIString &sToolTip)
 
const CFxUIString toolTip ()
 
CFxUISignal< void(void)> & aboutToPassEventToParent ()
 
CFxUISignal< void(void)> & aboutToShow ()
 
CFxUISignal< void(void)> & hoverEnter ()
 
CFxUISignal< void(void)> & hoverLeave ()
 
- 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

- Public Types inherited from CFxUIBaseView
enum  TextAlignment {
  AlignLeft = 0x0001 , AlignRight = 0x0002 , AlignHCenter = 0x0004 , AlignJustify = 0x0008 ,
  AlignTop = 0x0020 , AlignBottom = 0x0040 , AlignVCenter = 0x0080 , AlignBaseline = 0x0100 ,
  AlignCenter = AlignVCenter | AlignHCenter
}
 
enum  FocusPolicyType {
  eNoFocus = 0 , eTabFocus = 0x1 , eClickFocus = 0x2 , eStrongFocus = eTabFocus | eClickFocus | 0x8 ,
  eWheelFocus = eStrongFocus | 0x4 , eKeyboardOnSetfocus = 0x10
}
 
enum  UIWidthSizePolicy {
  eXS = 0 , eS , eM , eL ,
  eXL
}
 
- Static Public Member Functions inherited from CFxUIBaseView
static void setTabOrder (CFxUIObject *first, CFxUIObject *second)
 
- Protected Member Functions inherited from CFxUIObject
CFxUIObjectsender ()
 
- Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl * m_pImpl
 
CFxUIObjectData * m_pData
 

Detailed Description

Class CFxUISwitchButton

Definition at line 24 of file FxUISwitchButton.h.

Constructor & Destructor Documentation

◆ CFxUISwitchButton()

CFxUISwitchButton::CFxUISwitchButton ( )

Constructor

◆ ~CFxUISwitchButton()

virtual CFxUISwitchButton::~CFxUISwitchButton ( )
virtual

Destructor

Member Function Documentation

◆ clicked()

CFxUISignal<void(void)>& CFxUISwitchButton::clicked ( )

Signal is emitted when the button pressed down then released while the mouse cursor is inside the box.

◆ isChecked()

bool CFxUISwitchButton::isChecked ( ) const

Returns if switch box is checked.

Returns
true if the switch box is checked, otherwise false.

◆ setChecked()

void CFxUISwitchButton::setChecked ( bool  bChecked)

Set the switch box checked.

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

◆ setText()

void CFxUISwitchButton::setText ( const CFxUIString str)

Sets the text.

Parameters
strInput

◆ setTextSize()

void CFxUISwitchButton::setTextSize ( float  size)

Sets the text size of switchbox label.

Parameters
sizeInput

◆ stateChanged()

CFxUISignal<void(int)>& CFxUISwitchButton::stateChanged ( )

Signal is emitted whenever the switch box's state changes, i.e. whenever the user checks or unchecks it.

◆ toggled()

CFxUISignal<void(bool)>& CFxUISwitchButton::toggled ( )

Signal is emitted whenever the switch box's state changes, i.e. whenever the user checks or unchecks it.


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