Frapper::DocumentationPanel Class Reference

Class representing a panel for displaying the application's documentation. More...

#include <DocumentationPanel.h>

Inheritance diagram for Frapper::DocumentationPanel:

Collaboration diagram for Frapper::DocumentationPanel:

Public Slots
void	setDocument (const QString &filename)
	Sets the document to be displayed in the panel.

Public Member Functions
	DocumentationPanel (QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the DocumentationPanel class.
virtual	~DocumentationPanel ()
	Destructor of the DocumentationPanel class.
virtual void	fillToolBars (QToolBar *mainToolBar, QToolBar *panelToolBar)
	Fills the given tool bars with actions for the documentation panel.
Public Member Functions inherited from Frapper::ViewPanel
	ViewPanel (Type viewPanelType, QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the ViewPanel class.
Type	getViewPanelType ()
	Returns the type of the view panel.
Public Member Functions inherited from Frapper::Panel
	Panel (QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the Panel class.
virtual	~Panel ()
	Destructor of the Panel class.
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.

Protected Member Functions
void	focusInEvent (QFocusEvent *event)
	Event handler that is called when the widget receives keyboard focus.

Additional Inherited Members
Public Types inherited from Frapper::ViewPanel
enum	Type {   T_Documentation, T_Viewport, T_NetworkEditor, T_HierarchyEditor,   T_ParameterEditor, T_CurveEditor, T_Timeline, T_PluginPanel,   T_PainterPanel, T_NumTypes }
	Nested enumeration for the different types of view panels. More...
Static Public Member Functions inherited from Frapper::Panel
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 inherited from Frapper::Panel
QMap< QString, QString >	m_parameterMap
	Map with default values. For load and save functionality.

Detailed Description

Class representing a panel for displaying the application's documentation.

Constructor & Destructor Documentation

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

Constructor of the DocumentationPanel class.

Constructors and Destructors.

Parameters

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

Constructor of the DocumentationPanel class.

Parameters

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

Frapper::DocumentationPanel::~DocumentationPanel ( )

virtual

Destructor of the DocumentationPanel 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

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

virtual

Fills the given tool bars with actions for the documentation 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 with actions for the documentation panel.

Parameters

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

Reimplemented from Frapper::Panel.

void Frapper::DocumentationPanel::setDocument ( const QString &  filename )

slot

Sets the document to be displayed in the panel.

Private Slots.

Parameters

filename

Path of the document.

Sets the document to be displayed in the panel.

Parameters

filename

Path of the document.

void Frapper::DocumentationPanel::focusInEvent ( QFocusEvent *  event )

protected

Event handler that is called when the widget receives keyboard focus.

Protected Event Handlers.

Parameters

event

The object containing details about the event.

Event handler that is called when the widget receives keyboard focus.

Parameters

event

The object containing details about the event.

---

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

• DocumentationPanel.h
• DocumentationPanel.cpp