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

Ars::MessageClient Class Reference

#include <arsmessages.h>

Inheritance diagram for Ars::MessageClient:

Inheritance graph
[legend]

Public Member Functions

 MessageClient (void)
 Standard constructor.

virtual ~MessageClient (void)
 Standard destructor.

virtual const bool HandleMessage (const Message &msg)
virtual const bool IsVisible (void) const
virtual const bool evKeyDown (const KeyboardMessage &msg)
virtual const bool evKeyUp (const KeyboardMessage &msg)
virtual const bool evMouseButtonDown (const MouseMessage &msg)
virtual const bool evMouseButtonUp (const MouseMessage &msg)
virtual const bool evMouseMove (const MouseMessage &msg)
virtual const bool evMouseLClick (const CtrlMessage &msg)
virtual const bool evMouseMClick (const CtrlMessage &msg)
virtual const bool evMouseRClick (const CtrlMessage &msg)
virtual const bool evValueChange (const CtrlMessage &msg)
virtual const bool evValueChanging (const CtrlMessage &msg)
virtual const bool evTimer (const CtrlMessage &msg)
virtual const bool wmResize (const ResizeMessage &msg)
virtual const bool wmSetFocus (const Message &msg)
virtual const bool wmLostFocus (const CtrlMessage &msg)
virtual const bool wmPaint (const Message &msg)
virtual const bool SetupWindow (const Message &msg)
virtual const bool wmExit (const Message &msg)
virtual const bool DeregChild (const CtrlMessage &msg)
virtual const bool evPlayMpeg (const CtrlMessage &msg)
virtual const bool evMessage (const UserMessage &msg)

Constructor & Destructor Documentation

Ars::MessageClient::MessageClient (  void   ) 
 

Standard constructor.

Definition at line 40 of file arsmessage.cpp. 

00041 {
00042         MessageServer::Instance().RegisterMessageClient( this , Message::DEREG_CHILD );
00043 }

Ars::MessageClient::~MessageClient (  void   )  [virtual]
 

Standard destructor.

Definition at line 45 of file arsmessage.cpp. 

00046 {
00047         MessageServer::Instance().DeregisterMessageClient( this );
00048         MessageServer::Instance().DeregisterMessageClient( this , Message::DEREG_CHILD );
00049 }

Member Function Documentation

virtual const bool Ars::MessageClient::DeregChild (  const CtrlMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::Window.

Definition at line 222 of file arsmessages.h.

Referenced by HandleMessage(). 

00222 {       return false;   }

virtual const bool Ars::MessageClient::evKeyDown (  const KeyboardMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XEditBox, and Ars::XListBox.

Definition at line 205 of file arsmessages.h.

Referenced by HandleMessage(). 

00205 {       return false;   }

virtual const bool Ars::MessageClient::evKeyUp (  const KeyboardMessage &  msg  )  [inline, virtual]
 

Definition at line 206 of file arsmessages.h.

Referenced by HandleMessage(). 

00206 {       return false;   }

virtual const bool Ars::MessageClient::evMessage (  const UserMessage &  msg  )  [inline, virtual]
 

Definition at line 227 of file arsmessages.h.

Referenced by HandleMessage(). 

00227 {       return false;   }

virtual const bool Ars::MessageClient::evMouseButtonDown (  const MouseMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::Window, Ars::XButton, Ars::XEditBox, Ars::XListBox, and Ars::XScrollBar.

Definition at line 207 of file arsmessages.h.

Referenced by HandleMessage(). 

00207 {       return false;   }

virtual const bool Ars::MessageClient::evMouseButtonUp (  const MouseMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::Window, Ars::XButton, Ars::XCheckBox, Ars::XEditBox, Ars::XListBox, and Ars::XScrollBar.

Definition at line 208 of file arsmessages.h.

Referenced by HandleMessage(). 

00208 {       return false;   }

virtual const bool Ars::MessageClient::evMouseLClick (  const CtrlMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XCheckBox, Ars::XDropDown, and Ars::XScrollBar.

Definition at line 210 of file arsmessages.h.

Referenced by HandleMessage(). 

00210 {       return false;   }

virtual const bool Ars::MessageClient::evMouseMClick (  const CtrlMessage &  msg  )  [inline, virtual]
 

Definition at line 211 of file arsmessages.h.

Referenced by HandleMessage(). 

00211 {       return false;   }

virtual const bool Ars::MessageClient::evMouseMove (  const MouseMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XToolTip, Ars::XButton, Ars::XEditBox, Ars::XLabel, Ars::XProgress, and Ars::XScrollBar.

Definition at line 209 of file arsmessages.h.

Referenced by HandleMessage(). 

00209 {       return false;   }

virtual const bool Ars::MessageClient::evMouseRClick (  const CtrlMessage &  msg  )  [inline, virtual]
 

Definition at line 212 of file arsmessages.h.

Referenced by HandleMessage(). 

00212 {       return false;   }

virtual const bool Ars::MessageClient::evPlayMpeg (  const CtrlMessage &  msg  )  [inline, virtual]
 

If the value is 1, set the value to 2 when mpeg finished. if the value is 0 launch the mpeg if not already launched and sets the value to 1. else refresh the bitmap....

Definition at line 226 of file arsmessages.h.

Referenced by HandleMessage(). 

00226 {       return false;   }

virtual const bool Ars::MessageClient::evTimer (  const CtrlMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XToolTip.

Definition at line 215 of file arsmessages.h.

Referenced by HandleMessage(). 

00215 {       return false;   }

virtual const bool Ars::MessageClient::evValueChange (  const CtrlMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XDropDown, Ars::XListBox, and Ars::XTextBox.

Definition at line 213 of file arsmessages.h.

Referenced by HandleMessage(). 

00213 {       return false;   }

virtual const bool Ars::MessageClient::evValueChanging (  const CtrlMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XListBox, and Ars::XTextBox.

Definition at line 214 of file arsmessages.h.

Referenced by HandleMessage(). 

00214 {       return false;   }

const bool Ars::MessageClient::HandleMessage (  const Message &  msg  )  [virtual]
 

This is the callback used by the Message Server to distribute messages The client must first register with the server and indicate any messages it wishes to recieve

See also:
CMessageServer::RegisterMessageClient()
Returns:
true if the message was processed and nobody needs to process it.

Reimplemented in Ars::Window.

Definition at line 51 of file arsmessage.cpp.

References DeregChild(), evKeyDown(), evKeyUp(), evMessage(), evMouseButtonDown(), evMouseButtonUp(), evMouseLClick(), evMouseMClick(), evMouseMove(), evMouseRClick(), evPlayMpeg(), evTimer(), evValueChange(), evValueChanging(), IsVisible(), Ars::Message::MessageType(), SetupWindow(), wmExit(), wmLostFocus(), wmPaint(), wmResize(), and wmSetFocus().

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

00052 {
00053         bool ans = false;
00054 
00055         switch( msg.MessageType() )
00056         {
00057                 case Message::KEYBOARD_KEYDOWN :  
00058                         if( IsVisible() )       ans = evKeyDown( dynamic_cast<const KeyboardMessage &>( msg ) );        break;
00059                 case Message::KEYBOARD_KEYUP :  
00060                         if( IsVisible() )       ans = evKeyUp( dynamic_cast<const KeyboardMessage &>( msg ) );  break;
00061                 
00062                 case Message::MOUSE_BUTTONDOWN :  
00063                         if( IsVisible() )       ans = evMouseButtonDown( dynamic_cast<const MouseMessage &>( msg ) );   break;
00064                 case Message::MOUSE_BUTTONUP :  
00065                         if( IsVisible() )       ans = evMouseButtonUp( dynamic_cast<const MouseMessage &>( msg ) );     break;
00066                 case Message::MOUSE_MOVE :  
00067                         ans = evMouseMove( dynamic_cast<const MouseMessage &>( msg ) ); break;
00068                 
00069                 case Message::CTRL_LCLICK :  
00070                         if( IsVisible() )       ans = evMouseLClick( dynamic_cast<const CtrlMessage &>( msg ) );        break;
00071                 case Message::CTRL_RCLICK :  
00072                         if( IsVisible() )       ans = evMouseMClick( dynamic_cast<const CtrlMessage &>( msg ) );        break;
00073                 case Message::CTRL_MCLICK :  
00074                         if( IsVisible() )       ans = evMouseRClick( dynamic_cast<const CtrlMessage &>( msg ) );        break;
00075                 
00076                 case Message::CTRL_VALUECHANGE :  
00077                         ans = evValueChange( dynamic_cast<const CtrlMessage &>( msg ) );        break;
00078                 case Message::CTRL_VALUECHANGING :  
00079                         ans = evValueChanging( dynamic_cast<const CtrlMessage &>( msg ) );      break;
00080                 case Message::CTRL_TIMER :      
00081                         ans = evTimer( dynamic_cast<const CtrlMessage &>( msg ) );      break;
00082 
00083                 case Message::CTRL_RESIZE :  
00084                         ans = wmResize( dynamic_cast<const ResizeMessage &>( msg ) );   break;
00085 
00086                 case Message::DEREG_CHILD :  
00087                         ans = DeregChild( dynamic_cast<const CtrlMessage &>( msg ) );   break;
00088                 case Message::APP_PAINT :  
00089                         ans = wmPaint( msg );   break;
00090                 case Message::LOST_FOCUS :  
00091                         ans = wmLostFocus( dynamic_cast<const CtrlMessage &>( msg ) );  break;
00092                 case Message::SET_FOCUS :  
00093                         if( IsVisible() )       ans = wmSetFocus( msg );        break;
00094                 
00095                 case Message::SETUP_WINDOW : 
00096                         ans = SetupWindow( msg );       break;
00097                 case Message::APP_EXIT :  
00098                         ans = wmExit( msg );    break;
00099                 
00100                 case Message::PLAY_MPEG :  
00101                         ans = evPlayMpeg( dynamic_cast<const CtrlMessage &>( msg ) );   break;
00102 
00103                 case Message::USER :  
00104                         ans = evMessage( dynamic_cast<const UserMessage &>( msg ) );    break;
00105         }
00106 
00107         return ans;
00108 }

virtual const bool Ars::MessageClient::IsVisible (  void   )  const [inline, virtual]
 

Reimplemented in Ars::Thing, and Ars::Window.

Definition at line 203 of file arsmessages.h.

Referenced by HandleMessage(). 

00203 {       return true;    };

virtual const bool Ars::MessageClient::SetupWindow (  const Message &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XToolTip, Ars::View, Ars::Window, Ars::XButton, Ars::XButtonImage, Ars::XCheckBox, Ars::XDropDown, Ars::XEditBox, Ars::XImage, Ars::XLabel, Ars::XListBox, Ars::XMPEG, Ars::XProgress, Ars::XScrollBar, and Ars::XTextBox.

Definition at line 220 of file arsmessages.h.

Referenced by HandleMessage(). 

00220 {       return false;   }

virtual const bool Ars::MessageClient::wmExit (  const Message &  msg  )  [inline, virtual]
 

Reimplemented in Ars::ArsApplication.

Definition at line 221 of file arsmessages.h.

Referenced by HandleMessage(). 

00221 {       return false;   }

virtual const bool Ars::MessageClient::wmLostFocus (  const CtrlMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::XDropDown.

Definition at line 218 of file arsmessages.h.

Referenced by HandleMessage(). 

00218 {       return false;   }

virtual const bool Ars::MessageClient::wmPaint (  const Message &  msg  )  [inline, virtual]
 

Reimplemented in Ars::Window.

Definition at line 219 of file arsmessages.h.

Referenced by HandleMessage(). 

00219 {       return false;   }

virtual const bool Ars::MessageClient::wmResize (  const ResizeMessage &  msg  )  [inline, virtual]
 

Reimplemented in Ars::View.

Definition at line 216 of file arsmessages.h.

Referenced by HandleMessage(). 

00216 {       return false;   }

virtual const bool Ars::MessageClient::wmSetFocus (  const Message &  msg  )  [inline, virtual]
 

Definition at line 217 of file arsmessages.h.

Referenced by HandleMessage(). 

00217 {       return false;   }

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