Class representing a panel for displaying log messages. More...

#include <LogPanel.h>

Inheritance diagram for Frapper::LogPanel:

Collaboration diagram for Frapper::LogPanel:

Public Member Functions
	LogPanel (QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the LogPanel class.

virtual	~LogPanel ()
	Destructor of the LogPanel class.

virtual void	fillToolBars (QToolBar mainToolBar, QToolBar panelToolBar)
	Fills the given tool bars with actions for the log panel.

virtual void	copy ()
	Copies the currently selected (or all) log messages to the clipboard.

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
virtual void	timerEvent (QTimerEvent *event)
	Event handler that reacts to timer events.

Private Slots
void	m_searchEdit_textChanged (const QString &text)
	Starts the timer that launches the log filtering search after a specific delay.

void	on_ui_filterAction_toggled (bool enabled)
	Toggles filtering of log messages in the log panel.

void	on_ui_infoAction_toggled (bool checked)
	Toggles the display of informational messages in the log panel.

void	on_ui_resetSearchAction_triggered (bool checked=false)
	Cancels a running log search and resets the log search settings for the currently edited node.

void	on_ui_warningAction_toggled (bool checked)
	Toggles the display of warning messages in the log panel.

void	on_ui_errorAction_toggled (bool checked)
	Toggles the display of error messages in the log panel.

void	on_ui_debugAction_toggled (bool checked)
	Toggles the display of debug messages in the log panel.

void	on_ui_qtAction_toggled (bool checked)
	Toggles the display of Qt messages in the log panel.

void	on_ui_ogreAction_toggled (bool checked)
	Toggles the display of OGRE messages in the log panel.

void	on_ui_resetFilterAction_triggered ()
	Resets the log panel's filter settings.

void	on_ui_copyAction_triggered ()
	Copies the text of the currently selected log messages to the clipboard.

void	on_ui_clearAction_triggered ()
	Clears the log message history.

Private Member Functions
void	updateActions (bool activated)
	Keeps track of the number of active message filters and enables the Filter and Reset Filter actions accordingly.

Private Attributes
int	m_numActiveFilters
	The number of currently active message filters.

QLineEdit *	m_searchEdit
	The line edit for editing the string for a log search.

int	m_searchTimer
	The ID of the timer that is (re-)started each time the search text in the search edit widget is changed.

Additional Inherited Members
Public Types inherited from Frapper::Panel
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...

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 log messages.

Constructor & Destructor Documentation

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

Constructor of the LogPanel class.

Constructors and Destructors.

Parameters

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

Constructor of the LogPanel class.

Parameters

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

Frapper::LogPanel::~LogPanel ( )

virtual

Destructor of the LogPanel 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::LogPanel::fillToolBars	(	QToolBar *	mainToolBar,
		QToolBar *	panelToolBar
	)

virtual

Fills the given tool bars with actions for the log 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 log 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::LogPanel::copy ( )

virtual

Copies the currently selected (or all) log messages to the clipboard.

Implements Frapper::CopyHandler.

void Frapper::LogPanel::timerEvent ( QTimerEvent * event )

protectedvirtual

Event handler that reacts to timer events.

Protected Events.

Parameters

event The description of the timer event.

Event handler that reacts to timer events.

Parameters

event The description of the timer event.

void Frapper::LogPanel::m_searchEdit_textChanged ( const QString & text )

privateslot

Starts the timer that launches the log filtering search after a specific delay.

Private Slots.

Is called when the text in the search edit widget has changed.

Parameters

text	The text that has been entered in the search edit widget.

Starts the timer that launches the log filtering search after a specific delay.

Is called when the text in the search edit widget has changed.

Parameters

text	The text that has been entered in the search edit widget.

void Frapper::LogPanel::on_ui_filterAction_toggled ( bool enabled )

privateslot

Toggles filtering of log messages in the log panel.

Parameters

enabled Flag that controls whether to enable or disable filtering.

void Frapper::LogPanel::on_ui_infoAction_toggled ( bool checked )

privateslot

Toggles the display of informational messages in the log panel.

Parameters

checked Flag that controls whether to show or hide the messages.

void Frapper::LogPanel::on_ui_resetSearchAction_triggered ( bool checked = false )

privateslot

Cancels a running log search and resets the log search settings for the currently edited node.

Cancels a running log search and resets the parameter search settings for the currently edited node.

Is called when the reset search action has been triggered.

Parameters

checked The state of the action (unused).

void Frapper::LogPanel::on_ui_warningAction_toggled ( bool checked )

privateslot

Toggles the display of warning messages in the log panel.

Parameters

checked Flag that controls whether to show or hide the messages.

void Frapper::LogPanel::on_ui_errorAction_toggled ( bool checked )

privateslot

Toggles the display of error messages in the log panel.

Parameters

checked Flag that controls whether to show or hide the messages.

void Frapper::LogPanel::on_ui_debugAction_toggled ( bool checked )

privateslot

Toggles the display of debug messages in the log panel.

Parameters

checked Flag that controls whether to show or hide the messages.

void Frapper::LogPanel::on_ui_qtAction_toggled ( bool checked )

privateslot

Toggles the display of Qt messages in the log panel.

Parameters

checked Flag that controls whether to show or hide the messages.

void Frapper::LogPanel::on_ui_ogreAction_toggled ( bool checked )

privateslot

Toggles the display of OGRE messages in the log panel.

Parameters

checked Flag that controls whether to show or hide the messages.

void Frapper::LogPanel::on_ui_resetFilterAction_triggered ( )

privateslot

Resets the log panel's filter settings.

void Frapper::LogPanel::on_ui_copyAction_triggered ( )

privateslot

Copies the text of the currently selected log messages to the clipboard.

void Frapper::LogPanel::on_ui_clearAction_triggered ( )

privateslot

Clears the log message history.

void Frapper::LogPanel::updateActions ( bool activated )

private

Keeps track of the number of active message filters and enables the Filter and Reset Filter actions accordingly.

Private Functions.

Parameters

activated Flag that states whether a message filter has been activated or deactivated.

Keeps track of the number of active message filters and enables the Filter and Reset Filter actions accordingly.

Parameters

activated Flag that states whether a message filter has been activated or deactivated.

Member Data Documentation

int Frapper::LogPanel::m_numActiveFilters

private

The number of currently active message filters.

QLineEdit* Frapper::LogPanel::m_searchEdit

private

The line edit for editing the string for a log search.

int Frapper::LogPanel::m_searchTimer

private

The ID of the timer that is (re-)started each time the search text in the search edit widget is changed.

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

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation