wGui::CMessage Class Reference

The base message class. More...

#include <wg_message.h>

Inheritance diagram for wGui::CMessage:

Public Types

• enum EMessageType {
    UNKNOWN = 0, APP_DESTROY_FRAME, APP_EXIT, APP_PAINT,
    CTRL_DOUBLELCLICK, CTRL_DOUBLEMCLICK, CTRL_DOUBLERCLICK, CTRL_GAININGKEYFOCUS,
    CTRL_GAININGMOUSEFOCUS, CTRL_LOSINGKEYFOCUS, CTRL_LOSINGMOUSEFOCUS, CTRL_MESSAGEBOXRETURN,
    CTRL_RESIZE, CTRL_SINGLELCLICK, CTRL_SINGLEMCLICK, CTRL_SINGLERCLICK,
    CTRL_TIMER, CTRL_VALUECHANGE, CTRL_VALUECHANGING, KEYBOARD_KEYDOWN,
    KEYBOARD_KEYUP, MOUSE_BUTTONDOWN, MOUSE_BUTTONUP, MOUSE_MOVE,
    SDL, USER
  }

  The various message types. More...
  

Public Member Functions

• CMessage (const EMessageType MessageType, const CMessageClient *pDestination, const CMessageClient *pSource)
• virtual ~CMessage (void)

  Standard destructor.
  

• const EMessageType MessageType (void)
• const CMessageClient * Destination (void)
• const CMessageClient * Source (void)

Protected Attributes

• const EMessageType m_MessageType

  The message type.
  

• const CMessageClient * m_pDestination

  A pointer to the message destination (0 for no specific destination, or to broadcast to all).
  

• const CMessageClient * m_pSource

  A pointer to the control that generated the message.
  

---

Detailed Description

The base message class.

wGui uses Message object to inform other objects of events.

See also:

CMessageServer CMessageClient

Definition at line 44 of file wg_message.h.

---

Member Enumeration Documentation

enum wGui::CMessage::EMessageType

The various message types.

Enumerator:

UNKNOWN	An unknown message, this is not a valid type.
APP_DESTROY_FRAME	CMessage used to delete frame objects, where Source() is the frame that is to be deleted, Destination() should be 0.
APP_EXIT	CMessage used to tell controls or windows that the application is closing.
APP_PAINT	CMessage used to tell controls or windows to redraw themselves.
CTRL_DOUBLELCLICK	TIntMessage generated when a control is double clicked with the left mouse button.
CTRL_DOUBLEMCLICK	TIntMessage generated when a control is double clicked with the middle mouse button.
CTRL_DOUBLERCLICK	TIntMessage generated when a control is double clicked with the right mouse button.
CTRL_GAININGKEYFOCUS	CMessage used to tell a control that it's getting the keyboard focus.
CTRL_GAININGMOUSEFOCUS	CMessage used to tell a control that it's getting the mouse focus.
CTRL_LOSINGKEYFOCUS	CMessage used to tell a control that it's losing the keyboard focus.
CTRL_LOSINGMOUSEFOCUS	CMessage used to tell a control that it's losing the mouse focus.
CTRL_MESSAGEBOXRETURN	CValueMessage sent when a CMessageBox closes.
CTRL_RESIZE	TPointMessage used to tell the app that the view has been resized.
CTRL_SINGLELCLICK	TIntMessage generated when a control is clicked on with the left mouse button.
CTRL_SINGLEMCLICK	TIntMessage generated when a control is clicked on with the middle mouse button.
CTRL_SINGLERCLICK	TIntMessage generated when a control is clicked on with the right mouse button.
CTRL_TIMER	TIntMessage used to tell when a timer has expired, where Value() is the count of times fired.
CTRL_VALUECHANGE	CValueMessage generated when a control's text or value is changed via user input.
CTRL_VALUECHANGING	CValueMessage generated when a control's text or value is in the process of changing via user input.
KEYBOARD_KEYDOWN	CKeyboardMessage generated when a keyboard key is pressed.
KEYBOARD_KEYUP	CKeyboardMessage generated when a keyboard key is released.
MOUSE_BUTTONDOWN	CMouseMessage generated when a mouse button is pressed.
MOUSE_BUTTONUP	CMouseMessage generated when a mouse button is released.
MOUSE_MOVE	CMouseMessage generated when a mouse is moved.
SDL	An unhandled SDL event.
USER	Any user defined messages of type CUserMessage.

Definition at line 48 of file wg_message.h.

---

Constructor & Destructor Documentation

wGui::CMessage::CMessage	(	const EMessageType	MessageType,
		const CMessageClient *	pDestination,
		const CMessageClient *	pSource
	)

Construct a new message

Parameters:

	MessageType	The type of message being created
	pDestination	A pointer to the window that the message is destined for (0 for no specific destination, or to broadcast to all)
	pSource	A pointer to the source of the message

Definition at line 34 of file wg_message.cpp.

---

Member Function Documentation

const EMessageType wGui::CMessage::MessageType

(

void

)

[inline]

Gets the message type

Returns:

The message type of the message

Definition at line 89 of file wg_message.h.

References m_MessageType.

Referenced by wGui::CView::HandleMessage(), wGui::CToolTip::HandleMessage(), wGui::CToolBar::HandleMessage(), wGui::CTextBox::HandleMessage(), wGui::CScrollBar::HandleMessage(), wGui::CRadioButton::HandleMessage(), wGui::CMessageBox::HandleMessage(), wGui::CPopupMenu::HandleMessage(), wGui::CMenu::HandleMessage(), wGui::CMenuBase::HandleMessage(), wGui::CListBox::HandleMessage(), wGui::CFrame::HandleMessage(), wGui::CEditBox::HandleMessage(), wGui::CDropDown::HandleMessage(), wGui::CCheckBox::HandleMessage(), wGui::CButton::HandleMessage(), wGui::CApplication::HandleMessage(), wGui::Duplicate_APP_PAINT::operator()(), and wGui::CMessageServer::QueueMessage().

const CMessageClient* wGui::CMessage::Destination

(

void

)

[inline]

Gets the intended destination for the message

Returns:

A pointer to the destination of the message (0 for no specific destination, or to broadcast to all)

Definition at line 93 of file wg_message.h.

References m_pDestination.

Referenced by wGui::CView::HandleMessage(), wGui::CToolBar::HandleMessage(), wGui::CTextBox::HandleMessage(), wGui::CScrollBar::HandleMessage(), wGui::CRadioButton::HandleMessage(), wGui::CMessageBox::HandleMessage(), wGui::CPopupMenu::HandleMessage(), wGui::CMenuBase::HandleMessage(), wGui::CFrame::HandleMessage(), wGui::CEditBox::HandleMessage(), wGui::CDropDown::HandleMessage(), wGui::CCheckBox::HandleMessage(), wGui::Duplicate_APP_PAINT::operator()(), and wGui::CMessageServer::QueueMessage().

const CMessageClient* wGui::CMessage::Source

(

void

)

[inline]

Gets the source of the message

Returns:

A pointer to the source of the message

Definition at line 97 of file wg_message.h.

References m_pSource.

Referenced by wGui::CView::HandleMessage(), wGui::CToolBar::HandleMessage(), wGui::CTextBox::HandleMessage(), wGui::CScrollBar::HandleMessage(), wGui::CMessageBox::HandleMessage(), wGui::CMenuBase::HandleMessage(), wGui::CListBox::HandleMessage(), wGui::CFrame::HandleMessage(), wGui::CEditBox::HandleMessage(), and wGui::CDropDown::HandleMessage().

---

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

• wg_message.h
• wg_message.cpp

---