wGui::CMouseMessage Class Reference

Any messages generated from mouse input. More...

#include <wg_message.h>

Inheritance diagram for wGui::CMouseMessage:

Public Types

• enum EMouseButton {
    NONE = 0, LEFT = 1, RIGHT = 2, MIDDLE = 4,
    WHEELUP = 8, WHEELDOWN = 16
  }

  Constants for all the mouse buttons, these values can be ORed together for more than one button. More...
  

Public Member Functions

• CMouseMessage (const EMessageType MessageType, const CMessageClient *pDestination, const CMessageClient *pSource, CPoint Point, CPoint Relative, unsigned int Button)

Static Public Member Functions

• static unsigned int TranslateSDLButton (Uint8 SDLButton)

  Converst an SDLButton value into an EMouseButton value.
  

• static unsigned int TranslateSDLButtonState (Uint8 SDLButtonState)

  Converts an SDLButtonState value into an ORing of EMouseButton values.
  

Data Fields

• CPoint Point

  The point where the mouse cursor was at the time of the message.
  

• CPoint Relative

  The relative movement of the cursor (only valid for MOUSE_MOVE messages).
  

• unsigned int Button

  Any mouse buttons pressed.
  

---

Detailed Description

Any messages generated from mouse input.

Definition at line 155 of file wg_message.h.

---

Member Enumeration Documentation

enum wGui::CMouseMessage::EMouseButton

Constants for all the mouse buttons, these values can be ORed together for more than one button.

Enumerator:

NONE	No mouse button.
LEFT	The left mouse button.
RIGHT	The right mouse button.
MIDDLE	The middle mouse button.
WHEELUP	The mouse wheel moved up.
WHEELDOWN	The mouse wheel moved down.

Definition at line 159 of file wg_message.h.

---

Constructor & Destructor Documentation

wGui::CMouseMessage::CMouseMessage	(	const EMessageType	MessageType,
		const CMessageClient *	pDestination,
		const CMessageClient *	pSource,
		CPoint	Point,
		CPoint	Relative,
		unsigned int	Button
	)

Construct a new mouse 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 window that created the message
	Point	The location of the mouse cursor
	Relative	The relative movement of the cursor (only valid for MOUSE_MOVE messages)
	Button	An OR of all the EMouseButton values indicating which mouse buttons are pressed

Definition at line 63 of file wg_message.cpp.

---

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

• wg_message.h
• wg_message.cpp

---