Eclipse SUMO - Simulation of Urban MObility
GUIMessageWindow Class Reference

A logging window for the gui. More...

#include <GUIMessageWindow.h>

Inheritance diagram for GUIMessageWindow:
Collaboration diagram for GUIMessageWindow:

Data Structures

class  MsgOutputDevice
 class MsgOutputDevice More...
 

Public Member Functions

void addSeparator ()
 Adds a a separator to this log window. More...
 
void appendMsg (GUIEventType eType, const std::string &msg)
 Adds new text to the window. More...
 
void clear ()
 Clears the window. More...
 
 GUIMessageWindow (FXComposite *parent)
 Constructor. More...
 
void registerMsgHandlers ()
 register message handlers More...
 
virtual void setCursorPos (FXint pos, FXbool notify=FALSE)
 set cursor position over a certain line More...
 
void unregisterMsgHandlers ()
 unregister message handlers More...
 
 ~GUIMessageWindow ()
 Destructor. More...
 

Static Public Member Functions

static void enableLocateLinks (const bool val)
 switch locate links on and off More...
 
static bool locateLinksEnabled ()
 ask whether locate links is enabled More...
 

Private Member Functions

const GUIGlObjectgetActiveStringObject (const FXString &text, const FXint pos, const FXint lineS, const FXint lineE) const
 get active string object More...
 

Private Attributes

OutputDevicemyDebugRetriever
 
OutputDevicemyErrorRetriever
 The instances of message retriever encapsulations. More...
 
OutputDevicemyGLDebugRetriever
 
OutputDevicemyMessageRetriever
 
FXHiliteStyle * myStyles
 The text colors used. More...
 
OutputDevicemyWarningRetriever
 

Static Private Attributes

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

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 54 of file GUIMessageWindow.h.

Constructor & Destructor Documentation

◆ GUIMessageWindow()

GUIMessageWindow::GUIMessageWindow ( FXComposite *  parent)

Constructor.

Parameters
[in]parentThe parent window

Definition at line 45 of file GUIMessageWindow.cpp.

References myStyles.

◆ ~GUIMessageWindow()

GUIMessageWindow::~GUIMessageWindow ( )

Destructor.

Definition at line 99 of file GUIMessageWindow.cpp.

References myErrorRetriever, myMessageRetriever, myStyles, and myWarningRetriever.

Member Function Documentation

◆ addSeparator()

◆ appendMsg()

◆ clear()

void GUIMessageWindow::clear ( )

◆ enableLocateLinks()

static void GUIMessageWindow::enableLocateLinks ( const bool  val)
inlinestatic

switch locate links on and off

Definition at line 91 of file GUIMessageWindow.h.

References myLocateLinks.

Referenced by GUIDialog_AppSettings::onCmdOk().

◆ 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 108 of file GUIMessageWindow.cpp.

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

Referenced by appendMsg(), and setCursorPos().

◆ locateLinksEnabled()

static bool GUIMessageWindow::locateLinksEnabled ( )
inlinestatic

ask whether locate links is enabled

Definition at line 96 of file GUIMessageWindow.h.

References myLocateLinks.

◆ registerMsgHandlers()

◆ setCursorPos()

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

◆ unregisterMsgHandlers()

Field Documentation

◆ myDebugRetriever

OutputDevice * GUIMessageWindow::myDebugRetriever
private

Definition at line 145 of file GUIMessageWindow.h.

Referenced by registerMsgHandlers(), and unregisterMsgHandlers().

◆ myErrorRetriever

OutputDevice* GUIMessageWindow::myErrorRetriever
private

The instances of message retriever encapsulations.

Definition at line 145 of file GUIMessageWindow.h.

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

◆ myGLDebugRetriever

OutputDevice * GUIMessageWindow::myGLDebugRetriever
private

Definition at line 145 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 139 of file GUIMessageWindow.h.

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

◆ myMessageRetriever

OutputDevice * GUIMessageWindow::myMessageRetriever
private

◆ myStyles

FXHiliteStyle* GUIMessageWindow::myStyles
private

The text colors used.

Definition at line 142 of file GUIMessageWindow.h.

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

◆ myWarningRetriever

OutputDevice * GUIMessageWindow::myWarningRetriever
private

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