Frapper::Panel Class Reference

Base class for all panels to be contained in panel frames. More...

#include <Panel.h>

Inheritance diagram for Frapper::Panel:

Collaboration diagram for Frapper::Panel:

Public Types
enum	Type {   T_Uninitialized = -1, T_Viewport, T_NetworkEditor, T_HierarchyEditor,   T_ParameterEditor, T_CurveEditor, T_Timeline, T_History,   T_Log, T_Documentation, T_NumTypes }
	Nested enumeration of panel types. More...

Public Member Functions
	Panel (QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the Panel class.
virtual	~Panel ()
	Destructor of the Panel class.
virtual void	fillToolBars (QToolBar *mainToolBar, QToolBar *panelToolBar)
	Fills the given tool bars in a panel frame with actions for the panel.
QMap< QString, QString >	getPanelParameters ()
	Gets the panel parameters. For load and save functionality.
virtual void	setPanelParameters (const QMap< QString, QString > &parameterMap)
	Sets the panel parameters. For load and save functionality.
virtual void	registerControl (NodeModel *nodeModel, SceneModel *sceneModel)
	Connects the panel with the scene.

Static Public Member Functions
static QString	getTypeName (Type panelType)
	Returns the name of the given panel type.
static QString	getTypeIconName (Type panelType)
	Returns the icon name for the given panel type.

Protected Attributes
QMap< QString, QString >	m_parameterMap
	Map with default values. For load and save functionality.

Detailed Description

Base class for all panels to be contained in panel frames.

Inheritance Diagram

[legend]

Member Enumeration Documentation

enum Frapper::Panel::Type

Nested enumeration of panel types.

Enumerator:

T_Uninitialized	A value indicating that no panel type has been set yet.
T_Viewport	Value for panel frames containing a ViewportPanel.
T_NetworkEditor	Value for panel frames containing a NetworkPanel.
T_HierarchyEditor	Value for panel frames containing a HierarchyPanel.
T_ParameterEditor	Value for panel frames containing a ParameterPanel.
T_CurveEditor	Value for panel frames containing a CurveEditorPanel.
T_Timeline	Value for panel frames containing a TimelinePanel.
T_History	Value for panel frames containing a HistoryPanel.
T_Log	Value for panel frames containing a LogPanel.
T_Documentation	Value for panel frames containing a DocumentationPanel.
T_NumTypes	The number of panel types available.

Constructor & Destructor Documentation

Frapper::Panel::Panel	(	QWidget *	parent = 0,
		Qt::WindowFlags	flags = 0
	)

Constructor of the Panel class.

Constructors and Destructors.

Parameters

parent	The parent widget the created instance will be a child of.
flags	Extra widget options.

Constructor of the Panel class.

Parameters

parent	The parent widget the created instance will be a child of.
flags	Extra widget options.

Frapper::Panel::~Panel ( )

virtual

Destructor of the Panel class.

Defined virtual to guarantee that the destructor of a derived class will be called if the instance of the derived class is saved in a variable of its parent class type.

Member Function Documentation

QString Frapper::Panel::getTypeName ( Panel::Type  panelType )

static

Returns the name of the given panel type.

Public Static Functions.

Parameters

panelType

The panel type for which to return the name.

Returns

The name of the given panel type.

Returns the name of the given panel type.

Parameters

panelType

The panel type for which to return the name.

Returns

The name of the given panel type.

QString Frapper::Panel::getTypeIconName ( Type  panelType )

static

Returns the icon name for the given panel type.

Parameters

panelType

The panel type for which to return the icon name.

Returns

The name of the icon for the given panel type, or an empty string if no icon for the panel type is available.

void Frapper::Panel::fillToolBars ( QToolBar *  mainToolBar, QToolBar *  panelToolBar  )

virtual

Fills the given tool bars in a panel frame with actions for the panel.

Public Functions.

Parameters

mainToolBar	The main tool bar to fill with actions.
panelToolBar	The panel tool bar to fill with actions.

Fills the given tool bars in a panel frame with actions for the panel.

Parameters

mainToolBar	The main tool bar to fill with actions.
panelToolBar	The panel tool bar to fill with actions.

Reimplemented in Frapper::TestPanel, Frapper::ParameterPanel, PainterPanel::PainterPanel, Frapper::CurveEditorPanel, Frapper::ViewportPanel, Frapper::PainterPanel, Frapper::LogPanel, Frapper::NetworkPanel, Frapper::TimelinePanel, Frapper::DocumentationPanel, Frapper::HierarchyPanel, and Frapper::HistoryPanel.

QMap< QString, QString > Frapper::Panel::getPanelParameters

(

)

Gets the panel parameters. For load and save functionality.

void Frapper::Panel::setPanelParameters ( const QMap< QString, QString > &  parameterMap )

virtual

Sets the panel parameters. For load and save functionality.

Reimplemented in Frapper::ViewportPanel.

void Frapper::Panel::registerControl ( NodeModel *  nodeModel, SceneModel *  sceneModel  )

virtual

Connects the panel with the scene.

Reimplemented in Frapper::PoemReaderPanel, PainterPanel::PainterPanel, and Frapper::TestPanel.

Member Data Documentation

QMap<QString, QString> Frapper::Panel::m_parameterMap

protected

Map with default values. For load and save functionality.

---

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

• Panel.h
• Panel.cpp