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

Handle class for combo components. More...

#include <ComboHandle.h>

Inheritance diagram for icl::qt::ComboHandle:
icl::qt::GUIHandle< QComboBox > icl::qt::GUIHandleBase

Public Member Functions

 ComboHandle ()
 create an empty handle More...
 
 ComboHandle (QComboBox *cb, GUIWidget *w)
 create a new ComboHandle wrapping a given QComboBox More...
 
ICLQt_API void add (const std::string &item)
 add an item More...
 
ICLQt_API void remove (const std::string &item)
 remove an item More...
 
ICLQt_API void remove (int idx)
 remove item at given index More...
 
ICLQt_API void clear ()
 void remove all items More...
 
ICLQt_API std::string getItem (int idx) const
 returns the item at given index More...
 
ICLQt_API int getIndex (const std::string &item) const
 returns the index of a given item More...
 
ICLQt_API int getSelectedIndex () const
 returns the currently selected index More...
 
ICLQt_API std::string getSelectedItem () const
 returns the currently selected item More...
 
ICLQt_API int getItemCount () const
 returns the count of elements More...
 
ICLQt_API void setSelectedIndex (int idx)
 sets the current index More...
 
ICLQt_API void setSelectedItem (const std::string &item)
 sets the current item More...
 
 operator int () const
 convenience operator wrapping getSelectedIndex More...
 
 operator std::string () const
 convenience operator wrapping getSelectedItem More...
 
- Public Member Functions inherited from icl::qt::GUIHandle< QComboBox >
const QComboBox * operator * () const
 use the *-oprator to get the wrapped component (const) More...
 
QComboBox *& operator * ()
 use the *-oprator to get the wrapped component (unconst) More...
 
QComboBox * operator-> ()
 this can be used for direct access to wrapped type More...
 
const QComboBox * 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 Member Functions

QComboBox * cbx ()
 utility function (internally used) More...
 
const QComboBox * cbx () const
 utility function (internally used) More...
 

Additional Inherited Members

- Protected Member Functions inherited from icl::qt::GUIHandle< QComboBox >
 GUIHandle ()
 as GUIHandle is just an interface, its base constructor is protected More...
 
 GUIHandle (QComboBox *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

Handle class for combo components.

Constructor & Destructor Documentation

◆ ComboHandle() [1/2]

icl::qt::ComboHandle::ComboHandle ( )
inline

create an empty handle

◆ ComboHandle() [2/2]

icl::qt::ComboHandle::ComboHandle ( QComboBox *  cb,
GUIWidget w 
)
inline

create a new ComboHandle wrapping a given QComboBox

Member Function Documentation

◆ add()

ICLQt_API void icl::qt::ComboHandle::add ( const std::string &  item)

add an item

◆ cbx() [1/2]

QComboBox* icl::qt::ComboHandle::cbx ( )
inlineprivate

utility function (internally used)

◆ cbx() [2/2]

const QComboBox* icl::qt::ComboHandle::cbx ( ) const
inlineprivate

utility function (internally used)

◆ clear()

ICLQt_API void icl::qt::ComboHandle::clear ( )

void remove all items

◆ getIndex()

ICLQt_API int icl::qt::ComboHandle::getIndex ( const std::string &  item) const

returns the index of a given item

◆ getItem()

ICLQt_API std::string icl::qt::ComboHandle::getItem ( int  idx) const

returns the item at given index

◆ getItemCount()

ICLQt_API int icl::qt::ComboHandle::getItemCount ( ) const

returns the count of elements

◆ getSelectedIndex()

ICLQt_API int icl::qt::ComboHandle::getSelectedIndex ( ) const

returns the currently selected index

◆ getSelectedItem()

ICLQt_API std::string icl::qt::ComboHandle::getSelectedItem ( ) const

returns the currently selected item

◆ operator int()

icl::qt::ComboHandle::operator int ( ) const
inline

convenience operator wrapping getSelectedIndex

◆ operator std::string()

icl::qt::ComboHandle::operator std::string ( ) const
inline

convenience operator wrapping getSelectedItem

◆ remove() [1/2]

ICLQt_API void icl::qt::ComboHandle::remove ( const std::string &  item)

remove an item

◆ remove() [2/2]

ICLQt_API void icl::qt::ComboHandle::remove ( int  idx)

remove item at given index

◆ setSelectedIndex()

ICLQt_API void icl::qt::ComboHandle::setSelectedIndex ( int  idx)

sets the current index

◆ setSelectedItem()

ICLQt_API void icl::qt::ComboHandle::setSelectedItem ( const std::string &  item)

sets the current item


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