LogWindow Class Reference

Widget, displaying log messages. More...

#include <LogWindow.h>

Inheritance diagram for LogWindow:

Public Types
enum	{   CopyId = 0x01, ClearId = 0x02, SelectAllId = 0x04, SaveToFileId = 0x08,   All = CopyId | ClearId | SelectAllId | SaveToFileId }
	Context popup menu actions flags. More...
enum	{   DisplayNormal = 0x00, DisplayDate = 0x01, DisplayTime = 0x02, DisplaySeparator = 0x04,   DisplayNoColor = 0x08, DisplayDateTime = DisplayDate | DisplayTime }
	Display messages flags. More...

Public Member Functions
	LogWindow (QWidget *theParent)
	Constructor. More...
virtual	~LogWindow ()
	Destructor. More...
virtual QString	popupClientType () const
	Get popup client symbolic name, used in popup menu management system. More...
virtual void	contextMenuPopup (QMenu *)
	Create the context popup menu. More...
virtual bool	eventFilter (QObject *, QEvent *)
	Custom event handler. More...
QString	banner () const
	Get current banner (message log window header text). More...
QString	separator () const
	Get current separator (text which is printed between messages). More...
void	setBanner (const QString &)
	Set current banner (message log window header text). More...
void	setSeparator (const QString &)
void	putMessage (const QString &, const int=DisplayNormal)
	Put new message to the log window. More...
virtual void	putMessage (const QString &, const QColor &, const int=DisplayNormal)
	Put new message to the log window. More...
void	clear (const bool=false)
	Clear message log. More...
bool	saveLog (const QString &)
	Save messages log to the file. More...
void	setMenuActions (const int)
	Set actions to be visible in the context popup menu. More...
int	menuActions () const
	Get menu actions which are currently visible in the context popup menu. More...
Public Member Functions inherited from SUIT_PopupClient
	SUIT_PopupClient ()
virtual	~SUIT_PopupClient ()
bool	connectPopupRequest (QObject *reciever, const char *slot)
bool	disconnectPopupRequest (QObject *reciever, const char *slot)

Protected Slots
void	onSaveToFile ()
	Called when user selects "Save To File" command in the popup menu. More...
void	onSelectAll ()
	Called when user selects "Select all" command in the popup menu. More...
void	onClear ()
	Called when user click "Clear" command in the popup menu. More...
void	onCopy ()
	Called when user click "Copy" command in the popup menu. More...

Private Member Functions
void	createActions ()
	Create context popup menu actions. More...
void	updateActions ()
	Update menu actions. More...

Private Attributes
QTextEdit *	myView
	internal view window More...
QString	myBanner
	current banner More...
QStringList	myHistory
	messages history More...
QString	mySeparator
	current separator More...
int	myBannerSize
	current banner's size More...
QMap< int, QAction * >	myActions
	popup menu actions More...

Additional Inherited Members
Protected Member Functions inherited from SUIT_PopupClient
void	contextMenuRequest (QContextMenuEvent *e)

Detailed Description

The log messages window provides operations like:

• show messages
• display timestamps at the message beginning
• color messages according to their purposes (e.g., errors/warning)
• clear log output
• copy messages to clipvoard
• save message log to to the text file

Member Enumeration Documentation

anonymous enum

Enumerator
CopyId	"Copy" menu action
ClearId	"Clear" menu action
SelectAllId	"Select All" menu action
SaveToFileId	"Save To File" menu action
All	all menu actions

anonymous enum

Enumerator
DisplayNormal	do not display extra data
DisplayDate	display message date
DisplayTime	display message time
DisplaySeparator	display separator between messages
DisplayNoColor	display non-colored message
DisplayDateTime	display date & time

Constructor & Destructor Documentation

LogWindow::LogWindow

(

QWidget *

parent

)

Creates new messages log window widget.

Parameters

parent

parent widget

References clear(), createActions(), DEFAULT_SEPARATOR, main(), myBanner, myBannerSize, mySeparator, myView, SUIT_Session::resourceMgr(), SUIT_Session::session(), Qtx::stringToFont(), and QtxResourceMgr::stringValue().

LogWindow::~LogWindow ( )

virtual

Does nothing for the moment.

Member Function Documentation

QString LogWindow::banner

(

)

const

Returns

string representing the current banner

References myBanner.

void LogWindow::clear

(

const bool

clearHistory = false

)

Parameters

clearHistory

if True, clear also the messages history

References myBanner, myBannerSize, myHistory, and myView.

void LogWindow::contextMenuPopup ( QMenu *  popup )

virtual

Fill in the popup menu with the commands.

Parameters

menu	context popup menu

Reimplemented from SUIT_PopupClient.

References ClearId, CopyId, myActions, SaveToFileId, SelectAllId, Qtx::simplifySeparators(), and updateActions().

void LogWindow::createActions ( )

private

References ClearId, CopyId, myActions, onClear(), onCopy(), onSaveToFile(), onSelectAll(), SaveToFileId, and SelectAllId.

bool LogWindow::eventFilter ( QObject *  o, QEvent *  e  )

virtual

Process context popup menu request event.

Parameters

o	object
e	event

Returns

True if the event is processed and further processing should be stopped

References SUIT_PopupClient::contextMenuRequest(), and myView.

int LogWindow::menuActions

(

)

const

Returns

ORed together actions flags

See Also

setMenuActions()

References ClearId, CopyId, myActions, SaveToFileId, and SelectAllId.

void LogWindow::onClear ( )

protectedslot

References clear().

void LogWindow::onCopy ( )

protectedslot

References myView.

void LogWindow::onSaveToFile ( )

protectedslot

References SUIT_Session::activeApplication(), app, SUIT_MessageBox::critical(), SUIT_Application::getFileName(), saveLog(), and SUIT_Session::session().

void LogWindow::onSelectAll ( )

protectedslot

References myView.

QString LogWindow::popupClientType ( ) const

inlinevirtual

Returns

symbolic name

Implements SUIT_PopupClient.

void LogWindow::putMessage	(	const QString &	message,
		const int	flags = DisplayNormal
	)

Parameters

message	text of the message
flags	ORed flags which define how the message should be printed

void LogWindow::putMessage ( const QString &  message, const QColor &  color, const int  flags = DisplayNormal  )

virtual

Parameters

message	text of the message
color	text color of the message
flags	ORed flags which define how the message should be printed

References DisplayDate, DisplayNoColor, DisplaySeparator, DisplayTime, myHistory, mySeparator, myView, and plainText().

bool LogWindow::saveLog

(

const QString &

fileName

)

Parameters

fileName

name of the file

Returns

true on success and false on error

References myHistory.

QString LogWindow::separator

(

)

const

Returns

string representing the current separator

References mySeparator.

void LogWindow::setBanner

(

const QString &

banner

)

Parameters

banner

new banner

References banner(), clear(), and myBanner.

void LogWindow::setMenuActions

(

const int

flags

)

Actions, which IDs are set in flags parameter, will be shown in the context popup menu. Other actions will not be shown.

Parameters

flags

ORed together actions flags

References ClearId, CopyId, myActions, SaveToFileId, and SelectAllId.

void LogWindow::setSeparator

(

const QString &

separator

)

Set current separator (text which is printed between messages).

Parameters

separator

new separator

References clear(), mySeparator, and separator().

void LogWindow::updateActions ( )

private

Update context popup menu action state.

References ClearId, CopyId, myActions, myBannerSize, myHistory, myView, SaveToFileId, and SelectAllId.

Member Data Documentation

QMap<int, QAction*> LogWindow::myActions

private

QString LogWindow::myBanner

private

int LogWindow::myBannerSize

private

QStringList LogWindow::myHistory

private

QString LogWindow::mySeparator

private

QTextEdit* LogWindow::myView

private

---

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

• src/LogWindow/LogWindow.h
• src/LogWindow/LogWindow.cxx