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

Special GUI extension, that mimics the GUIComponent interface. More...

#include <ContainerGUIComponent.h>

Inheritance diagram for icl::qt::ContainerGUIComponent:
icl::qt::GUI icl::qt::Border icl::qt::HBox icl::qt::HScroll icl::qt::HSplit icl::qt::Tab icl::qt::VBox icl::qt::VScroll icl::qt::VSplit

Public Member Functions

GUIoperator<< (const GUIComponent &component) const
 hierarchical stream operator to create complex GUIs More...
 
GUIoperator<< (const GUI &g) const
 hierarchical stream operator to create complex GUIs More...
 
const ContainerGUIComponenthandle (const std::string &handle) const
 sets the component's handle More...
 
const ContainerGUIComponentlabel (const std::string &label) const
 sets the component's label More...
 
const ContainerGUIComponentsize (const utils::Size &size) const
 sets the component's initial size More...
 
const ContainerGUIComponentsize (int w, int h) const
 sets the component's initial size More...
 
const ContainerGUIComponentminSize (const utils::Size &minSize) const
 sets the component's minimum size constraint More...
 
const ContainerGUIComponentminSize (int w, int h) const
 sets the component's minimum size constraint More...
 
const ContainerGUIComponentmaxSize (const utils::Size &maxSize) const
 sets the component's maximum size constraint More...
 
const ContainerGUIComponentmaxSize (int w, int h) const
 sets the component's maximum size constraint More...
 
const ContainerGUIComponentmargin (int margin) const
 sets the component's layout margin More...
 
const ContainerGUIComponentspacing (int spacing) const
 sets the component's layout spacing More...
 
ContainerGUIComponenthandle (const std::string &handle)
 sets the component's handle More...
 
ContainerGUIComponentlabel (const std::string &label)
 sets the component's label More...
 
ContainerGUIComponentsize (const utils::Size &size)
 sets the component's initial size More...
 
ContainerGUIComponentsize (int w, int h)
 sets the component's initial size More...
 
ContainerGUIComponentminSize (const utils::Size &minSize)
 sets the component's minimum size constraint More...
 
ContainerGUIComponentminSize (int w, int h)
 sets the component's minimum size constraint More...
 
ContainerGUIComponentmaxSize (const utils::Size &maxSize)
 sets the component's maximum size constraint More...
 
ContainerGUIComponentmaxSize (int w, int h)
 sets the component's maximum size constraint More...
 
ContainerGUIComponentmargin (int margin)
 sets the component's layout margin More...
 
ContainerGUIComponentspacing (int spacing)
 sets the component's layout spacing More...
 
- Public Member Functions inherited from icl::qt::GUI
 GUI (QWidget *parent=0)
 Default constructor, creates a vbox GUI Component. More...
 
 GUI (const GUIComponent &component, QWidget *parent=0)
 creates a GUI from a givne GUIComponent More...
 
 GUI (const GUI &gui, QWidget *parent=0)
 copy constructor More...
 
GUIoperator= (const GUI &other)
 gui-copy operator More...
 
virtual ~GUI ()
 Destructor. More...
 
virtual GUIoperator<< (const GUIComponent &component)
 adds a new GUI component More...
 
virtual GUIoperator<< (const GUI &g)
 stream operator to add new other GUIs More...
 
template<class T >
T & allocValue (const std::string &id, const T &val=T())
 wraps the data-stores allocValue function More...
 
template<class T >
void release (const std::string &id)
 wraps the datastores release function More...
 
template<class T >
T & get (const std::string &id, bool typeCheck=true)
 
DataStore::Data operator[] (const std::string &key)
 returns a Data instance from the datastore More...
 
template<class T >
std::vector< T > collect (const std::vector< std::string > &keys)
 collects data from different components at once More...
 
virtual bool isVisible () const
 returns whether this gui is actually visible More...
 
virtual void create ()
 internally creates everything More...
 
virtual void show ()
 internally creates everything (and makes the gui visible) More...
 
virtual void hide ()
 make this gui invisible (nothing more) More...
 
virtual void switchVisibility ()
 if widget is visible, this hides the widget, otherwise the widget is shown More...
 
GUIWidgetgetRootWidget ()
 returns the root widget of the gui (only avialable after create() or show()) More...
 
void lockData ()
 internally locks the datastore More...
 
void unlockData ()
 internally unlocks the data store More...
 
void waitForCreation ()
 waits for the gui to be created completely More...
 
const DataStoregetDataStore () const
 returns the GUI internal dataStore More...
 
void registerCallback (const Callback &cb, const std::string &handleNamesList, char listDelim=',')
 registers a callback function on each component More...
 
void registerCallback (const ComplexCallback &cb, const std::string &handleNamesList, char listDelim=',')
 registeres a complex callback at a given GUI component More...
 
void removeCallbacks (const std::string &handleNamesList, char listDelim=',')
 removes all callbacks from components More...
 
bool isDummy () const
 returns whether this GUI is a dummy GUI More...
 
bool hasBeenCreated () const
 returns whether this GUI has been created or not More...
 
std::string createXMLDescription () const
 creates a hierarchical xml-description of the GUI Layout More...
 

Protected Member Functions

 ContainerGUIComponent (const std::string &type, const std::string &params, QWidget *parent)
 protected constructor More...
 
virtual std::string createDefinition () const
 special reimplementation of the GUI::createDefinition method More...
 
- Protected Member Functions inherited from icl::qt::GUI
 GUI (const std::string &definition, QWidget *parent)
 default constructor More...
 

Protected Attributes

GUIComponent component
 we use these options to create the More...
 

Additional Inherited Members

- Public Types inherited from icl::qt::GUI
typedef utils::Function
< GUIWidget *, const
GUIDefinition & > 
CreatorFunction
 registered widget type creator function More...
 
typedef utils::Function< void > Callback
 simple callback, that can be registered at GUI components More...
 
typedef utils::Function< void,
const std::string & > 
ComplexCallback
 complex callback type that can be registered at GUI components More...
 
- Static Public Member Functions inherited from icl::qt::GUI
static void register_widget_type (const std::string &tag, CreatorFunction f)
 registers a new widget type More...
 
static GUI create_gui_from_string (const std::string &definition, QWidget *parent)
 legacy creation method (use with care) More...
 
- Static Public Attributes inherited from icl::qt::GUI
static const int CELLW = 20
 cell width (all sizes are given in this unit) More...
 
static const int CELLH = 20
 cell height (all sizes are given in this unit) More...
 

Detailed Description

Special GUI extension, that mimics the GUIComponent interface.

The Container GUIComponent mimics the GUIComponent interface in order to provide a unified look and feel within a hierarchical GUI definition section. Internally a mutable GUIComponent is used for parameter accumulation

Constructor & Destructor Documentation

icl::qt::ContainerGUIComponent::ContainerGUIComponent ( const std::string &  type,
const std::string &  params,
QWidget *  parent 
)
inlineprotected

protected constructor

Member Function Documentation

virtual std::string icl::qt::ContainerGUIComponent::createDefinition ( ) const
inlineprotectedvirtual

special reimplementation of the GUI::createDefinition method

Reimplemented from icl::qt::GUI.

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

sets the component's handle

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

sets the component's handle

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

sets the component's label

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

sets the component's label

const ContainerGUIComponent& icl::qt::ContainerGUIComponent::margin ( int  margin) const
inline

sets the component's layout margin

ContainerGUIComponent& icl::qt::ContainerGUIComponent::margin ( int  margin)
inline

sets the component's layout margin

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

sets the component's maximum size constraint

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

sets the component's maximum size constraint

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

sets the component's maximum size constraint

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

sets the component's maximum size constraint

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

sets the component's minimum size constraint

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

sets the component's minimum size constraint

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

sets the component's minimum size constraint

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

sets the component's minimum size constraint

GUI& icl::qt::ContainerGUIComponent::operator<< ( const GUIComponent component) const
inline

hierarchical stream operator to create complex GUIs

GUI& icl::qt::ContainerGUIComponent::operator<< ( const GUI g) const
inline

hierarchical stream operator to create complex GUIs

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

sets the component's initial size

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

sets the component's initial size

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

sets the component's initial size

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

sets the component's initial size

const ContainerGUIComponent& icl::qt::ContainerGUIComponent::spacing ( int  spacing) const
inline

sets the component's layout spacing

ContainerGUIComponent& icl::qt::ContainerGUIComponent::spacing ( int  spacing)
inline

sets the component's layout spacing

Member Data Documentation

GUIComponent icl::qt::ContainerGUIComponent::component
mutableprotected

we use these options to create the

Please note that inheritance is not possible because it leads to an abiguous overload for the GUI<<-operator


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