Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::qt::CheckBoxHandle Class Reference

Special Utiltiy class for handling Button clicks in the ICL GUI API. More...

#include <CheckBoxHandle.h>

Inheritance diagram for icl::qt::CheckBoxHandle:
icl::qt::GUIHandle< QCheckBox > icl::qt::GUIHandleBase

Public Member Functions

 CheckBoxHandle ()
 creates a n empty button handle More...
 
 CheckBoxHandle (QCheckBox *cb, GUIWidget *w, bool *stateRef)
 create a new event with a given button id More...
 
void check (bool execCallbacks=true)
 checks this checkbox More...
 
void uncheck (bool execCallbacks=true)
 
void doCheck (bool on, bool execCallbacks=true)
 defines the check-state More...
 
bool isChecked () const
 
- Public Member Functions inherited from icl::qt::GUIHandle< QCheckBox >
const QCheckBox * operator * () const
 use the *-oprator to get the wrapped component (const) More...
 
QCheckBox *& operator * ()
 use the *-oprator to get the wrapped component (unconst) More...
 
QCheckBox * operator-> ()
 this can be used for direct access to wrapped type More...
 
const QCheckBox * operator-> () const
 this can be used for direct access to wrapped type More...
 
bool isNull () const
 returns whether wrapped pointer is null or not More...
 
void enable ()
 enables the wrapped GUI component More...
 
void disable ()
 disables the wrapped GUI component More...
 
- Public Member Functions inherited from icl::qt::GUIHandleBase
virtual ~GUIHandleBase ()
 virtual destructor More...
 
GUIWidgetgetGUIWidget ()
 returns parent GUIWidget pointer More...
 
virtual void registerCallback (const GUI::Callback &cb, const std::string &events="all")
 registers a callback on this gui widget More...
 
virtual void registerCallback (const GUI::ComplexCallback &cb, const std::string &events="all")
 registers a complex callback on this gui component More...
 
virtual void removeCallbacks ()
 removes all callbacks from parent GUIWidget component More...
 
virtual void cb ()
 envokes all registered callbacks More...
 

Private Attributes

bool * m_stateRef
 internal state reference variable More...
 

Additional Inherited Members

- Protected Member Functions inherited from icl::qt::GUIHandle< QCheckBox >
 GUIHandle ()
 as GUIHandle is just an interface, its base constructor is protected More...
 
 GUIHandle (QCheckBox *t, GUIWidget *w)
 as GUIHandle is just an interface, its base constructor is protected More...
 
- Protected Member Functions inherited from icl::qt::GUIHandleBase
 GUIHandleBase (GUIWidget *w=0)
 create a new GUIHandleBase More...
 

Detailed Description

Special Utiltiy class for handling Button clicks in the ICL GUI API.

Constructor & Destructor Documentation

◆ CheckBoxHandle() [1/2]

icl::qt::CheckBoxHandle::CheckBoxHandle ( )

creates a n empty button handle

◆ CheckBoxHandle() [2/2]

icl::qt::CheckBoxHandle::CheckBoxHandle ( QCheckBox *  cb,
GUIWidget w,
bool *  stateRef 
)

create a new event with a given button id

Member Function Documentation

◆ check()

void icl::qt::CheckBoxHandle::check ( bool  execCallbacks = true)

checks this checkbox

◆ doCheck()

void icl::qt::CheckBoxHandle::doCheck ( bool  on,
bool  execCallbacks = true 
)
inline

defines the check-state

◆ isChecked()

bool icl::qt::CheckBoxHandle::isChecked ( ) const

◆ uncheck()

void icl::qt::CheckBoxHandle::uncheck ( bool  execCallbacks = true)

Member Data Documentation

◆ m_stateRef

bool* icl::qt::CheckBoxHandle::m_stateRef
private

internal state reference variable


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