Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
icl::qt::GUIComponent Class Reference

The GUIComponent class servers as a generic interface for GUI definitions. More...

#include <GUIComponent.h>

Inheritance diagram for icl::qt::GUIComponent:
icl::geom::Plot3D icl::qt::CamCfg icl::qt::Combo icl::qt::Create icl::qt::Disp icl::qt::Draw icl::qt::Draw3D icl::qt::Dummy icl::qt::Fps icl::qt::GUIComponentWithOutput icl::qt::Image icl::qt::Label icl::qt::Plot icl::qt::Prop icl::qt::Ps icl::qt::Show icl::qt::State icl::qt::String

Classes

struct  Options
 Actual options (set using the .xxx methods) More...
 

Public Member Functions

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

Protected Member Functions

 GUIComponent (const std::string &type, const std::string &params="")
 creates a component with given type and optionally given parameters More...
 

Static Protected Member Functions

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

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

Friends

struct ContainerGUIComponent
 friend container class More...
 
class GUI
 friend GUI class More...
 

Detailed Description

The GUIComponent class servers as a generic interface for GUI definitions.

Please refer to the ICL-manual for an introduction to the GUI toolkit

Constructor & Destructor Documentation

icl::qt::GUIComponent::GUIComponent ( const std::string &  type,
const std::string &  params = "" 
)
inlineprotected

creates a component with given type and optionally given parameters

the params parameter is a comma-separated list of single entries

Member Function Documentation

template<class A , class B , class C >
static std::string icl::qt::GUIComponent::form_args_3 ( const A &  a,
const B &  b,
const C &  c 
)
inlinestaticprotected

utility method to concatenate 3 values

template<class A , class B , class C , class D >
static std::string icl::qt::GUIComponent::form_args_4 ( const A &  a,
const B &  b,
const C &  c,
const D &  d 
)
inlinestaticprotected

utility method to concatenate 4 values

template<class A , class B , class C , class D , class E >
static std::string icl::qt::GUIComponent::form_args_5 ( const A &  a,
const B &  b,
const C &  c,
const D &  d,
const E &  e 
)
inlinestaticprotected

utility method to concatenate 5 values

template<class A , class B , class C , class D , class E , class F >
static std::string icl::qt::GUIComponent::form_args_6 ( const A &  a,
const B &  b,
const C &  c,
const D &  d,
const E &  e,
const F &  f 
)
inlinestaticprotected

utility method to concatenate 5 values

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

sets the component handle

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

sets the component handle

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

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
GUIComponent& icl::qt::GUIComponent::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
const GUIComponent& icl::qt::GUIComponent::label ( const std::string &  label) const
inline

sets the component label

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

sets the component label

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

sets the component maximum size constraint

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

sets the component maximum size constraint

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

sets the component maximum size constraint

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

sets the component maximum size constraint

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

sets the component minimum size constraint

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

sets the component minimum size constraint

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

sets the component minimum size constraint

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

sets the component minimum size constraint

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

sets the component initial size

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

sets the component initial size

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

sets the component initial size

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

sets the component initial size

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

sets the component tooltip

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

sets the component tooltip

std::string icl::qt::GUIComponent::toString ( ) const
inline

creates a string representation of the component

Friends And Related Function Documentation

friend struct ContainerGUIComponent
friend

friend container class

friend class GUI
friend

friend GUI class

Member Data Documentation

Options icl::qt::GUIComponent::m_options
mutableprotected

all component options (mutable for C++-reasons)

std::string icl::qt::GUIComponent::m_params
protected

component parameters

std::string icl::qt::GUIComponent::m_type
protected

component type


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