Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals

Ars::Message Class Reference

#include <arsmessages.h>

Inheritance diagram for Ars::Message:

Inheritance graph
[legend]
Collaboration diagram for Ars::Message:

Collaboration graph
[legend]

Public Types

enum  EMessageType {
  UNKNOWN = 0, KEYBOARD_KEYDOWN = 1, KEYBOARD_KEYUP = 2, MOUSE_BUTTONDOWN = 3,
  MOUSE_BUTTONUP = 4, MOUSE_MOVE = 5, CTRL_LCLICK = 7, CTRL_RCLICK = 8,
  CTRL_MCLICK = 9, CTRL_VALUECHANGE = 10, CTRL_VALUECHANGING = 11, CTRL_RESIZE = 12,
  CTRL_TIMER = 13, APP_PAINT = 14, APP_EXIT = 15, SETUP_WINDOW = 16,
  LOST_FOCUS = 17, SET_FOCUS = 18, DEREG_CHILD = 19, PLAY_MPEG = 20,
  USER = 200
}

Public Member Functions

 Message (const EMessageType MessageType, MessageClient *pdestination=0)
virtual ~Message (void)
 Standard destructor.

const EMessageType MessageType (void) const
 The message type of the message.

MessageClient * Destination (void) const
 A pointer to the destination of the message (0 for no specific destination, or to broadcast to all).

void SetTarget (MessageClient *dest)

Data Fields

void * from
unsigned int line
std::string file

Private Attributes

const EMessageType messageType
 The message type.

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

Member Enumeration Documentation

enum Ars::Message::EMessageType
 

Enumeration values:
UNKNOWN  An unknown message, this is not a valid type.
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.
CTRL_LCLICK  CCtrlMessage generated when a control is clicked on with the left mouse button.
CTRL_RCLICK  CCtrlMessage generated when a control is clicked on with the right mouse button.
CTRL_MCLICK  CCtrlMessage generated when a control is clicked on with the middle mouse button.
CTRL_VALUECHANGE  CCtrlMessage generated when a control's text or value is changed via user input.
CTRL_VALUECHANGING  CCtrlMessage generated when a control's text or value is in the process of changing via user input.
CTRL_RESIZE  CResizeMessage used to tell the app that the view has been resized.
CTRL_TIMER  CCtrlMessage used to tell when a timer has expired, where iNewValue is the count of times fired.
APP_PAINT  CMessage used to tell controls or windows to redraw themselves.
APP_EXIT  CMessage used to tell controls or windows that the application is closing.
SETUP_WINDOW  CMessage use to initialize the window.
LOST_FOCUS  CMessage when the focus of the window is lost...
SET_FOCUS  CMessage when the focus is set to this window...
DEREG_CHILD  Avoid Bore effect when deregistering a children window.
PLAY_MPEG  PLay an mpeg(1,2,3) movie then restore the image.
USER  Any user defined messages of type CUserMessage.

Definition at line 12 of file arsmessages.h.

Referenced by MessageType(). 

00013         {
00014                 UNKNOWN = 0,  
00015                 KEYBOARD_KEYDOWN = 1,  
00016                 KEYBOARD_KEYUP = 2,  
00017                 MOUSE_BUTTONDOWN = 3,  
00018                 MOUSE_BUTTONUP = 4,  
00019                 MOUSE_MOVE = 5,  
00020                 CTRL_LCLICK = 7,  
00021                 CTRL_RCLICK = 8,  
00022                 CTRL_MCLICK = 9,  
00023                 CTRL_VALUECHANGE = 10,  
00024                 CTRL_VALUECHANGING = 11,  
00025                 CTRL_RESIZE = 12,  
00026                 CTRL_TIMER = 13,        
00027                 APP_PAINT = 14,  
00028                 APP_EXIT = 15,  
00029                 SETUP_WINDOW = 16, 
00030                 LOST_FOCUS = 17 ,       
00031                 SET_FOCUS = 18 ,                
00032                 DEREG_CHILD = 19 ,      
00033                 PLAY_MPEG = 20 ,        
00034                 USER = 200 
00035         };

Constructor & Destructor Documentation

Ars::Message::Message (  const EMessageType  MessageType,
MessageClient *  pdestination = 0
)  [inline]
 

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)

Definition at line 54 of file arsmessages.h.

References destination, and messageType. 

00055         : messageType( MessageType ) , destination( pdestination )      {}

virtual Ars::Message::~Message (  void   )  [inline, virtual]
 

Standard destructor.

Definition at line 58 of file arsmessages.h. 

00058 {}

Member Function Documentation

MessageClient* Ars::Message::Destination (  void   )  const [inline]
 

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

Definition at line 64 of file arsmessages.h.

References destination.

Referenced by Ars::XListBox::evKeyDown(), Ars::XEditBox::evKeyDown(), Ars::XScrollBar::evMouseLClick(), Ars::XCheckBox::evMouseLClick(), Ars::XToolTip::evTimer(), Ars::XDropDown::evValueChange(), Ars::MessageServer::HandleTillRoot(), Ars::Form::HandleTillRoot(), Ars::MessageServer::LaunchMessage(), Ars::MessageServer::ProcessMessage(), Ars::Form::ProcessMessage(), and Ars::Window::wmPaint(). 

00064 { return destination; }

const EMessageType Ars::Message::MessageType (  void   )  const [inline]
 

The message type of the message.

Definition at line 61 of file arsmessages.h.

References EMessageType, and messageType.

Referenced by Ars::Window::HandleMessage(), Ars::MessageClient::HandleMessage(), Ars::MessageServer::HandleTillRoot(), Ars::Form::HandleTillRoot(), Ars::MessageServer::LaunchMessage(), Ars::MessageServer::ProcessMessage(), and Ars::Form::ProcessMessage(). 

00061 { return messageType; }

void Ars::Message::SetTarget (  MessageClient *  dest  )  [inline]
 

Definition at line 66 of file arsmessages.h.

References destination.

Referenced by Ars::MessageServer::HandleTillRoot(), and Ars::Form::HandleTillRoot(). 

00066 {       destination = dest;     }

Field Documentation

MessageClient* Ars::Message::destination [private]
 

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

Definition at line 43 of file arsmessages.h.

Referenced by Destination(), Message(), and SetTarget().

std::string Ars::Message::file
 

Definition at line 49 of file arsmessages.h.

Referenced by Ars::MessageServer::QueueMessage().

void* Ars::Message::from
 

Definition at line 47 of file arsmessages.h.

Referenced by Ars::MessageServer::QueueMessage().

unsigned int Ars::Message::line
 

Definition at line 48 of file arsmessages.h.

Referenced by Ars::MessageServer::QueueMessage().

const EMessageType Ars::Message::messageType [private]
 

The message type.

Definition at line 40 of file arsmessages.h.

Referenced by Message(), and MessageType().

The documentation for this class was generated from the following file:
Generated on Fri Dec 5 04:06:45 2003 for Borqueror by doxygen 1.3.3