core/vgui/vgui_event.h File Reference

vgui_event class encapsulates the events handled by the vgui system. More...

#include <vcl_string.h>
#include <vcl_iosfwd.h>
#include <vgui/vgui_key.h>
#include <vgui/vgui_button.h>
#include <vgui/vgui_modifier.h>

Go to the source code of this file.

Classes
class	vgui_event
	The vgui_event class encapsulates the events handled by the vgui system. More...
Enumerations
enum	vgui_event_type {   vgui_EVENT_NULL = 0, vgui_ENTER, vgui_LEAVE, vgui_BUTTON_DOWN,   vgui_MOUSE_DOWN = vgui_BUTTON_DOWN, vgui_MOUSE_PRESS = vgui_BUTTON_DOWN, vgui_BUTTON_UP, vgui_MOUSE_UP = vgui_BUTTON_UP,   vgui_MOUSE_RELEASE = vgui_BUTTON_UP, vgui_MOTION, vgui_MOUSE_MOTION = vgui_MOTION, vgui_KEY_PRESS,   vgui_KEY_DOWN = vgui_KEY_PRESS, vgui_KEY_RELEASE, vgui_KEY_UP = vgui_KEY_RELEASE, vgui_RESHAPE,   vgui_TIMER, vgui_DRAW, vgui_DRAW_OVERLAY, vgui_OVERLAY_DRAW = vgui_DRAW_OVERLAY,   vgui_STRING, vgui_HSCROLL, vgui_VSCROLL, vgui_DESTROY,   vgui_IDLE, vgui_OTHER, vgui_FOCUSGAINED, vgui_FOCUSLOST,   vgui_WHEEL_UP, vgui_WHEEL_DOWN, vgui_EVENT_MAX }
Functions
vcl_ostream &	operator<< (vcl_ostream &s, vgui_event_type e)
bool	operator== (vgui_event const &a, vgui_event const &b)
	Returns true if events are the same.
vcl_ostream &	operator<< (vcl_ostream &, vgui_event const &)

---

Detailed Description

vgui_event class encapsulates the events handled by the vgui system.

Author:

Philip C. Pritchett, Robotics Research Group, University of Oxford

Date:

11 Sep 99

    Modifications
     16-Sep-1999  fsm. various.
      5-Oct-1999  fsm. replaced (x,y) by (wx,wy) and (ux,uy).
     10-Oct-1999  pcp         added timestamp
     20-Oct-1999  awf         Changed timestamp to int.
     19-Oct-1999  fsm. added pointer to adaptor.
      1-Nov-1999  fsm. events now use viewport, not window coordinates.
     28-Nov-1999  fsm. added vcl_string event.
     22-Aug-2000  Marko Bacic. added support for scroll bar events
     04-Oct-2002  K.Y.McGaul - Added set_key() to make sure vgui_key is now
                               always lower case to save confusion.
                             - Added ascii_char value to vgui_event.
   

Definition in file vgui_event.h.

---

Enumeration Type Documentation

enum vgui_event_type

Enumerator:

vgui_EVENT_NULL
vgui_ENTER
vgui_LEAVE
vgui_BUTTON_DOWN
vgui_MOUSE_DOWN
vgui_MOUSE_PRESS
vgui_BUTTON_UP
vgui_MOUSE_UP
vgui_MOUSE_RELEASE
vgui_MOTION
vgui_MOUSE_MOTION
vgui_KEY_PRESS
vgui_KEY_DOWN
vgui_KEY_RELEASE
vgui_KEY_UP
vgui_RESHAPE
vgui_TIMER
vgui_DRAW
vgui_DRAW_OVERLAY
vgui_OVERLAY_DRAW
vgui_STRING
vgui_HSCROLL
vgui_VSCROLL
vgui_DESTROY
vgui_IDLE
vgui_OTHER
vgui_FOCUSGAINED
vgui_FOCUSLOST
vgui_WHEEL_UP
vgui_WHEEL_DOWN
vgui_EVENT_MAX

Definition at line 35 of file vgui_event.h.

---

Function Documentation

vcl_ostream& operator<<	(	vcl_ostream &	s,
		vgui_event_type	e
	)

Definition at line 125 of file vgui_event.cxx.

vcl_ostream& operator<<	(	vcl_ostream &	,
		vgui_event const &
	)

Definition at line 134 of file vgui_event.cxx.

bool operator==	(	vgui_event const &	a,
		vgui_event const &	b
	)

Returns true if events are the same.

Isn't this what the compiler would have generated anyway? moreover, the compiler-generated one wouldn't need to be updated when the fields are changed. fsm.

Definition at line 152 of file vgui_event.cxx.