A logging window for the gui. More...

#include <GUIMessageWindow.h>

Inheritance diagram for GUIMessageWindow:

Collaboration diagram for GUIMessageWindow:

Data Structures
class	MsgOutputDevice
	FOX needs this. More...

Public Member Functions
void	addSeparator ()
	Adds a a separator to this log window.

void	appendMsg (GUIEventType eType, const std::string &msg)
	Adds new text to the window.

void	clear ()
	Clears the window.

	GUIMessageWindow (FXComposite parent, GUIMainWindow mainWindow)
	Constructor.

long	onKeyPress (FXObject o, FXSelector sel, void data)
	handle keys

void	registerMsgHandlers ()
	register message handlers

virtual void	setCursorPos (FXint pos, FXbool notify=FALSE)
	set cursor position over a certain line

void	unregisterMsgHandlers ()
	unregister message handlers

	~GUIMessageWindow ()
	Destructor.

Static Public Member Functions
static void	enableLocateLinks (const bool val)
	switch locate links on and off

static SUMOTime	getBreakPointOffset ()
	ask whether locate links is enabled

static FXHiliteStyle *	getStyles ()
	The text colors used.

static bool	locateLinksEnabled ()
	ask whether locate links is enabled

static void	setBreakPointOffset (SUMOTime val)
	switch locate links on and off

Private Member Functions
void	fillStyles ()
	fill styles

const GUIGlObject *	getActiveStringObject (const FXString &text, const FXint pos, const FXint lineS, const FXint lineE) const
	get active string object

SUMOTime	getTimeString (const FXString &text, const FXint pos) const
	get time string object

Private Attributes
OutputDevice *	myDebugRetriever

OutputDevice *	myErrorRetriever
	The instances of message retriever encapsulations.

OutputDevice *	myGLDebugRetriever

GUIMainWindow *	myMainWindow
	main window

OutputDevice *	myMessageRetriever

OutputDevice *	myWarningRetriever

Static Private Attributes
static SUMOTime	myBreakPointOffset = TIME2STEPS(-5)
	Offset when creating breakpoint by clicking on time links.

static bool	myLocateLinks = true
	whether messages are linked to the GUI elements

static FXHiliteStyle *	myStyles = new FXHiliteStyle[8]
	The text colors used.

static std::string	myTimeText
	The time text to look for.

static std::map< std::string, std::string >	myTypeStrings
	The translated type strings text to look for.

Detailed Description

A logging window for the gui.

This class displays messages incoming to the gui from either the load or the run thread.

The text is colored in dependence to its type (messages: green, warnings: yellow, errors: red)

Each time a new message is passed, the window is reopened.

Definition at line 52 of file GUIMessageWindow.h.

Constructor & Destructor Documentation

◆ GUIMessageWindow()

GUIMessageWindow::GUIMessageWindow	(	FXComposite *	parent,
		GUIMainWindow *	mainWindow
	)

Constructor.

Parameters

[in] parent The parent window

Definition at line 57 of file GUIMessageWindow.cpp.

References TL, and StringUtils::to_lower_case().

◆ ~GUIMessageWindow()

GUIMessageWindow::~GUIMessageWindow ( )

Destructor.

Definition at line 86 of file GUIMessageWindow.cpp.

References myErrorRetriever, myMessageRetriever, myStyles, and myWarningRetriever.

Member Function Documentation

◆ addSeparator()

void GUIMessageWindow::addSeparator ( )

Adds a a separator to this log window.

Definition at line 272 of file GUIMessageWindow.cpp.

Referenced by GUIApplicationWindow::closeAllWindows(), GNEApplicationWindow::onCmdClose(), GNEApplicationWindow::onCmdSaveEdgeTypes(), GNEApplicationWindow::onCmdSaveNetwork(), and GNEApplicationWindow::onCmdSaveTLSPrograms().

Here is the caller graph for this function:

◆ appendMsg()

void GUIMessageWindow::appendMsg	(	GUIEventType	eType,
		const std::string &	msg
	)

Adds new text to the window.

The type of the text is determined by the first parameter

Parameters

[in]	eType	The type of the event the message was generated by
[in]	msg	The message

See also: GUIEventType

Definition at line 193 of file GUIMessageWindow.cpp.

References DEBUG_OCCURRED, ERROR_OCCURRED, getActiveStringObject(), GUIGlObject::getGlID(), getTimeString(), GUIGlObjectStorage::gIDStorage, GLDEBUG_OCCURRED, MESSAGE_OCCURRED, myLocateLinks, myTimeText, GUIGlObjectStorage::unblockObject(), and WARNING_OCCURRED.

Referenced by GUIApplicationWindow::handleEvent_Message(), GNEApplicationWindow::handleEvent_Message(), GUIApplicationWindow::handleEvent_SimulationEnded(), and GUIMessageWindow::MsgOutputDevice::postWriteHook().

Here is the caller graph for this function:

◆ clear()

void GUIMessageWindow::clear ( )

Clears the window.

Definition at line 285 of file GUIMessageWindow.cpp.

Referenced by GUIApplicationWindow::onCmdClearMsgWindow(), and GNEApplicationWindow::onCmdClearMsgWindow().

Here is the caller graph for this function:

◆ enableLocateLinks()

static void GUIMessageWindow::enableLocateLinks ( const bool val )

inlinestatic

switch locate links on and off

Definition at line 90 of file GUIMessageWindow.h.

References myLocateLinks.

Referenced by GUIDialog_AppSettings::onCmdOk().

Here is the caller graph for this function:

◆ fillStyles()

void GUIMessageWindow::fillStyles ( )

private

fill styles

Definition at line 343 of file GUIMessageWindow.cpp.

References myStyles.

◆ getActiveStringObject()

const GUIGlObject * GUIMessageWindow::getActiveStringObject	(	const FXString &	text,
		const FXint	pos,
		const FXint	lineS,
		const FXint	lineE
	)		const

private

get active string object

Definition at line 95 of file GUIMessageWindow.cpp.

References GUIGlObjectStorage::getObjectBlocking(), GUIGlObjectStorage::gIDStorage, MAX2(), and myTypeStrings.

Referenced by appendMsg(), and setCursorPos().

Here is the caller graph for this function:

◆ getBreakPointOffset()

static SUMOTime GUIMessageWindow::getBreakPointOffset ( )

inlinestatic

ask whether locate links is enabled

Definition at line 105 of file GUIMessageWindow.h.

References myBreakPointOffset.

Referenced by GUIDialog_AppSettings::GUIDialog_AppSettings(), and GUIApplicationWindow::onCmdBreakpointEarly().

Here is the caller graph for this function:

◆ getStyles()

FXHiliteStyle * GUIMessageWindow::getStyles ( )

static

The text colors used.

Definition at line 337 of file GUIMessageWindow.cpp.

References myStyles.

Referenced by GNERunNetgenerateDialog::GNERunNetgenerateDialog(), and GNERunPythonToolDialog::GNERunPythonToolDialog().

Here is the caller graph for this function:

◆ getTimeString()

SUMOTime GUIMessageWindow::getTimeString	(	const FXString &	text,
		const FXint	pos
	)		const

private

get time string object

Definition at line 120 of file GUIMessageWindow.cpp.

References string2time().

Referenced by appendMsg(), and setCursorPos().

Here is the caller graph for this function:

◆ locateLinksEnabled()

static bool GUIMessageWindow::locateLinksEnabled ( )

inlinestatic

ask whether locate links is enabled

Definition at line 95 of file GUIMessageWindow.h.

References myLocateLinks.

◆ onKeyPress()

long GUIMessageWindow::onKeyPress	(	FXObject *	o,
		FXSelector	sel,
		void *	data
	)

handle keys

Definition at line 326 of file GUIMessageWindow.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ registerMsgHandlers()

void GUIMessageWindow::registerMsgHandlers ( )

register message handlers

Definition at line 298 of file GUIMessageWindow.cpp.

References MsgHandler::addRetriever(), DEBUG_OCCURRED, ERROR_OCCURRED, MsgHandler::getDebugInstance(), MsgHandler::getErrorInstance(), MsgHandler::getGLDebugInstance(), MsgHandler::getMessageInstance(), MsgHandler::getWarningInstance(), GLDEBUG_OCCURRED, MESSAGE_OCCURRED, myDebugRetriever, myErrorRetriever, myGLDebugRetriever, myMessageRetriever, myWarningRetriever, and WARNING_OCCURRED.

Referenced by GNEApplicationWindow::handleEvent_NetworkLoaded().

Here is the caller graph for this function:

◆ setBreakPointOffset()

static void GUIMessageWindow::setBreakPointOffset ( SUMOTime val )

inlinestatic

switch locate links on and off

Definition at line 100 of file GUIMessageWindow.h.

References myBreakPointOffset.

Referenced by GUIDialog_AppSettings::onCmdOk().

Here is the caller graph for this function:

◆ setCursorPos()

void GUIMessageWindow::setCursorPos	(	FXint	pos,
		FXbool	notify = `FALSE`
	)

virtual

set cursor position over a certain line

Definition at line 157 of file GUIMessageWindow.cpp.

References GUIMainWindow::addBreakpoint(), getActiveStringObject(), GUIGlObject::getGlID(), getTimeString(), GUIMainWindow::getViewByID(), GUIMainWindow::getViewIDs(), GUIGlObjectStorage::gIDStorage, gSelected, gSimulation, MAX2(), MIN2(), myBreakPointOffset, myLocateLinks, myMainWindow, myTimeText, GUIGlChildWindow::setView(), GUISelectedStorage::toggleSelection(), and GUIGlObjectStorage::unblockObject().

◆ unregisterMsgHandlers()

void GUIMessageWindow::unregisterMsgHandlers ( )

unregister message handlers

Definition at line 316 of file GUIMessageWindow.cpp.

References MsgHandler::getDebugInstance(), MsgHandler::getErrorInstance(), MsgHandler::getGLDebugInstance(), MsgHandler::getMessageInstance(), MsgHandler::getWarningInstance(), myDebugRetriever, myErrorRetriever, myGLDebugRetriever, myMessageRetriever, myWarningRetriever, and MsgHandler::removeRetriever().

Referenced by GNEApplicationWindow::closeAllWindows().

Here is the caller graph for this function:

Field Documentation

◆ myBreakPointOffset

SUMOTime GUIMessageWindow::myBreakPointOffset = TIME2STEPS(-5)

staticprivate

Offset when creating breakpoint by clicking on time links.

Definition at line 170 of file GUIMessageWindow.h.

Referenced by getBreakPointOffset(), setBreakPointOffset(), and setCursorPos().

◆ myDebugRetriever

OutputDevice * GUIMessageWindow::myDebugRetriever

private

Definition at line 182 of file GUIMessageWindow.h.

Referenced by registerMsgHandlers(), and unregisterMsgHandlers().

◆ myErrorRetriever

OutputDevice* GUIMessageWindow::myErrorRetriever

private

The instances of message retriever encapsulations.

Definition at line 182 of file GUIMessageWindow.h.

Referenced by registerMsgHandlers(), unregisterMsgHandlers(), and ~GUIMessageWindow().

◆ myGLDebugRetriever

OutputDevice * GUIMessageWindow::myGLDebugRetriever

private

Definition at line 182 of file GUIMessageWindow.h.

Referenced by registerMsgHandlers(), and unregisterMsgHandlers().

◆ myLocateLinks

bool GUIMessageWindow::myLocateLinks = true

staticprivate

whether messages are linked to the GUI elements

Definition at line 167 of file GUIMessageWindow.h.

Referenced by appendMsg(), enableLocateLinks(), locateLinksEnabled(), and setCursorPos().

◆ myMainWindow

GUIMainWindow* GUIMessageWindow::myMainWindow

private

main window

Definition at line 164 of file GUIMessageWindow.h.

Referenced by setCursorPos().

◆ myMessageRetriever

OutputDevice * GUIMessageWindow::myMessageRetriever

private

Definition at line 182 of file GUIMessageWindow.h.

Referenced by registerMsgHandlers(), unregisterMsgHandlers(), and ~GUIMessageWindow().

◆ myStyles

FXHiliteStyle * GUIMessageWindow::myStyles = new FXHiliteStyle[8]

staticprivate

The text colors used.

Definition at line 173 of file GUIMessageWindow.h.

Referenced by fillStyles(), getStyles(), and ~GUIMessageWindow().

◆ myTimeText

std::string GUIMessageWindow::myTimeText

staticprivate

The time text to look for.

Definition at line 176 of file GUIMessageWindow.h.

Referenced by appendMsg(), and setCursorPos().

◆ myTypeStrings

std::map< std::string, std::string > GUIMessageWindow::myTypeStrings

staticprivate

The translated type strings text to look for.

Definition at line 179 of file GUIMessageWindow.h.

Referenced by getActiveStringObject().

◆ myWarningRetriever

OutputDevice * GUIMessageWindow::myWarningRetriever

private

Definition at line 182 of file GUIMessageWindow.h.

Referenced by registerMsgHandlers(), unregisterMsgHandlers(), and ~GUIMessageWindow().

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

Data Structures

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GUIMessageWindow()

◆ ~GUIMessageWindow()

Member Function Documentation

◆ addSeparator()

◆ appendMsg()

◆ clear()

◆ enableLocateLinks()

◆ fillStyles()

◆ getActiveStringObject()

◆ getBreakPointOffset()

◆ getStyles()

◆ getTimeString()

◆ locateLinksEnabled()

◆ onKeyPress()

◆ registerMsgHandlers()

◆ setBreakPointOffset()

◆ setCursorPos()

◆ unregisterMsgHandlers()

Field Documentation

◆ myBreakPointOffset

◆ myDebugRetriever

◆ myErrorRetriever

◆ myGLDebugRetriever

◆ myLocateLinks

◆ myMainWindow

◆ myMessageRetriever

◆ myStyles

◆ myTimeText

◆ myTypeStrings

◆ myWarningRetriever