guiInputCtrl.h
Engine/source/gui/utility/guiInputCtrl.h
Classes:
class
A control that locks the mouse and reports all keyboard input events to script.
Detailed Description
1 2//----------------------------------------------------------------------------- 3// Copyright (c) 2012 GarageGames, LLC 4// 5// Permission is hereby granted, free of charge, to any person obtaining a copy 6// of this software and associated documentation files (the "Software"), to 7// deal in the Software without restriction, including without limitation the 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 9// sell copies of the Software, and to permit persons to whom the Software is 10// furnished to do so, subject to the following conditions: 11// 12// The above copyright notice and this permission notice shall be included in 13// all copies or substantial portions of the Software. 14// 15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 21// IN THE SOFTWARE. 22//----------------------------------------------------------------------------- 23 24#ifndef _GUIINPUTCTRL_H_ 25#define _GUIINPUTCTRL_H_ 26 27#ifndef _GUIMOUSEEVENTCTRL_H_ 28 #include "gui/utility/guiMouseEventCtrl.h" 29#endif 30 31 32/// A control that locks the mouse and reports all keyboard input events 33/// to script. This is useful for implementing custom keyboard handling code. 34class GuiInputCtrl : public GuiMouseEventCtrl 35{ 36protected: 37 bool mSendAxisEvents; 38 bool mSendBreakEvents; 39 bool mSendModifierEvents; 40 41public: 42 43 typedef GuiMouseEventCtrl Parent; 44 45 GuiInputCtrl(); 46 47 // GuiControl. 48 virtual bool onWake(); 49 virtual void onSleep(); 50 51 virtual bool onInputEvent( const InputEventInfo &event ); 52 53 static void initPersistFields(); 54 55 DECLARE_CONOBJECT(GuiInputCtrl); 56 DECLARE_CATEGORY( "Gui Other Script" ); 57 DECLARE_DESCRIPTION( "A control that locks the mouse and reports all input events to script." ); 58 59 DECLARE_CALLBACK( void, onInputEvent, ( const char* device, const char* action, bool state )); 60 DECLARE_CALLBACK(void, onAxisEvent, (const char* device, const char* action, F32 axisValue)); 61}; 62 63#endif // _GUI_INPUTCTRL_H 64