Image Component Library (ICL)
Public Member Functions | Static Private Member Functions | List of all members
icl::qt::Button Struct Reference

Button Component. More...

#include <GUIComponents.h>

Inheritance diagram for icl::qt::Button:
icl::qt::GUIComponentWithOutput icl::qt::GUIComponent

Public Member Functions

 Button (const std::string &text, const std::string &toggledText="", bool initiallyToggled=false)
 creates button component (if toggledText is empty, a push-button is created) More...
 
- Public Member Functions inherited from icl::qt::GUIComponentWithOutput
 GUIComponentWithOutput (const std::string &type, const std::string &params)
 
const GUIComponentWithOutputhandle (const std::string &handle) const
 sets the component handle More...
 
const GUIComponentWithOutputlabel (const std::string &label) const
 sets the component label More...
 
const GUIComponentWithOutputtooltip (const std::string &tooltip) const
 sets the component tooltip More...
 
const GUIComponentWithOutputsize (const utils::Size &size) const
 sets the component initial size More...
 
const GUIComponentWithOutputsize (int w, int h) const
 sets the component initial size More...
 
const GUIComponentWithOutputminSize (const utils::Size &minSize) const
 sets the component minimum size constraint More...
 
const GUIComponentWithOutputminSize (int w, int h) const
 sets the component minimum size constraint More...
 
const GUIComponentWithOutputmaxSize (const utils::Size &maxSize) const
 sets the component maximum size constraint More...
 
const GUIComponentWithOutputmaxSize (int w, int h) const
 sets the component maximum size constraint More...
 
const GUIComponentWithOutputhideIf (bool flag) const
 hides the component if the given flag is true More...
 
const GUIComponentWithOutputout (const std::string &name) const
 sets the component output id More...
 
GUIComponentWithOutputhandle (std::string &handle)
 sets the component handle More...
 
GUIComponentWithOutputlabel (std::string &label)
 sets the component label More...
 
GUIComponentWithOutputtooltip (std::string &tooltip)
 sets the component tooltip More...
 
GUIComponentWithOutputsize (utils::Size &size)
 sets the component initial size More...
 
GUIComponentWithOutputsize (int w, int h)
 sets the component initial size More...
 
GUIComponentWithOutputminSize (utils::Size &minSize)
 sets the component minimum size constraint More...
 
GUIComponentWithOutputminSize (int w, int h)
 sets the component minimum size constraint More...
 
GUIComponentWithOutputmaxSize (utils::Size &maxSize)
 sets the component maximum size constraint More...
 
GUIComponentWithOutputmaxSize (int w, int h)
 sets the component maximum size constraint More...
 
GUIComponentWithOutputhideIf (bool flag)
 hides the component if the given flag is true More...
 
GUIComponentWithOutputout (const std::string &name)
 sets the component output id More...
 
- Public Member Functions inherited from icl::qt::GUIComponent
const GUIComponenthandle (const std::string &handle) const
 sets the component handle More...
 
const GUIComponentlabel (const std::string &label) const
 sets the component label More...
 
const GUIComponenttooltip (const std::string &tooltip) const
 sets the component tooltip More...
 
const GUIComponentsize (const utils::Size &size) const
 sets the component initial size More...
 
const GUIComponentsize (int w, int h) const
 sets the component initial size More...
 
const GUIComponentminSize (const utils::Size &minSize) const
 sets the component minimum size constraint More...
 
const GUIComponentminSize (int w, int h) const
 sets the component minimum size constraint More...
 
const GUIComponentmaxSize (const utils::Size &maxSize) const
 sets the component maximum size constraint More...
 
const GUIComponentmaxSize (int w, int h) const
 sets the component maximum size constraint More...
 
const GUIComponenthideIf (bool flag) const
 hides the component if the given flag is true More...
 
GUIComponenthandle (std::string &handle)
 sets the component handle More...
 
GUIComponentlabel (std::string &label)
 sets the component label More...
 
GUIComponenttooltip (std::string &tooltip)
 sets the component tooltip More...
 
GUIComponentsize (utils::Size &size)
 sets the component initial size More...
 
GUIComponentsize (int w, int h)
 sets the component initial size More...
 
GUIComponentminSize (utils::Size &minSize)
 sets the component minimum size constraint More...
 
GUIComponentminSize (int w, int h)
 sets the component minimum size constraint More...
 
GUIComponentmaxSize (utils::Size &maxSize)
 sets the component maximum size constraint More...
 
GUIComponentmaxSize (int w, int h)
 sets the component maximum size constraint More...
 
GUIComponenthideIf (bool flag)
 hides the component if the given flag is true More...
 
std::string toString () const
 creates a string representation of the component More...
 

Static Private Member Functions

static std::string form_args (const std::string &text, const std::string &toggledText, bool initiallyToggled)
 utility method More...
 

Additional Inherited Members

- Protected Member Functions inherited from icl::qt::GUIComponent
 GUIComponent (const std::string &type, const std::string &params="")
 creates a component with given type and optionally given parameters More...
 
- Static Protected Member Functions inherited from icl::qt::GUIComponent
template<class A , class B , class C >
static std::string form_args_3 (const A &a, const B &b, const C &c)
 utility method to concatenate 3 values More...
 
template<class A , class B , class C , class D >
static std::string form_args_4 (const A &a, const B &b, const C &c, const D &d)
 utility method to concatenate 4 values More...
 
template<class A , class B , class C , class D , class E >
static std::string form_args_5 (const A &a, const B &b, const C &c, const D &d, const E &e)
 utility method to concatenate 5 values More...
 
template<class A , class B , class C , class D , class E , class F >
static std::string form_args_6 (const A &a, const B &b, const C &c, const D &d, const E &e, const F &f)
 utility method to concatenate 5 values More...
 
- Protected Attributes inherited from icl::qt::GUIComponent
Options m_options
 all component options (mutable for C++-reasons) More...
 
std::string m_type
 component type More...
 
std::string m_params
 component parameters More...
 

Detailed Description

Button Component.

Buttons can either be push- or toggle buttons. Buttons create a ButtonHandle. If a toggle button is created, also an output of type bool is created, which is true as long as the button is toggled.

Constructor & Destructor Documentation

◆ Button()

icl::qt::Button::Button ( const std::string &  text,
const std::string &  toggledText = "",
bool  initiallyToggled = false 
)
inline

creates button component (if toggledText is empty, a push-button is created)

Member Function Documentation

◆ form_args()

static std::string icl::qt::Button::form_args ( const std::string &  text,
const std::string &  toggledText,
bool  initiallyToggled 
)
inlinestaticprivate

utility method


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