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

#include <FxUIGroupBox.h>

Inheritance diagram for CFxUIGroupBox:
CFxUIBaseView CFxUIObject

Public Member Functions

 CFxUIGroupBox ()
 
 ~CFxUIGroupBox ()
 
void setTitle (const CFxUIString &str)
 
CFxUIString title ()
 
void setCollapsed (bool bCollapsed)
 
bool isCollapsed () const
 
void setFoldable (bool bFoldable)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setSpacing (int spacing)
 
CFxUISignal< void(bool)> & onCollapsedStateChanged ()
 
- 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 CFxUIGroupBox provides a frame, a title and a keyboard shortcut, and displays various other widgets inside itself.

Definition at line 27 of file FxUIGroupBox.h.

Constructor & Destructor Documentation

◆ CFxUIGroupBox()

CFxUIGroupBox::CFxUIGroupBox ( )

Constructor

◆ ~CFxUIGroupBox()

CFxUIGroupBox::~CFxUIGroupBox ( )

Destructor

Member Function Documentation

◆ isCollapsed()

bool CFxUIGroupBox::isCollapsed ( ) const

Returns if group box is either collapse or expanded.

Returns
bool The value returned is true if group box is in collapsed form, otherwise false.

◆ onCollapsedStateChanged()

CFxUISignal<void(bool)>& CFxUIGroupBox::onCollapsedStateChanged ( )

Signal is emitted whenever the state of group box is changed i.e. toggled between collapsed or expanded.

◆ setCollapsed()

void CFxUIGroupBox::setCollapsed ( bool  bCollapsed)

Sets group box either collapse or expanded, depending on the value of passed.

Parameters
bCollapsedIf parameter passed is true group box is set to collapsed state, otherwise to expanded form.

◆ setContentsMargins()

void CFxUIGroupBox::setContentsMargins ( int  left,
int  top,
int  right,
int  bottom 
)

Sets content margins in group box.

This property is used when UseMargin() is set to true.

Parameters
leftSpecifies the left margin for content in group box.
topSpecifies the left margin for content in group box.
rightSpecifies the left margin for content in group box.
bottomSpecifies the left margin for content in group box.

◆ setFoldable()

void CFxUIGroupBox::setFoldable ( bool  bFoldable)

This method turns off /on the capability to collapse / expand the group box.

setFoldable( true ): Appearance: Removed icon, text aligned to the left, group box can not be expanded/collapse anymore

setFoldable( false ): Appearance: Showed icon, text aligned to the icon, group box can be expanded / collapsed

◆ setSpacing()

void CFxUIGroupBox::setSpacing ( int  spacing)

Sets the provided spacing between the contents of group box.

Parameters
spacingInput.

◆ setTitle()

void CFxUIGroupBox::setTitle ( const CFxUIString str)

Sets the title of group box.

Parameters
strInput

◆ title()

CFxUIString CFxUIGroupBox::title ( )

Returns the title of group box.

Returns
string , If title is not set, empty string is returned.

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