OpenWalnut  1.5.0dev
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
WUIQtPropertyGroupWidget Class Reference

Implementation of WUIPropertyGroupWidget. More...

#include <WUIQtPropertyGroupWidget.h>

+ Inheritance diagram for WUIQtPropertyGroupWidget:
+ Collaboration diagram for WUIQtPropertyGroupWidget:

Public Types

typedef std::shared_ptr< WUIQtPropertyGroupWidget > SPtr
 Convenience typedef for a std::shared_ptr< WUIQtPropertyGroupWidget >. More...
 
typedef std::shared_ptr< const WUIQtPropertyGroupWidget > ConstSPtr
 Convenience typedef for a std::shared_ptr< const WUIQtPropertyGroupWidget >. More...
 
- Public Types inherited from WUIPropertyGroupWidget
typedef std::shared_ptr< WUIPropertyGroupWidget > SPtr
 Convenience typedef for a std::shared_ptr< WUIPropertyGroupWidget >. More...
 
typedef std::shared_ptr< const WUIPropertyGroupWidget > ConstSPtr
 Convenience typedef for a std::shared_ptr< const WUIPropertyGroupWidget >. More...
 
- Public Types inherited from WUIWidgetBase
typedef std::shared_ptr< WUIWidgetBase > SPtr
 Convenience typedef for a std::shared_ptr< WUIWidgetBase >. More...
 
typedef std::shared_ptr< const WUIWidgetBase > ConstSPtr
 Convenience typedef for a std::shared_ptr< const WUIWidgetBase >. More...
 
- Public Types inherited from WUIQtWidgetBase
typedef std::shared_ptr< WUIQtWidgetBase > SPtr
 Convenience typedef for a std::shared_ptr< WUIQtWidgetBase >. More...
 
typedef std::shared_ptr< const WUIQtWidgetBase > ConstSPtr
 Convenience typedef for a std::shared_ptr< const WUIQtWidgetBase >. More...
 

Public Member Functions

 WUIQtPropertyGroupWidget (std::string title, WPropGroup properties, WMainWindow *mainWindow, WUIQtWidgetBase::SPtr parent=WUIQtWidgetBase::SPtr())
 Default constructor. More...
 
virtual ~WUIQtPropertyGroupWidget ()
 Destructor. More...
 
virtual QString getTitleQString () const
 Title as QString. More...
 
virtual void show ()
 Show this widget if not yet visible. More...
 
virtual void setVisible (bool visible=true)
 Hide/show this widget. More...
 
virtual bool isVisible () const
 Check if the widget is hidden or not. More...
 
virtual void close ()
 Handle shutdown. More...
 
virtual WPropGroup getPropertyGroup () const
 The property group shown by this widget. More...
 
virtual void addAction (WPropGroup group, WGEImage::SPtr icon=WGEImage::SPtr())
 Implement WUIWidgetBase::addAction. More...
 
virtual void addAction (WPropTrigger trigger, WGEImage::SPtr icon=WGEImage::SPtr())
 Implement WUIWidgetBase::addAction. More...
 
virtual void addAction (WPropBool toggle, WGEImage::SPtr icon=WGEImage::SPtr())
 Implement WUIWidgetBase::addAction. More...
 
- Public Member Functions inherited from WUIPropertyGroupWidget
virtual ~WUIPropertyGroupWidget ()
 Destructor. More...
 
- Public Member Functions inherited from WUIWidgetBase
virtual ~WUIWidgetBase ()
 Destructor. More...
 
virtual std::string getTitle () const
 Get the title of the widget. More...
 
void close ()
 Close the widget. More...
 
bool isClosed () const
 Checks whether the widget was closed already. More...
 
WCondition::SPtr getCloseCondition () const
 Return the condition that fires when the widgets closes. More...
 
virtual WUIWidgetBase::SPtr getParent () const
 Get the parent widget of this widget if any. More...
 
virtual bool allowNesting () const
 Tell the user whether this kind of widget can be used as parent. More...
 
- Public Member Functions inherited from WUIQtWidgetBase
 WUIQtWidgetBase (WMainWindow *mainWindow, WUIQtWidgetBase::SPtr parent)
 Default constructor. More...
 
virtual ~WUIQtWidgetBase ()
 Destructor. More...
 
virtual bool isReal ()
 The widget was created and can be used. More...
 
virtual void realize (WCondition::SPtr abortCondition=WCondition::SPtr())
 Realize the widget. More...
 
QWidget * getWidget () const
 Get the widget representation. More...
 
QWidget * getParentAsQtWidget () const
 Get the parent as Qt widget. More...
 
WUIQtWidgetBase::SPtr getQtParent () const
 Parent widget. More...
 

Protected Member Functions

virtual void realizeImpl ()
 Realize the widget. More...
 
virtual void closeImpl ()
 Close the widget. More...
 
virtual void cleanUpGT ()
 Cleanup the GUI. More...
 
- Protected Member Functions inherited from WUIPropertyGroupWidget
 WUIPropertyGroupWidget (std::string title)
 Default constructor. More...
 
- Protected Member Functions inherited from WUIWidgetBase
 WUIWidgetBase (std::string title)
 Default constructor. More...
 
virtual void setParent (WUIWidgetBase::SPtr parent)
 Set the parent of this WUI widget. More...
 
virtual void registerChild (WUIWidgetBase::SPtr child)
 Register widget as child. More...
 
ChildContainer & getChildren ()
 Return the list of children. More...
 
const ChildContainer & getChildren () const
 Return the list of children. More...
 
void closeChildren ()
 Comfortable function to recurse a close call. More...
 
- Protected Member Functions inherited from WUIQtWidgetBase
virtual void showGT ()
 Show this widget if not yet visible. More...
 
virtual void setVisibleGT (bool visible=true)
 Hide/show this widget. More...
 
virtual bool isVisibleGT () const
 Check if the widget is hidden or not. More...
 
virtual void closeGT ()
 Close the widget. More...
 
QWidget * getCompellingQParent () const
 Returns the parent to use for your implementation in realizeImpl. More...
 
bool hasUIParent () const
 Check if the widget is embedded into another WUI widget. More...
 
QWidget * embedContent (QWidget *content)
 This method can be used if you just create some QWidget and do not want to take care about embedding the content in a dock if there is no parent, setting size constraints and similar. More...
 
virtual void addActionGroupGT (WPropGroup group, WGEImage::SPtr icon=WGEImage::SPtr())
 Implement WUIWidgetBase::addAction. More...
 
virtual void addActionTriggerGT (WPropTrigger trigger, WGEImage::SPtr icon=WGEImage::SPtr())
 Implement WUIWidgetBase::addAction. More...
 
virtual void addActionBoolGT (WPropBool toggle, WGEImage::SPtr icon=WGEImage::SPtr())
 Implement WUIWidgetBase::addAction. More...
 

Private Attributes

QWidget * m_propWidget
 The prop widget. More...
 
WPropGroup m_properties
 The properties to show. More...
 

Additional Inherited Members

- Protected Types inherited from WUIWidgetBase
typedef WSharedSequenceContainer< std::vector< WUIWidgetBase::SPtr > > ChildContainer
 Keep track of our child widgets. More...
 
- Protected Attributes inherited from WUIQtWidgetBase
WMainWindow * m_mainWindow
 The main window instance. More...
 
QWidget * m_widget
 The widget representing this abstract UI element. More...
 
WUIQtWidgetBase::SPtr m_parent
 Parent widget. More...
 

Detailed Description

Implementation of WUIPropertyGroupWidget.

Definition at line 40 of file WUIQtPropertyGroupWidget.h.

Member Typedef Documentation

◆ ConstSPtr

typedef std::shared_ptr< const WUIQtPropertyGroupWidget > WUIQtPropertyGroupWidget::ConstSPtr

Convenience typedef for a std::shared_ptr< const WUIQtPropertyGroupWidget >.

Definition at line 52 of file WUIQtPropertyGroupWidget.h.

◆ SPtr

typedef std::shared_ptr< WUIQtPropertyGroupWidget > WUIQtPropertyGroupWidget::SPtr

Convenience typedef for a std::shared_ptr< WUIQtPropertyGroupWidget >.

Definition at line 47 of file WUIQtPropertyGroupWidget.h.

Constructor & Destructor Documentation

◆ WUIQtPropertyGroupWidget()

WUIQtPropertyGroupWidget::WUIQtPropertyGroupWidget ( std::string  title,
WPropGroup  properties,
WMainWindow *  mainWindow,
WUIQtWidgetBase::SPtr  parent = WUIQtWidgetBase::SPtr() 
)

Default constructor.

Parameters
mainWindowthe main window instance
propertiesthe properties to show
parentthe Qt parent. Can be NULL.
titlethe title of the widget

Definition at line 36 of file WUIQtPropertyGroupWidget.cpp.

◆ ~WUIQtPropertyGroupWidget()

WUIQtPropertyGroupWidget::~WUIQtPropertyGroupWidget ( )
virtual

Destructor.

Definition at line 49 of file WUIQtPropertyGroupWidget.cpp.

Member Function Documentation

◆ addAction() [1/3]

virtual void WUIQtPropertyGroupWidget::addAction ( WPropBool  toggle,
WGEImage::SPtr  icon = WGEImage::SPtr() 
)
inlinevirtual

Implement WUIWidgetBase::addAction.

Parameters
togglethe property to use.
iconthe icon to use. Consider a minimum size of 32x32.

Reimplemented from WUIQtWidgetBase.

Definition at line 140 of file WUIQtPropertyGroupWidget.h.

References WUIQtWidgetBase::addAction().

+ Here is the call graph for this function:

◆ addAction() [2/3]

virtual void WUIQtPropertyGroupWidget::addAction ( WPropGroup  group,
WGEImage::SPtr  icon = WGEImage::SPtr() 
)
inlinevirtual

Implement WUIWidgetBase::addAction.

Parameters
groupthe property to use.
iconthe icon to use. Consider a minimum size of 32x32.

Reimplemented from WUIQtWidgetBase.

Definition at line 118 of file WUIQtPropertyGroupWidget.h.

References WUIQtWidgetBase::addAction().

+ Here is the call graph for this function:

◆ addAction() [3/3]

virtual void WUIQtPropertyGroupWidget::addAction ( WPropTrigger  trigger,
WGEImage::SPtr  icon = WGEImage::SPtr() 
)
inlinevirtual

Implement WUIWidgetBase::addAction.

Parameters
triggerthe property to use.
iconthe icon to use. Consider a minimum size of 32x32.

Reimplemented from WUIQtWidgetBase.

Definition at line 129 of file WUIQtPropertyGroupWidget.h.

References WUIQtWidgetBase::addAction().

+ Here is the call graph for this function:

◆ cleanUpGT()

void WUIQtPropertyGroupWidget::cleanUpGT ( )
protectedvirtual

Cleanup the GUI.

Do not delete m_widget, or your content widget. This is done by WUIQtWidgetBase. This method allows you to free resources that are not automatically freed by the Qt delete mechanism.

Implements WUIQtWidgetBase.

Definition at line 79 of file WUIQtPropertyGroupWidget.cpp.

◆ close()

void WUIQtPropertyGroupWidget::close ( )
virtual

Handle shutdown.

This includes notification of the creating module and closing the widget. Can be called from any thread. Implement in your implementation.

Implements WUIQtWidgetBase.

Definition at line 84 of file WUIQtPropertyGroupWidget.cpp.

References WUIWidgetBase::close().

+ Here is the call graph for this function:

◆ closeImpl()

void WUIQtPropertyGroupWidget::closeImpl ( )
protectedvirtual

Close the widget.

When done, the widget can be safely deleted.

Reimplemented from WUIQtWidgetBase.

Definition at line 90 of file WUIQtPropertyGroupWidget.cpp.

References WUIQtWidgetBase::closeImpl().

+ Here is the call graph for this function:

◆ getPropertyGroup()

WPropGroup WUIQtPropertyGroupWidget::getPropertyGroup ( ) const
virtual

The property group shown by this widget.

Returns
the group

Implements WUIPropertyGroupWidget.

Definition at line 54 of file WUIQtPropertyGroupWidget.cpp.

References m_properties.

◆ getTitleQString()

QString WUIQtPropertyGroupWidget::getTitleQString ( ) const
virtual

Title as QString.

Returns
the title

Implements WUIQtWidgetBase.

Definition at line 59 of file WUIQtPropertyGroupWidget.cpp.

References WUIWidgetBase::getTitle().

Referenced by realizeImpl().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isVisible()

bool WUIQtPropertyGroupWidget::isVisible ( ) const
virtual

Check if the widget is hidden or not.

Returns
true if visible.

Reimplemented from WUIQtWidgetBase.

Definition at line 74 of file WUIQtPropertyGroupWidget.cpp.

References WUIQtWidgetBase::isVisible().

+ Here is the call graph for this function:

◆ realizeImpl()

void WUIQtPropertyGroupWidget::realizeImpl ( )
protectedvirtual

Realize the widget.

This method blocks until the GUI thread created the widget. Called from within the GUI thread! So you can safely do Qt stuff.

Implements WUIQtWidgetBase.

Definition at line 96 of file WUIQtPropertyGroupWidget.cpp.

References WQtPropertyGroupWidget::createPropertyGroupBox(), WUIQtWidgetBase::embedContent(), WUIQtWidgetBase::getCompellingQParent(), getTitleQString(), m_properties, and m_propWidget.

+ Here is the call graph for this function:

◆ setVisible()

void WUIQtPropertyGroupWidget::setVisible ( bool  visible = true)
virtual

Hide/show this widget.

Unlike close(), you can show the widget again using show().

Parameters
visiblefalse to hide widget

Reimplemented from WUIQtWidgetBase.

Definition at line 69 of file WUIQtPropertyGroupWidget.cpp.

References WUIQtWidgetBase::setVisible().

+ Here is the call graph for this function:

◆ show()

void WUIQtPropertyGroupWidget::show ( )
virtual

Show this widget if not yet visible.

Reimplemented from WUIQtWidgetBase.

Definition at line 64 of file WUIQtPropertyGroupWidget.cpp.

References WUIQtWidgetBase::show().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_properties

WPropGroup WUIQtPropertyGroupWidget::m_properties
private

The properties to show.

Definition at line 170 of file WUIQtPropertyGroupWidget.h.

Referenced by getPropertyGroup(), and realizeImpl().

◆ m_propWidget

QWidget* WUIQtPropertyGroupWidget::m_propWidget
private

The prop widget.

Definition at line 165 of file WUIQtPropertyGroupWidget.h.

Referenced by realizeImpl().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1