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

Class for handling button goups. More...

#include <ButtonGroupHandle.h>

Inheritance diagram for icl::qt::ButtonGroupHandle:
icl::qt::GUIHandle< RadioButtonVec > icl::qt::GUIHandleBase

Public Member Functions

 ButtonGroupHandle ()
 Create an empty handle. More...
 
 ButtonGroupHandle (RadioButtonVec *buttons, GUIWidget *w)
 Craete a valid handle. More...
 
ICLQt_API void select (int id)
 select a button with given index More...
 
ICLQt_API int getSelected () const
 get the selected index More...
 
ICLQt_API std::string getSelectedText () const
 get the text of the currently selected button More...
 
ICLQt_API std::string getText (int id) const
 returns the text of a button with given index More...
 
ICLQt_API void setText (int id, const std::string &text)
 sets the text of a button with index ot a given text More...
 
ICLQt_API void disable ()
 disables all radio buttons More...
 
ICLQt_API void enable ()
 enables all radio buttons More...
 
ICLQt_API void disable (int index)
 disables button at index More...
 
ICLQt_API void enable (int index)
 enables button at index More...
 
- Public Member Functions inherited from icl::qt::GUIHandle< RadioButtonVec >
const RadioButtonVecoperator* () const
 use the *-oprator to get the wrapped component (const) More...
 
RadioButtonVec *& operator* ()
 use the *-oprator to get the wrapped component (unconst) More...
 
RadioButtonVecoperator-> ()
 this can be used for direct access to wrapped type More...
 
const RadioButtonVecoperator-> () 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

int n () const
 utility function (number of elements) More...
 
bool valid (int id) const
 utility function (check indices for being valid) More...
 
RadioButtonVecvec ()
 utitliy function returns the underlying vector More...
 
const RadioButtonVecvec () const
 utitliy function returns the underlying vector (const) More...
 

Additional Inherited Members

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

Class for handling button goups.

Constructor & Destructor Documentation

icl::qt::ButtonGroupHandle::ButtonGroupHandle ( )
inline

Create an empty handle.

icl::qt::ButtonGroupHandle::ButtonGroupHandle ( RadioButtonVec buttons,
GUIWidget w 
)
inline

Craete a valid handle.

Member Function Documentation

ICLQt_API void icl::qt::ButtonGroupHandle::disable ( )

disables all radio buttons

ICLQt_API void icl::qt::ButtonGroupHandle::disable ( int  index)

disables button at index

ICLQt_API void icl::qt::ButtonGroupHandle::enable ( )

enables all radio buttons

ICLQt_API void icl::qt::ButtonGroupHandle::enable ( int  index)

enables button at index

ICLQt_API int icl::qt::ButtonGroupHandle::getSelected ( ) const

get the selected index

ICLQt_API std::string icl::qt::ButtonGroupHandle::getSelectedText ( ) const

get the text of the currently selected button

ICLQt_API std::string icl::qt::ButtonGroupHandle::getText ( int  id) const

returns the text of a button with given index

int icl::qt::ButtonGroupHandle::n ( ) const
inlineprivate

utility function (number of elements)

ICLQt_API void icl::qt::ButtonGroupHandle::select ( int  id)

select a button with given index

ICLQt_API void icl::qt::ButtonGroupHandle::setText ( int  id,
const std::string &  text 
)

sets the text of a button with index ot a given text

bool icl::qt::ButtonGroupHandle::valid ( int  id) const
inlineprivate

utility function (check indices for being valid)

RadioButtonVec& icl::qt::ButtonGroupHandle::vec ( )
inlineprivate

utitliy function returns the underlying vector

const RadioButtonVec& icl::qt::ButtonGroupHandle::vec ( ) const
inlineprivate

utitliy function returns the underlying vector (const)


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