Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes | Friends
icl::qt::ButtonHandle Class Reference

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

#include <ButtonHandle.h>

Inheritance diagram for icl::qt::ButtonHandle:
icl::qt::GUIHandle< QPushButton > icl::qt::GUIHandleBase

List of all members.

Public Member Functions

ICLQt_API ButtonHandle ()
 creates a n empty button handle
ICLQt_API ButtonHandle (QPushButton *b, GUIWidget *w)
 create a new event with a given button id
ICLQt_API bool wasTriggered (bool reset=true)
 check if this event/button was triggered
void trigger (bool execCallbacks=true)
 trigger this event (sets the internal boolean variable to true)
ICLQt_API void reset ()
 sets the internal boolean variable to false
ICLQt_API const std::string & getID () const
 returns this buttons id (uncommon)

Private Attributes

utils::SmartPtr< bool > m_triggered
 internal boolean variable
std::string m_sID
 corresponding id

Friends

class ButtonGUIWidget
class ToggleButtonGUIWidget

Detailed Description

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


Constructor & Destructor Documentation

creates a n empty button handle

create a new event with a given button id


Member Function Documentation

ICLQt_API const std::string& icl::qt::ButtonHandle::getID ( ) const

returns this buttons id (uncommon)

sets the internal boolean variable to false

void icl::qt::ButtonHandle::trigger ( bool  execCallbacks = true) [inline]

trigger this event (sets the internal boolean variable to true)

ICLQt_API bool icl::qt::ButtonHandle::wasTriggered ( bool  reset = true)

check if this event/button was triggered

Parameters:
resetif set to true the internal boolen variable is set to false, so wasTriggered returns true only if the button was triggered again

Friends And Related Function Documentation

friend class ButtonGUIWidget [friend]
friend class ToggleButtonGUIWidget [friend]

Member Data Documentation

std::string icl::qt::ButtonHandle::m_sID [private]

corresponding id

internal boolean variable


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines