DocumentationPanel Class Reference

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

#include <DocumentationPanel.h>

Inheritance diagram for DocumentationPanel:

Collaboration diagram for DocumentationPanel:

List of all members.

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.

Protected Member Functions

void focusInEvent (QFocusEvent *event)

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

Detailed Description

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

Constructor & Destructor Documentation

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.

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 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 Panel.

void 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 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:


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.
Protected Member Functions
void	focusInEvent (QFocusEvent *event)
	Event handler that is called when the widget receives keyboard focus.