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

#include <GUIComponentWithOutput.h>

Inheritance diagram for icl::qt::GUIComponentWithOutput:
icl::qt::GUIComponent icl::qt::Button icl::qt::ButtonGroup icl::qt::CheckBox icl::qt::ColorSelect icl::qt::Float icl::qt::FSlider icl::qt::Int icl::qt::Slider icl::qt::Spinner

Public Member Functions

 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...
 

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...
 

Constructor & Destructor Documentation

◆ GUIComponentWithOutput()

icl::qt::GUIComponentWithOutput::GUIComponentWithOutput ( const std::string &  type,
const std::string &  params 
)
inline

Member Function Documentation

◆ handle() [1/2]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::handle ( const std::string &  handle) const
inline

sets the component handle

◆ handle() [2/2]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::handle ( std::string &  handle)
inline

sets the component handle

◆ hideIf() [1/2]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::hideIf ( bool  flag) const
inline

hides the component if the given flag is true

hides the component if the given flag is true this can be used to circumvent C++-language issues when creating GUI components optionally, e.g.

bool flag = ....;
GUI gui;
gui << (flag ? Image() : Dummy()).handle("image"); // does not work
gui << Image().hideIf(!flag).handle("image"); // works

◆ hideIf() [2/2]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::hideIf ( bool  flag)
inline

hides the component if the given flag is true

hides the component if the given flag is true this can be used to circumvent C++-language issues when creating GUI components optionally, e.g.

bool flag = ....;
GUI gui;
gui << (flag ? Image() : Dummy()).handle("image"); // does not work
gui << Image().hideIf(!flag).handle("image"); // works

◆ label() [1/2]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::label ( const std::string &  label) const
inline

sets the component label

◆ label() [2/2]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::label ( std::string &  label)
inline

sets the component label

◆ maxSize() [1/4]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::maxSize ( const utils::Size maxSize) const
inline

sets the component maximum size constraint

◆ maxSize() [2/4]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::maxSize ( int  w,
int  h 
) const
inline

sets the component maximum size constraint

◆ maxSize() [3/4]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::maxSize ( utils::Size maxSize)
inline

sets the component maximum size constraint

◆ maxSize() [4/4]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::maxSize ( int  w,
int  h 
)
inline

sets the component maximum size constraint

◆ minSize() [1/4]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::minSize ( const utils::Size minSize) const
inline

sets the component minimum size constraint

◆ minSize() [2/4]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::minSize ( int  w,
int  h 
) const
inline

sets the component minimum size constraint

◆ minSize() [3/4]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::minSize ( utils::Size minSize)
inline

sets the component minimum size constraint

◆ minSize() [4/4]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::minSize ( int  w,
int  h 
)
inline

sets the component minimum size constraint

◆ out() [1/2]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::out ( const std::string &  name) const
inline

sets the component output id

◆ out() [2/2]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::out ( const std::string &  name)
inline

sets the component output id

◆ size() [1/4]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::size ( const utils::Size size) const
inline

sets the component initial size

◆ size() [2/4]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::size ( int  w,
int  h 
) const
inline

sets the component initial size

◆ size() [3/4]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::size ( utils::Size size)
inline

sets the component initial size

◆ size() [4/4]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::size ( int  w,
int  h 
)
inline

sets the component initial size

◆ tooltip() [1/2]

const GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::tooltip ( const std::string &  tooltip) const
inline

sets the component tooltip

◆ tooltip() [2/2]

GUIComponentWithOutput& icl::qt::GUIComponentWithOutput::tooltip ( std::string &  tooltip)
inline

sets the component tooltip


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