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 GUIComponentWithOutput & handle (const std::string &handle) const
 sets the component handle More...
 
const GUIComponentWithOutput & label (const std::string &label) const
 sets the component label More...
 
const GUIComponentWithOutput & tooltip (const std::string &tooltip) const
 sets the component tooltip More...
 
const GUIComponentWithOutput & size (const utils::Size &size) const
 sets the component initial size More...
 
const GUIComponentWithOutput & size (int w, int h) const
 sets the component initial size More...
 
const GUIComponentWithOutput & minSize (const utils::Size &minSize) const
 sets the component minimum size constraint More...
 
const GUIComponentWithOutput & minSize (int w, int h) const
 sets the component minimum size constraint More...
 
const GUIComponentWithOutput & maxSize (const utils::Size &maxSize) const
 sets the component maximum size constraint More...
 
const GUIComponentWithOutput & maxSize (int w, int h) const
 sets the component maximum size constraint More...
 
const GUIComponentWithOutput & hideIf (bool flag) const
 hides the component if the given flag is true More...
 
const GUIComponentWithOutput & out (const std::string &name) const
 sets the component output id More...
 
GUIComponentWithOutput & handle (std::string &handle)
 sets the component handle More...
 
GUIComponentWithOutput & label (std::string &label)
 sets the component label More...
 
GUIComponentWithOutput & tooltip (std::string &tooltip)
 sets the component tooltip More...
 
GUIComponentWithOutput & size (utils::Size &size)
 sets the component initial size More...
 
GUIComponentWithOutput & size (int w, int h)
 sets the component initial size More...
 
GUIComponentWithOutput & minSize (utils::Size &minSize)
 sets the component minimum size constraint More...
 
GUIComponentWithOutput & minSize (int w, int h)
 sets the component minimum size constraint More...
 
GUIComponentWithOutput & maxSize (utils::Size &maxSize)
 sets the component maximum size constraint More...
 
GUIComponentWithOutput & maxSize (int w, int h)
 sets the component maximum size constraint More...
 
GUIComponentWithOutput & hideIf (bool flag)
 hides the component if the given flag is true More...
 
GUIComponentWithOutput & out (const std::string &name)
 sets the component output id More...
 
- Public Member Functions inherited from icl::qt::GUIComponent
const GUIComponent & handle (const std::string &handle) const
 sets the component handle More...
 
const GUIComponent & label (const std::string &label) const
 sets the component label More...
 
const GUIComponent & tooltip (const std::string &tooltip) const
 sets the component tooltip More...
 
const GUIComponent & size (const utils::Size &size) const
 sets the component initial size More...
 
const GUIComponent & size (int w, int h) const
 sets the component initial size More...
 
const GUIComponent & minSize (const utils::Size &minSize) const
 sets the component minimum size constraint More...
 
const GUIComponent & minSize (int w, int h) const
 sets the component minimum size constraint More...
 
const GUIComponent & maxSize (const utils::Size &maxSize) const
 sets the component maximum size constraint More...
 
const GUIComponent & maxSize (int w, int h) const
 sets the component maximum size constraint More...
 
const GUIComponent & hideIf (bool flag) const
 hides the component if the given flag is true More...
 
GUIComponent & handle (std::string &handle)
 sets the component handle More...
 
GUIComponent & label (std::string &label)
 sets the component label More...
 
GUIComponent & tooltip (std::string &tooltip)
 sets the component tooltip More...
 
GUIComponent & size (utils::Size &size)
 sets the component initial size More...
 
GUIComponent & size (int w, int h)
 sets the component initial size More...
 
GUIComponent & minSize (utils::Size &minSize)
 sets the component minimum size constraint More...
 
GUIComponent & minSize (int w, int h)
 sets the component minimum size constraint More...
 
GUIComponent & maxSize (utils::Size &maxSize)
 sets the component maximum size constraint More...
 
GUIComponent & maxSize (int w, int h)
 sets the component maximum size constraint More...
 
GUIComponent & hideIf (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: