Ars::UserMessage Class Reference

Any user created messages. More...

#include <arsmessages.h>

Inheritance diagram for Ars::UserMessage:

[legend]Collaboration diagram for Ars::UserMessage:

[legend]

Public Member Functions
	UserMessage (const EMessageType MessageType, MessageClient *pDestination, const unsigned long int aSubMessage, const void *pData=0)
const unsigned long int	SubMessage (void) const
const void *	Data (void) const
Private Attributes
const unsigned long int	subMessage
	An integer that specifies the type of user defined message.
const void *	data
	A pointer to any data the user has.

---

Detailed Description

Any user created messages.

Definition at line 166 of file arsmessages.h.

---

Constructor & Destructor Documentation

Ars::UserMessage::UserMessage (  const EMessageType  MessageType, MessageClient *  pDestination, const unsigned long int  aSubMessage, const void *  pData = 0 )  [inline]

Construct a new User 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) iUserType  An integer that specifies the type of user defined message pData  A pointer to any data the user has Definition at line 180 of file arsmessages.h. References data, and subMessage. : Message( MessageType , pDestination ) , subMessage( aSubMessage ) , data( pData ) {}

---

Member Function Documentation

const void* Ars::UserMessage::Data (  void   )  const [inline]

Definition at line 186 of file arsmessages.h. References data. { return data; }

const unsigned long int Ars::UserMessage::SubMessage (  void   )  const [inline]

Definition at line 184 of file arsmessages.h. References subMessage. { return subMessage; }

---

Field Documentation

const void* Ars::UserMessage::data [private]

A pointer to any data the user has. Definition at line 172 of file arsmessages.h. Referenced by Data(), and UserMessage().

const unsigned long int Ars::UserMessage::subMessage [private]

An integer that specifies the type of user defined message. Definition at line 169 of file arsmessages.h. Referenced by SubMessage(), and UserMessage().

---

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

• arsmessages.h

---