Public API Reference

csutil/event.h

Go to the documentation of this file.

/*
    Event system related helpers
    Copyright (C) 2003 by Jorrit Tyberghein
              (C) 2003 by Frank Richter
              (C) 2005 by Adam D. Bradley <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
  
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
  
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_CSUTIL_EVENT_H__
#define __CS_CSUTIL_EVENT_H__

#include "csextern.h"
#include "iutil/event.h"
#include "iutil/eventhandlers.h"

class CS_CRYSTALSPACE_EXPORT csKeyEventHelper
{
public:
  CS_PURE_METHOD static utf32_char GetRawCode (const iEvent* event);
  CS_PURE_METHOD static utf32_char GetCookedCode (const iEvent* event);
  static void GetModifiers (const iEvent* event, csKeyModifiers& modifiers);
  CS_PURE_METHOD static csKeyEventType GetEventType (const iEvent* event);
  CS_PURE_METHOD static bool GetAutoRepeat (const iEvent* event);
  CS_PURE_METHOD static csKeyCharType GetCharacterType (const iEvent* event);
  static bool GetEventData (const iEvent* event, csKeyEventData& data);
  CS_CONST_METHOD static uint32 GetModifiersBits (
    const csKeyModifiers& modifiers);
  CS_PURE_METHOD static uint32 GetModifiersBits (const iEvent* event);
  static void GetModifiers (uint32 mask, csKeyModifiers& modifiers);
};
/* forward declaration */
class csEvent;

class CS_CRYSTALSPACE_EXPORT csMouseEventHelper
{
public:

  static csEvent *NewEvent (csRef<iEventNameRegistry> &reg, 
    csTicks, csEventID name, csMouseEventType etype, int x, int y, 
    uint32 AxesChanged, uint button, bool buttonstate, uint32 buttonMask, 
    uint32 modifiers);
  static csEvent *NewEvent (csRef<iEventNameRegistry> &reg, csTicks, 
    csEventID name, uint8 n, csMouseEventType etype, int x, int y, 
    uint32 axesChanged, uint button, bool buttonstate, uint32 buttonMask, 
    uint32 modifiers);
  static csEvent *NewEvent (csRef<iEventNameRegistry> &reg, csTicks, 
    csEventID name, uint8 n, csMouseEventType etype, const int32 *axes, 
    uint8 numAxes, uint32 axesChanged, uint button, bool buttonstate, 
    uint32 buttonMask, uint32 modifiers);

  CS_PURE_METHOD static csMouseEventType GetEventType (const iEvent* event);
  CS_PURE_METHOD static uint GetNumber(const iEvent *event);
  CS_PURE_METHOD static int GetX(const iEvent *event)
  { return csMouseEventHelper::GetAxis(event, 0); }
  CS_PURE_METHOD static int GetY(const iEvent *event)
  { return csMouseEventHelper::GetAxis(event, 1); }
  CS_PURE_METHOD static int GetAxis(const iEvent *event, uint axis);
  CS_PURE_METHOD static uint GetNumAxes(const iEvent *event);
  CS_PURE_METHOD static uint GetButton(const iEvent *event);
  CS_PURE_METHOD static bool GetButtonState(const iEvent *event);
  CS_PURE_METHOD static uint32 GetButtonMask(const iEvent *event);
  CS_PURE_METHOD static void GetModifiers(const iEvent *event, 
    csKeyModifiers& modifiers) 
  { csKeyEventHelper::GetModifiers(event, modifiers); }
  CS_PURE_METHOD static uint32 GetModifiers(const iEvent *event) 
  { 
    csKeyModifiers modifiers; 
    csKeyEventHelper::GetModifiers(event, modifiers); 
    return csKeyEventHelper::GetModifiersBits(modifiers); 
  }
  static bool GetEventData (const iEvent* event, 
    csMouseEventData& data);
};

class CS_CRYSTALSPACE_EXPORT csJoystickEventHelper
{
public:

  static csEvent *NewEvent (csRef<iEventNameRegistry> &reg, csTicks, 
    csEventID name, int n, int x, int y, uint32 axesChanged, uint button, 
    bool buttonState, uint32 buttonMask, uint32 modifiers);
  static csEvent *NewEvent (csRef<iEventNameRegistry> &reg, csTicks, 
    csEventID name, int n, const int32* axes, uint8 numAxes, uint32 axesChanged, 
    uint button, bool buttonState, uint32 buttonMask, uint32 modifiers);

  CS_PURE_METHOD static uint GetNumber(const iEvent *event);
  CS_PURE_METHOD CS_DEPRECATED_METHOD static int GetX(const iEvent *event) 
  { return csJoystickEventHelper::GetAxis(event, 0); }
  CS_PURE_METHOD CS_DEPRECATED_METHOD static int GetY(const iEvent *event) 
  { return csJoystickEventHelper::GetAxis(event, 1); }
  CS_PURE_METHOD static int GetAxis(const iEvent *event, uint);
  CS_PURE_METHOD static uint GetNumAxes(const iEvent *);
  CS_PURE_METHOD static uint GetButton(const iEvent *event);
  CS_PURE_METHOD static bool GetButtonState(const iEvent *event);
  CS_PURE_METHOD static uint32 GetButtonMask(const iEvent *event);
  static void GetModifiers(const iEvent *event, csKeyModifiers& modifiers) 
  { csKeyEventHelper::GetModifiers(event, modifiers); }
  CS_PURE_METHOD static uint32 GetModifiers(const iEvent *event) 
  { 
    csKeyModifiers modifiers; 
    csKeyEventHelper::GetModifiers(event, modifiers); 
    return csKeyEventHelper::GetModifiersBits(modifiers); 
  }
  static bool GetEventData (const iEvent* event, csJoystickEventData& data);
};

class CS_CRYSTALSPACE_EXPORT csInputEventHelper
{
public:
  CS_PURE_METHOD static uint GetButton (iEventNameRegistry *,
        const iEvent *event);
  CS_PURE_METHOD static bool GetButtonState (iEventNameRegistry *,
        const iEvent *event);
};

class CS_CRYSTALSPACE_EXPORT csCommandEventHelper
{
public:
  static csEvent *NewEvent (csTicks, csEventID name, bool Broadcast, 
    intptr_t info = 0);

  CS_PURE_METHOD static uint GetCode(const iEvent *event);
  CS_PURE_METHOD static intptr_t GetInfo(const iEvent *event);
  static bool GetEventData (const iEvent* event, csCommandEventData& data);
};

struct iEventQueue;
struct iObjectRegistry;

namespace CS
{

csHandlerID CS_CRYSTALSPACE_EXPORT RegisterWeakListener (iEventQueue *q, 
  iEventHandler *listener, csRef<iEventHandler> &handler);
csHandlerID CS_CRYSTALSPACE_EXPORT RegisterWeakListener (iEventQueue *q, 
  iEventHandler *listener, const csEventID &ename, csRef<iEventHandler> &handler);
csHandlerID CS_CRYSTALSPACE_EXPORT RegisterWeakListener (iEventQueue *q, 
  iEventHandler *listener, const csEventID ename[], csRef<iEventHandler> &handler);

void CS_CRYSTALSPACE_EXPORT RemoveWeakListener (iEventQueue *q, 
  csRef<iEventHandler> &handler);

} // namespace CS
  
#endif // __CS_CSUTIL_EVENT_H__

---