GUIMessageWindow Class Reference

#include <GUIMessageWindow.h>

Inheritance diagram for GUIMessageWindow:

---

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.

Public Member Functions
void	addSeparator () throw ()
	Adds a a separator to this log window.
void	appendText (GUIEventType eType, const std::string &msg) throw ()
	Adds new text to the window.
void	clear () throw ()
	Clears the window.
	GUIMessageWindow (FXComposite *parent) throw ()
	Constructor.
	~GUIMessageWindow () throw ()
	Destructor.
Private Attributes
FXHiliteStyle *	myStyles
	The text colors used.

---

Constructor & Destructor Documentation

GUIMessageWindow::GUIMessageWindow

(

FXComposite *

parent

)

throw ()

Constructor.

Parameters:

[in]

parent

The parent window

Definition at line 41 of file GUIMessageWindow.cpp.

        : FXText(parent, 0, 0, 0, 0, 0, 0, 50),
        myStyles(0) {
    setStyled(true);
    setEditable(false);
    myStyles = new FXHiliteStyle[4];
    // set separator style
    myStyles[0].normalForeColor = FXRGB(0x00, 0x00, 0x88);
    myStyles[0].normalBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[0].selectForeColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[0].selectBackColor = FXRGB(0x00, 0x00, 0x88);
    myStyles[0].hiliteForeColor = FXRGB(0x00, 0x00, 0x88);
    myStyles[0].hiliteBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[0].activeBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[0].style = 0;
    // set message text style
    myStyles[1].normalForeColor = FXRGB(0x00, 0x88, 0x00);
    myStyles[1].normalBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[1].selectForeColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[1].selectBackColor = FXRGB(0x00, 0x88, 0x00);
    myStyles[1].hiliteForeColor = FXRGB(0x00, 0x88, 0x00);
    myStyles[1].hiliteBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[1].activeBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[1].style = 0;
    // set error text style
    myStyles[2].normalForeColor = FXRGB(0x88, 0x00, 0x00);
    myStyles[2].normalBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[2].selectForeColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[2].selectBackColor = FXRGB(0x88, 0x00, 0x00);
    myStyles[2].hiliteForeColor = FXRGB(0x88, 0x00, 0x00);
    myStyles[2].hiliteBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[2].activeBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[2].style = 0;
    // set warning text style
    myStyles[3].normalForeColor = FXRGB(0xe6, 0x98, 0x00);
    myStyles[3].normalBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[3].selectForeColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[3].selectBackColor = FXRGB(0xe6, 0x98, 0x00);
    myStyles[3].hiliteForeColor = FXRGB(0xe6, 0x98, 0x00);
    myStyles[3].hiliteBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[3].activeBackColor = FXRGB(0xff, 0xff, 0xff);
    myStyles[3].style = 0;
    //
    setHiliteStyles(myStyles);
}

GUIMessageWindow::~GUIMessageWindow

(

)

throw ()

Destructor.

Definition at line 88 of file GUIMessageWindow.cpp.

References myStyles.

                                            {
    delete[] myStyles;
}

---

Member Function Documentation

void GUIMessageWindow::addSeparator

(

)

throw ()

Adds a a separator to this log window.

Definition at line 128 of file GUIMessageWindow.cpp.

Referenced by GUIApplicationWindow::closeAllWindows().

                                       {
    std::string msg = "----------------------------------------------------------------------------------------\n";
    FXText::appendStyledText(msg.c_str(), (FXint) msg.length(), 1, true);
    FXText::setCursorPos(getLength()-1);
    FXText::setBottomLine(getLength()-1);
    if (isEnabled()) {
        layout();
        update();
    }
}

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

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

References EVENT_ERROR_OCCURED, EVENT_MESSAGE_OCCURED, and EVENT_WARNING_OCCURED.

Referenced by GUIApplicationWindow::handleEvent_Message().

                                                                             {
    if (!isEnabled()) {
        show();
    }
    // build the styled message
    FXint style = 1;
    switch (eType) {
    case EVENT_ERROR_OCCURED:
        // color: red
        style = 2;
        break;
    case EVENT_WARNING_OCCURED:
        // color: yellow
        style = 3;
        break;
    case EVENT_MESSAGE_OCCURED:
        // color: green
        style = 1;
        break;
    default:
        assert(false);
    }
    // insert message to buffer
    FXText::appendStyledText(msg.c_str(), (FXint) msg.length(), style+1, true);
    FXText::setCursorPos(getLength()-1);
    FXText::setBottomLine(getLength()-1);
    if (isEnabled()) {
        layout();
        update();
    }
}

void GUIMessageWindow::clear

(

)

throw ()

Clears the window.

Definition at line 141 of file GUIMessageWindow.cpp.

Referenced by GUIApplicationWindow::onCmdClearMsgWindow().

                                {
    if (getLength()==0) {
        return;
    }
    FXText::removeText(0, getLength()-1, true);
    if (isEnabled()) {
        layout();
        update();
    }
}

---

Field Documentation

FXHiliteStyle* GUIMessageWindow::myStyles [private]

The text colors used.

Definition at line 86 of file GUIMessageWindow.h.

Referenced by ~GUIMessageWindow().

---

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

• GUIMessageWindow.h
• GUIMessageWindow.cpp