OpenWalnut  1.5.0dev
Public Types | Public Member Functions | Protected Member Functions | List of all members
WUIPropertyGroupWidget Class Referenceabstract

Widget which is a container for a WPropertyGroup. More...

#include <WUIPropertyGroupWidget.h>

+ Inheritance diagram for WUIPropertyGroupWidget:
+ Collaboration diagram for WUIPropertyGroupWidget:

Public Types

typedef std::shared_ptr< WUIPropertyGroupWidgetSPtr
 Convenience typedef for a std::shared_ptr< WUIPropertyGroupWidget >. More...
 
typedef std::shared_ptr< const WUIPropertyGroupWidgetConstSPtr
 Convenience typedef for a std::shared_ptr< const WUIPropertyGroupWidget >. More...
 
- Public Types inherited from WUIWidgetBase
typedef std::shared_ptr< WUIWidgetBaseSPtr
 Convenience typedef for a std::shared_ptr< WUIWidgetBase >. More...
 
typedef std::shared_ptr< const WUIWidgetBaseConstSPtr
 Convenience typedef for a std::shared_ptr< const WUIWidgetBase >. More...
 

Public Member Functions

virtual ~WUIPropertyGroupWidget ()
 Destructor. More...
 
virtual WPropGroup getPropertyGroup () const =0
 The property group shown by this widget. More...
 
- Public Member Functions inherited from WUIWidgetBase
virtual ~WUIWidgetBase ()
 Destructor. More...
 
virtual std::string getTitle () const
 Get the title of the widget. More...
 
virtual void show ()=0
 Show this widget if not yet visible. More...
 
virtual void setVisible (bool visible=true)=0
 Hide/show this widget. More...
 
virtual bool isVisible () const =0
 Check if the widget is hidden or not. 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...
 
virtual void addAction (WPropGroup group, WGEImage::SPtr icon=WGEImage::SPtr())=0
 Define a property as action. More...
 
virtual void addAction (WPropTrigger trigger, WGEImage::SPtr icon=WGEImage::SPtr())=0
 Define a property as action. More...
 
virtual void addAction (WPropBool toggle, WGEImage::SPtr icon=WGEImage::SPtr())=0
 Define a property as action. More...
 

Protected Member Functions

 WUIPropertyGroupWidget (std::string title)
 Default constructor. More...
 
- Protected Member Functions inherited from WUIWidgetBase
 WUIWidgetBase (std::string title)
 Default constructor. More...
 
virtual void closeImpl ()=0
 Close the widget. 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...
 
ChildContainergetChildren ()
 Return the list of children. More...
 
const ChildContainergetChildren () const
 Return the list of children. More...
 
void closeChildren ()
 Comfortable function to recurse a close call. More...
 

Additional Inherited Members

- Protected Types inherited from WUIWidgetBase
typedef WSharedSequenceContainer< std::vector< WUIWidgetBase::SPtr > > ChildContainer
 Keep track of our child widgets. More...
 

Detailed Description

Widget which is a container for a WPropertyGroup.

Definition at line 38 of file WUIPropertyGroupWidget.h.

Member Typedef Documentation

◆ ConstSPtr

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

Definition at line 49 of file WUIPropertyGroupWidget.h.

◆ SPtr

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

Definition at line 44 of file WUIPropertyGroupWidget.h.

Constructor & Destructor Documentation

◆ ~WUIPropertyGroupWidget()

WUIPropertyGroupWidget::~WUIPropertyGroupWidget ( )
virtual

Destructor.

Definition at line 37 of file WUIPropertyGroupWidget.cpp.

◆ WUIPropertyGroupWidget()

WUIPropertyGroupWidget::WUIPropertyGroupWidget ( std::string  title)
explicitprotected

Default constructor.

Create an property widget.

Parameters
titlethe widget title

Definition at line 31 of file WUIPropertyGroupWidget.cpp.

Member Function Documentation

◆ getPropertyGroup()

virtual WPropGroup WUIPropertyGroupWidget::getPropertyGroup ( ) const
pure virtual

The property group shown by this widget.

Returns
the group

Implemented in WUIQtPropertyGroupWidget.


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