OpenWalnut  1.3.1
Public Types | Public Member Functions | Private Attributes | List of all members
WCustomWidget Class Referenceabstract

Custom widget which is created by a module to display custom information. More...

#include <WCustomWidget.h>

Public Types

typedef boost::shared_ptr
< WCustomWidget
SPtr
 Abbreviation for a shared pointer on a instance of this class. More...
 
typedef boost::shared_ptr
< const WCustomWidget
ConstSPtr
 Abbreviation for a const shared pointer on a instance of this class. More...
 

Public Member Functions

 WCustomWidget (std::string title)
 Constructor. More...
 
virtual ~WCustomWidget ()
 Destructor. More...
 
virtual osg::ref_ptr
< WGEGroupNode
getScene () const =0
 Get the scene which is displayed. More...
 
virtual boost::shared_ptr
< WGEViewer
getViewer () const =0
 Get the viewer which is used. More...
 
virtual std::string getTitle () const
 Get the title of the widget. More...
 

Private Attributes

std::string m_title
 The widget's title string. More...
 

Detailed Description

Custom widget which is created by a module to display custom information.

Definition at line 41 of file WCustomWidget.h.

Member Typedef Documentation

typedef boost::shared_ptr< const WCustomWidget > WCustomWidget::ConstSPtr

Abbreviation for a const shared pointer on a instance of this class.

Definition at line 52 of file WCustomWidget.h.

typedef boost::shared_ptr< WCustomWidget > WCustomWidget::SPtr

Abbreviation for a shared pointer on a instance of this class.

Definition at line 47 of file WCustomWidget.h.

Constructor & Destructor Documentation

WCustomWidget::WCustomWidget ( std::string  title)
explicit

Constructor.

Create a custom widget instance.

Parameters
titlethe title of the widget

Definition at line 29 of file WCustomWidget.cpp.

WCustomWidget::~WCustomWidget ( )
virtual

Destructor.

Definition at line 34 of file WCustomWidget.cpp.

Member Function Documentation

virtual osg::ref_ptr< WGEGroupNode > WCustomWidget::getScene ( ) const
pure virtual

Get the scene which is displayed.

Returns
the scene as osg::ref_ptr
std::string WCustomWidget::getTitle ( ) const
virtual

Get the title of the widget.

Returns
title as string

Definition at line 38 of file WCustomWidget.cpp.

References m_title.

virtual boost::shared_ptr< WGEViewer > WCustomWidget::getViewer ( ) const
pure virtual

Get the viewer which is used.

Returns
the viewer as boost::shard_ptr

Member Data Documentation

std::string WCustomWidget::m_title
private

The widget's title string.

Definition at line 92 of file WCustomWidget.h.

Referenced by getTitle().


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