propclass/input.h Source File (CEL: Crystal Entity Layer 2.0 Public API Reference)

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2001 by Jorrit Tyberghein
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __CEL_PF_INPUT__
00021 #define __CEL_PF_INPUT__
00022 
00023 #include "cstypes.h"
00024 #include "csutil/scf.h"
00025 
00029 enum celKeyState
00030 {
00031   CEL_KEY_STATE_UNUSED = -1,
00032   CEL_KEY_STATE_UP,
00033   CEL_KEY_STATE_DOWN,
00034   CEL_KEY_STATE_REPEAT
00035 };
00036 
00077 struct iPcCommandInput : public virtual iBase
00078 {
00079   SCF_INTERFACE (iPcCommandInput, 0, 2, 0);
00080 
00085   virtual void Activate (bool activate=true) = 0;
00086 
00093   virtual void SetSendTrigger (bool send) = 0;
00094 
00098   virtual bool IsSendTriggerEnabled () const = 0;
00099 
00109   virtual void SetCookedMode (bool cooked) = 0;
00110 
00115   virtual bool GetCookedMode () const = 0;
00116 
00121   virtual void ScreenCoordinates (bool screen=true) = 0;
00122 
00128   virtual float ScreenToCentered (float screencoord, float axis = 0) = 0;
00129 
00135   virtual float CenteredToScreen (float centeredcoord, float axis = 0) = 0;
00136 
00141   virtual bool LoadConfig (const char* prefix) = 0;
00142 
00147   virtual void SaveConfig (const char* prefix) = 0;
00148 
00153   virtual bool Bind (const char* triggername, const char* command) = 0;
00154 
00158   virtual const char* GetBind (const char* triggername) const = 0;
00159 
00164   virtual bool RemoveBind (const char* triggername, const char* command) = 0;
00165 
00169   virtual void RemoveAllBinds () = 0;
00170 
00174   virtual void EnableMouseEvents () = 0;
00175 
00179   virtual void DisableMouseEvents () = 0;
00180 
00184   virtual void EnableKeyboardEvents () = 0;
00185 
00189   virtual void DisableKeyboardEvents () = 0;
00190 
00194   virtual void EnableJoystickEvents () = 0;
00195 
00199   virtual void DisableJoystickEvents () = 0;
00200 };
00201 
00202 #endif // __CEL_PF_INPUT__
00203