regcom::client::Client

Client Class Reference

#include <Client.h>

List of all members.


Public Types

enum  USER_EVENT {
  USER_EVENT_ZOOM_IN = 1, USER_EVENT_ZOOM_OUT = 2, USER_EVENT_TOGGLE_GRID = 3, USER_EVENT_NEW_MAP = 4,
  USER_EVENT_QUIT_GAME = 5
}
 Enumeration of valid user events. More...

Public Member Functions

 Client ()
 Public constructor.
virtual ~Client ()
 Virtual destructor.
int Run ()
 (*** add brief description here ***)

Protected Member Functions

void PollEvents ()
 (*** add brief description here ***)
void OnActiveEvent (SDL_ActiveEvent sdlEvent)
 (*** add brief description here ***)
void OnKeyDown (SDL_KeyboardEvent sdlEvent)
 (*** add brief description here ***)
void OnKeyUp (SDL_KeyboardEvent sdlEvent)
 (*** add brief description here ***)
void OnMouseMotion (SDL_MouseMotionEvent sdlEvent)
 (*** add brief description here ***)
void OnMouseButtonDown (SDL_MouseButtonEvent sdlEvent)
 (*** add brief description here ***)
void OnMouseButtonUp (SDL_MouseButtonEvent sdlEvent)
 (*** add brief description here ***)
void OnVideoResize (SDL_ResizeEvent sdlEvent)
 (*** add brief description here ***)
void OnQuit (SDL_QuitEvent sdlEvent)
 (*** add brief description here ***)
void OnUserEvent (SDL_UserEvent sdlEvent)
 (*** add brief description here ***)
void OnSysWMEvent (SDL_SysWMEvent sdlEvent)
 (*** add brief description here ***)
void PushUserEvent (int code, void *pData1, void *pData2)
 (*** add brief description here ***)

Private Attributes

bool m_Done
 (*** add brief description here ***)
regcom::common::Map * m_pMap
 (*** add brief description here ***)
gui::Desktop * m_pDesktop
 (*** add brief description here ***)
MapView * m_pMapView
 (*** add brief description here ***)
Console * m_pConsole
 (*** add brief description here ***)

Detailed Description

(*** add brief description here ***)
Full Description
(*** add full description here ***)

Member Enumeration Documentation

enum USER_EVENT

Enumeration of valid user events.

Enumerator:
USER_EVENT_ZOOM_IN  Zoom in.
USER_EVENT_ZOOM_OUT  Zoom out.
USER_EVENT_TOGGLE_GRID  Toggle grid.
USER_EVENT_NEW_MAP  New map.
USER_EVENT_QUIT_GAME  Quit game.

Constructor & Destructor Documentation

Client (  ) 

Public constructor.

Full Description
This method creates a new instance of the class.
Returns:
New instance of the class.

~Client (  )  [virtual]

Virtual destructor.

Full Description
This method destroys an existing instance of the class.
Returns:
None.

Member Function Documentation

int Run (  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void PollEvents (  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void OnActiveEvent ( SDL_ActiveEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnKeyDown ( SDL_KeyboardEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnKeyUp ( SDL_KeyboardEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnMouseMotion ( SDL_MouseMotionEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnMouseButtonDown ( SDL_MouseButtonEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnMouseButtonUp ( SDL_MouseButtonEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnVideoResize ( SDL_ResizeEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnQuit ( SDL_QuitEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnUserEvent ( SDL_UserEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void OnSysWMEvent ( SDL_SysWMEvent  sdlEvent  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
sdlEvent  (*** add description here ***)

void PushUserEvent ( int  code,
void *  pData1,
void *  pData2 
) [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

Member Data Documentation

bool m_Done [private]

(*** add brief description here ***)

regcom::common::Map* m_pMap [private]

(*** add brief description here ***)

gui::Desktop* m_pDesktop [private]

(*** add brief description here ***)

MapView* m_pMapView [private]

(*** add brief description here ***)

Console* m_pConsole [private]

(*** add brief description here ***)

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