PopUpMessageWidget Class Reference

#include <PopUpMessageWidget.h>

Inheritance diagram for PopUpMessageWidget:

Collaboration diagram for PopUpMessageWidget:

Classes
class	DataClass

Public Types
enum	MessageType {   Information = 0, Notice = 1, Warning = 2, Error = 3,   Question = 4, Valid = 5, InvalidInformation = 6, InvalidWarning = 7,   InvalidError = 8 }
enum	Button {   NoButton = 0x0000, Ok = 0x0001, Yes = 0x0002, Retry = 0x0004,   No = 0x0008, Cancel = 0x0010, DispatcherLogin = 0x0020, Detail = 0x0040,   CloseButton = 0x0080, Read = 0x0100 }

Public Slots
void	Close ()

Signals
void	Finished ()

Public Member Functions
	PopUpMessageWidget (QWidget *parent=0)
	PopUpMessageWidget (const QString &messageTitle, const QString &messageText, MessageType messageType=Information, Buttons buttons=Ok, QWidget *parent=0, unsigned short timeout=0, const QString &messageLabel="")
virtual	~PopUpMessageWidget ()
void	SetButtonClickHandler (PopUpMessageButtonHandler *buttonClickHandler)
	SetButtonClickHandler - sets a PopUpMessageButtonHandler to be used to handle button clicks. More...
void	SetMessageTitleAndText (const QString &messageTitle, const QString &messageText)
	SetMessageTitleAndText - sets message title and text. More...
void	SetButtonText (Button button, const QString &text)
	SetButtonText - replaces the text of a button (if the button is shown). More...
void	SetMessageType (MessageType messageType)
	SetMessageType - sets type of the message. More...
void	HideOnTouchOrEscape (bool hide)
	HideOnTouchOrEscape - set the flag saying if message should hide ofter touch or escape pressed. More...
void	HideTitleLabel ()
	HideTitleLabel - hides the title label, making more room for message text. More...
void	AddAndFillColumn (const QList< QString > &columnContents)
	AddAndFillColumn - creates new column in message description layout and fills it with list of strings. More...
void	show (bool modal=false)
	show - shows the pop-up message. More...
void	hide ()
	hide - hides the pop-up message. More...
Button	GetClickedButton ()
	Returns last clicked button. More...
QString	GetMessageText ()
	return widget's message text More...

Static Public Attributes
static constexpr PopUpMessageButtonHandler *	NULL_BUTTON_HANDLER = nullptr

Protected Member Functions
void	mousePressEvent (QMouseEvent *event)
void	timerEvent (QTimerEvent *event)
Protected Member Functions inherited from CustomStyledDialog
	CustomStyledDialog (QWidget *parent=0)
virtual	~CustomStyledDialog ()
virtual void	paintEvent (QPaintEvent *)

Member Enumeration Documentation

enum PopUpMessageWidget::Button

Enumerator
NoButton
Ok
Yes
Retry
No
Cancel
DispatcherLogin
Detail
CloseButton
Read

enum PopUpMessageWidget::MessageType

Enumerator
Information
Notice
Warning
Error
Question
Valid
InvalidInformation
InvalidWarning
InvalidError

Constructor & Destructor Documentation

PopUpMessageWidget::PopUpMessageWidget ( QWidget *  parent = 0 )

explicit

Here is the call graph for this function:

PopUpMessageWidget::PopUpMessageWidget	(	const QString &	messageTitle,
		const QString &	messageText,
		MessageType	messageType = Information,
		Buttons	buttons = Ok,
		QWidget *	parent = 0,
		unsigned short	timeout = 0,
		const QString &	messageLabel = ""
	)

PopUpMessageWidget::~PopUpMessageWidget ( )

virtual

Member Function Documentation

void PopUpMessageWidget::AddAndFillColumn

(

const QList< QString > &

columnContents

)

AddAndFillColumn - creates new column in message description layout and fills it with list of strings.

Parameters

columnContents

- list of strings, every string is displayed on a new line

Here is the caller graph for this function:

void PopUpMessageWidget::Close ( )

slot

Here is the call graph for this function:

Here is the caller graph for this function:

void PopUpMessageWidget::Finished ( )

signal

Here is the caller graph for this function:

PopUpMessageWidget::Button PopUpMessageWidget::GetClickedButton

(

)

Returns last clicked button.

Here is the caller graph for this function:

QString PopUpMessageWidget::GetMessageText

(

)

return widget's message text

void PopUpMessageWidget::hide

(

)

hide - hides the pop-up message.

Here is the call graph for this function:

Here is the caller graph for this function:

void PopUpMessageWidget::HideOnTouchOrEscape

(

bool

hide

)

HideOnTouchOrEscape - set the flag saying if message should hide ofter touch or escape pressed.

Parameters

hide	- true if message should hide after touch event or pressing escape

Here is the call graph for this function:

Here is the caller graph for this function:

void PopUpMessageWidget::HideTitleLabel

(

)

HideTitleLabel - hides the title label, making more room for message text.

Here is the caller graph for this function:

void PopUpMessageWidget::mousePressEvent ( QMouseEvent *  event )

protected

Here is the call graph for this function:

void PopUpMessageWidget::SetButtonClickHandler

(

PopUpMessageButtonHandler *

buttonClickHandler

)

SetButtonClickHandler - sets a PopUpMessageButtonHandler to be used to handle button clicks.

Parameters

buttonClickHandler

- pointer to the PopUpMessageButtonHandler instance

Here is the caller graph for this function:

void PopUpMessageWidget::SetButtonText	(	Button	button,
		const QString &	text
	)

SetButtonText - replaces the text of a button (if the button is shown).

Parameters

button	- button type from the Button enum
text	- text for the button

Here is the caller graph for this function:

void PopUpMessageWidget::SetMessageTitleAndText	(	const QString &	messageTitle,
		const QString &	messageText
	)

SetMessageTitleAndText - sets message title and text.

Parameters

messageTitle	- message title
messageText	- message text

void PopUpMessageWidget::SetMessageType

(

MessageType

messageType

)

SetMessageType - sets type of the message.

Parameters

messageType

- type of the message from the MessageType enum

void PopUpMessageWidget::show

(

bool

modal = false

)

show - shows the pop-up message.

Here is the call graph for this function:

Here is the caller graph for this function:

void PopUpMessageWidget::timerEvent ( QTimerEvent *  event )

protected

Here is the call graph for this function:

Member Data Documentation

constexpr PopUpMessageButtonHandler* PopUpMessageWidget::NULL_BUTTON_HANDLER = nullptr

static

---

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

• src/ui/components/PopUpMessageWidget.h
• src/ui/components/PopUpMessageWidget.cpp