From 98ba22e7064db57316dfff1ae127feb3dceeb73e Mon Sep 17 00:00:00 2001 From: Justin Worthe Date: Thu, 31 Jul 2014 13:58:22 +0200 Subject: Initial commit --- docs/html/class_allegro_keyboard_init.html | 247 +++++++++++++++++++++++++++++ 1 file changed, 247 insertions(+) create mode 100644 docs/html/class_allegro_keyboard_init.html (limited to 'docs/html/class_allegro_keyboard_init.html') diff --git a/docs/html/class_allegro_keyboard_init.html b/docs/html/class_allegro_keyboard_init.html new file mode 100644 index 0000000..da380c1 --- /dev/null +++ b/docs/html/class_allegro_keyboard_init.html @@ -0,0 +1,247 @@ + + + + +Rally X: AllegroKeyboardInit Class Reference + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + +
+
Rally X + +
+
ELEN3009 Project by Justin Wernick and David Schneider
+
+
+ + + + + +
+
+
+Public Member Functions | +Private Attributes | +Static Private Attributes
+
+
AllegroKeyboardInit Class Reference
+
+
+ +

Class ensures that Allegro's keyboard is installed and uninstalled when appropriate. + More...

+ +

#include <AllegroWrappers.h>

+ +

List of all members.

+ + + + + + + + + + + + + + +

+Public Member Functions

 AllegroKeyboardInit ()
 Constructor calls al_install_keyboard() if it is the first instance.
 AllegroKeyboardInit (const AllegroKeyboardInit &ref)
 Copy constructor, implemented to be included in instance count.
 ~AllegroKeyboardInit ()
 Destructor calls al_uninstall_keyboard() if it is the last instant.

+Private Attributes

AllegroInit _allegro
 Depends on Allegro being initialised.

+Static Private Attributes

static int _initCount = 0
 Count of the current number of initialised AllegroKeyboardInit objects.
+

Detailed Description

+

Class ensures that Allegro's keyboard is installed and uninstalled when appropriate.

+

Any classes that use the keyboard for input should include this class as a data member. This class includes AllegroInit, so both of them do not need to be included.

+
Author:
Justin Wernick
+
+David Schneider
+ +

Definition at line 57 of file AllegroWrappers.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
AllegroKeyboardInit::AllegroKeyboardInit ()
+
+
+ +

Constructor calls al_install_keyboard() if it is the first instance.

+ +

Definition at line 41 of file AllegroWrappers.cpp.

+ +
+
+ +
+
+ + + + + + + + +
AllegroKeyboardInit::AllegroKeyboardInit (const AllegroKeyboardInit & ref)
+
+
+ +

Copy constructor, implemented to be included in instance count.

+ +

Definition at line 53 of file AllegroWrappers.cpp.

+ +
+
+ +
+
+ + + + + + + +
AllegroKeyboardInit::~AllegroKeyboardInit ()
+
+
+ +

Destructor calls al_uninstall_keyboard() if it is the last instant.

+ +

Definition at line 65 of file AllegroWrappers.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
AllegroInit AllegroKeyboardInit::_allegro [private]
+
+
+ +

Depends on Allegro being initialised.

+ +

Definition at line 74 of file AllegroWrappers.h.

+ +
+
+ +
+
+ + + + +
int AllegroKeyboardInit::_initCount = 0 [static, private]
+
+
+ +

Count of the current number of initialised AllegroKeyboardInit objects.

+ +

Definition at line 73 of file AllegroWrappers.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Classes Files Functions Variables Typedefs Enumerations Enumerator
+ + +
+ +
+ + + +
+Generated on Wed Oct 5 2011 20:08:31 for Rally X by   +doxygen + 1.7.5.1 +
+ + + -- cgit v1.2.3