[Crystal-cvs] SF.net SVN: crystal: [28014] CS/trunk/docs

[<dar...@us...>]

Revision: 28014
          http://crystal.svn.sourceforge.net/crystal/?rev=28014&view=rev
Author:   darekdawidowski
Date:     2007-10-25 16:42:04 -0700 (Thu, 25 Oct 2007)

Log Message:
-----------
Bindings docs.

Modified Paths:
--------------
    CS/trunk/docs/history.txt
    CS/trunk/docs/texinfo/usingcs/events/chapter.txi
    CS/trunk/docs/texinfo/usingcs/events/framephases.txi

Added Paths:
-----------
    CS/trunk/docs/texinfo/usingcs/events/bindings.txi

Modified: CS/trunk/docs/history.txt
===================================================================
--- CS/trunk/docs/history.txt	2007-10-25 17:24:40 UTC (rev 28013)
+++ CS/trunk/docs/history.txt	2007-10-25 23:42:04 UTC (rev 28014)
@@ -6,6 +6,8 @@
 individual changes for each given day, however, are in normal (ascending)
 chronological order.
 
+26-Oct-2007
+	- Darek added bindings to the documentation.
 25-Oct-2007
 	- caedes added a bunch of const_cast to cspython to account for 
 	  incorrect prototypes in python 2.4 functions (which would lead to

Added: CS/trunk/docs/texinfo/usingcs/events/bindings.txi
===================================================================
--- CS/trunk/docs/texinfo/usingcs/events/bindings.txi	                        (rev 0)
+++ CS/trunk/docs/texinfo/usingcs/events/bindings.txi	2007-10-25 23:42:04 UTC (rev 28014)
@@ -0,0 +1,98 @@
+@c -*-texinfo-*-
+@node Event Bindings, , Frame phase events, Event System
+@subsection Bindings
+@cindex Events, Bindings
+
+@subsubheading Syntax for keys in 'cooked' mode
+
+@example
+[[modifier]+|-<key>
+
+Example:
+Shift+Up
+Shift-Up
+Note: + - is the same thing
+@end example
+
+@subsubheading Keys
+
+@example
+a .. z
+0 .. 9
+Insert | Ins
+Delete | Del
+Home
+End
+PgUp
+PgDn
+Up
+Down
+Left
+Right
+Enter | Return
+Backspace | Back
+Tab
+Space
+F1 .. F12
+Print | PrintScrn
+Pause
+PadPlus
+PadMinus
+PadMult
+PadDiv
+Pad0
+Pad1
+Pad2
+Pad3
+Pad4
+Pad5 | Center
+Pad6
+Pad7
+Pad8
+Pad9
+PadDecimal
+PadEnter
+Plus
+Minus
+@end example
+
+@subsubheading Key modifiers
+
+@example
+Shift
+LShift
+RShift
+Alt
+LAlt
+RAlt
+Ctrl
+LCtrl
+RCtrl
+Num
+Scroll
+Caps
+@end example
+
+@subsubheading Syntax for Mouse
+
+@example
+[[mouse number]Mouse<Axis|Button><number>
+
+Example:
+MouseAxis0
+0MouseAxis0
+1MouseButton1
+Note: first and second examples are the same 0 is default
+@end example
+
+@subsubheadingSyntax for Joystick
+
+@example
+[[joy number]Joystick<Axis|Button><number>
+
+Example:
+JoystickAxis0
+0JoystickAxis0
+1JoystickButton1
+Note: first and second examples are the same 0 is default
+@end example

Modified: CS/trunk/docs/texinfo/usingcs/events/chapter.txi
===================================================================
--- CS/trunk/docs/texinfo/usingcs/events/chapter.txi	2007-10-25 17:24:40 UTC (rev 28013)
+++ CS/trunk/docs/texinfo/usingcs/events/chapter.txi	2007-10-25 23:42:04 UTC (rev 28014)
@@ -15,9 +15,11 @@
 * Event Scheduling:: Scheduling
 * Event Subscription:: Subscription
 * Frame phase events::
+* Event Bindings:: Bindings
 @end menu
 
 @importss{usingcs,events,names.txi}
 @importss{usingcs,events,scheduling.txi}
 @importss{usingcs,events,subscription.txi}
 @importss{usingcs,events,framephases.txi}
+@importss{usingcs,events,bindings.txi}

Modified: CS/trunk/docs/texinfo/usingcs/events/framephases.txi
===================================================================
--- CS/trunk/docs/texinfo/usingcs/events/framephases.txi	2007-10-25 17:24:40 UTC (rev 28013)
+++ CS/trunk/docs/texinfo/usingcs/events/framephases.txi	2007-10-25 23:42:04 UTC (rev 28014)
@@ -1,36 +1,36 @@
 @c -*-texinfo-*-
-@node Frame phase events, , Event Subscription, Event System
+@node Frame phase events, Event Bindings, Event Subscription, Event System
 @subsection Frame phase events
 @cindex Events, Frame phases
 
 To handle events during different points of frame processing, handlers of
-@samp{csevFrame} can use simple helper macros to classify themselves as 
+@samp{csevFrame} can use simple helper macros to classify themselves as
 belonging to any of six ``phases'' of frame creation.
 
 @itemize @bullet
-@item 
+@item
 @emph{Logic} - game logic to be performed before any rendering is done.
 Use the @samp{CS_EVENTHANDLER_PHASE_LOGIC(x)} macro.
-@item 
+@item
 @emph{3D} - rendering of the 3D view, after the logic phase and before
 the 2D phase.  Use the @samp{CS_EVENTHANDLER_PHASE_3D(x)} macro.
-@item 
+@item
 @emph{2D} - rendering of 2D overlays; after the 3D phase and before
 the console phase.  Use the @samp{CS_EVENTHANDLER_PHASE_2D(x)} macro.
-@item 
+@item
 @emph{Console} - used primarily by the Crystal Entity Layer
 (@sc{cel}), after the 2D phase and before the Debug phase.  Use the
 @samp{CS_EVENTHANDLER_PHASE_CONSOLE(x)} macro.
-@item 
+@item
 @emph{Debug} - used primarily by the @samp{bugplug} plugin, after the
 console phase and before the frame phase.  Use the
 @samp{CS_EVENTHANDLER_PHASE_DEBUG(x)} macro.
-@item 
+@item
 @emph{Frame} - final rendering to the screen, after the debug phase.
 Use the @samp{CS_EVENTHANDLER_PHASE_FRAME(x)} macro.
 @end itemize
 
-These macros, included in the declaration of an event handler class, 
+These macros, included in the declaration of an event handler class,
 provide all of the naming and constraint methods to make instances of
 that handler class schedule their subscriptions to @samp{csevFrame}
 within the appropriate phase.  (You will not be able to use these macros


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.