Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::qt::BoxHandle Class Reference

A Handle for container GUI components (hbox, vbox, hscroll and vscroll) More...

#include <BoxHandle.h>

Inheritance diagram for icl::qt::BoxHandle:
icl::qt::GUIHandle< QWidget > icl::qt::ContainerHandle icl::qt::GUIHandleBase

Public Member Functions

 BoxHandle ()
 empty base constructor More...
 
 BoxHandle (bool isHorizontal, QWidget *w, GUIWidget *guiw, QScrollArea *scroll=0)
 create an empty handle More...
 
QLayout * getLayout ()
 returns the associated layout More...
 
virtual void add (QWidget *comp, const QString &name="")
 adds an external compnent to the underlying widgets layout More...
 
virtual void insert (int idx, QWidget *comp, const QString &name="")
 this does not work here (calls add, idx and name is ignored) More...
 
bool hasScroll () const
 returns whether this handle has More...
 
QScrollArea * getScroll ()
 returns the parent scroll area (which is null, if the component is hbox or vbox) More...
 
bool isHorizontal () const
 returns whether the layout orientation is horizontal More...
 
bool isVertical () const
 returns whether the layout orientation is vertical More...
 
- Public Member Functions inherited from icl::qt::GUIHandle< QWidget >
const QWidget * operator * () const
 use the *-oprator to get the wrapped component (const) More...
 
QWidget *& operator * ()
 use the *-oprator to get the wrapped component (unconst) More...
 
QWidget * operator-> ()
 this can be used for direct access to wrapped type More...
 
const QWidget * operator-> () const
 this can be used for direct access to wrapped type More...
 
bool isNull () const
 returns whether wrapped pointer is null or not More...
 
void enable ()
 enables the wrapped GUI component More...
 
void disable ()
 disables the wrapped GUI component More...
 
- Public Member Functions inherited from icl::qt::GUIHandleBase
virtual ~GUIHandleBase ()
 virtual destructor More...
 
GUIWidgetgetGUIWidget ()
 returns parent GUIWidget pointer More...
 
virtual void registerCallback (const GUI::Callback &cb, const std::string &events="all")
 registers a callback on this gui widget More...
 
virtual void registerCallback (const GUI::ComplexCallback &cb, const std::string &events="all")
 registers a complex callback on this gui component More...
 
virtual void removeCallbacks ()
 removes all callbacks from parent GUIWidget component More...
 
virtual void cb ()
 envokes all registered callbacks More...
 
- Public Member Functions inherited from icl::qt::ContainerHandle
virtual ~ContainerHandle ()
 virtual destructor More...
 

Private Attributes

bool horizontal
 internal property that indicate the underlying layout orientation More...
 
QScrollArea * scroll
 optional parent QScrollArea More...
 

Additional Inherited Members

- Protected Member Functions inherited from icl::qt::GUIHandle< QWidget >
 GUIHandle ()
 as GUIHandle is just an interface, its base constructor is protected More...
 
 GUIHandle (QWidget *t, GUIWidget *w)
 as GUIHandle is just an interface, its base constructor is protected More...
 
- Protected Member Functions inherited from icl::qt::GUIHandleBase
 GUIHandleBase (GUIWidget *w=0)
 create a new GUIHandleBase More...
 
- Protected Member Functions inherited from icl::qt::ContainerHandle
 ContainerHandle ()
 must be subclassed More...
 

Detailed Description

A Handle for container GUI components (hbox, vbox, hscroll and vscroll)

Constructor & Destructor Documentation

◆ BoxHandle() [1/2]

icl::qt::BoxHandle::BoxHandle ( )
inline

empty base constructor

◆ BoxHandle() [2/2]

icl::qt::BoxHandle::BoxHandle ( bool  isHorizontal,
QWidget *  w,
GUIWidget guiw,
QScrollArea *  scroll = 0 
)
inline

create an empty handle

Member Function Documentation

◆ add()

virtual void icl::qt::BoxHandle::add ( QWidget *  comp,
const QString &  name = "" 
)
inlinevirtual

adds an external compnent to the underlying widgets layout

name is ignored

Reimplemented from icl::qt::ContainerHandle.

◆ getLayout()

QLayout* icl::qt::BoxHandle::getLayout ( )
inline

returns the associated layout

◆ getScroll()

QScrollArea* icl::qt::BoxHandle::getScroll ( )
inline

returns the parent scroll area (which is null, if the component is hbox or vbox)

◆ hasScroll()

bool icl::qt::BoxHandle::hasScroll ( ) const
inline

returns whether this handle has

◆ insert()

virtual void icl::qt::BoxHandle::insert ( int  idx,
QWidget *  comp,
const QString &  name = "" 
)
inlinevirtual

this does not work here (calls add, idx and name is ignored)

Reimplemented from icl::qt::ContainerHandle.

◆ isHorizontal()

bool icl::qt::BoxHandle::isHorizontal ( ) const
inline

returns whether the layout orientation is horizontal

◆ isVertical()

bool icl::qt::BoxHandle::isVertical ( ) const
inline

returns whether the layout orientation is vertical

Member Data Documentation

◆ horizontal

bool icl::qt::BoxHandle::horizontal
private

internal property that indicate the underlying layout orientation

◆ scroll

QScrollArea* icl::qt::BoxHandle::scroll
private

optional parent QScrollArea


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