C4KeyCBEx< TargetClass, ParameterType > Class Template Reference

#include <C4KeyboardInput.h>

Inheritance diagram for C4KeyCBEx< TargetClass, ParameterType >:

Collaboration diagram for C4KeyCBEx< TargetClass, ParameterType >:

Public Types
typedef bool(TargetClass::*	CallbackFunc) (ParameterType par)

Public Member Functions
	C4KeyCBEx (TargetClass &rTarget, const ParameterType &par, CallbackFunc pFuncDown, CallbackFunc pFuncUp=nullptr, CallbackFunc pFuncPressed=nullptr, CallbackFunc pFuncMoved=nullptr)
void	Ref ()
void	Deref ()
bool	IsOriginalKey (const class C4CustomKey *pCheckKey) const

Public Attributes
class C4CustomKey *	pOriginalKey {nullptr}

Protected Member Functions
bool	OnKeyEvent (const C4KeyCodeEx &key, C4KeyEventType eEv) override
virtual bool	CheckCondition ()

Protected Attributes
TargetClass &	rTarget
CallbackFunc	pFuncDown
CallbackFunc	pFuncUp
CallbackFunc	pFuncPressed
CallbackFunc	pFuncMoved
ParameterType	par

Detailed Description

template<class TargetClass, class ParameterType>
class C4KeyCBEx< TargetClass, ParameterType >

Definition at line 355 of file C4KeyboardInput.h.

Member Typedef Documentation

CallbackFunc

template<class TargetClass , class ParameterType >

typedef bool(TargetClass::* C4KeyCBEx< TargetClass, ParameterType >::CallbackFunc) (ParameterType par)

Definition at line 358 of file C4KeyboardInput.h.

Constructor & Destructor Documentation

C4KeyCBEx()

template<class TargetClass , class ParameterType >

C4KeyCBEx< TargetClass, ParameterType >::C4KeyCBEx ( TargetClass &  rTarget, const ParameterType &  par, CallbackFunc  pFuncDown, CallbackFunc  pFuncUp = nullptr, CallbackFunc  pFuncPressed = nullptr, CallbackFunc  pFuncMoved = nullptr  )

inline

Definition at line 382 of file C4KeyboardInput.h.

            : rTarget(rTarget), pFuncDown(pFuncDown), pFuncUp(pFuncUp), pFuncPressed(pFuncPressed), pFuncMoved(pFuncMoved), par(par) {}

Member Function Documentation

CheckCondition()

template<class TargetClass , class ParameterType >

virtual bool C4KeyCBEx< TargetClass, ParameterType >::CheckCondition ( )

inlineprotectedvirtual

Reimplemented in C4GUI::DlgKeyCBEx< TargetClass, ParameterType >.

Definition at line 379 of file C4KeyboardInput.h.

{ return true; }

Referenced by C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent().

Here is the caller graph for this function:

Deref()

void C4KeyboardCallbackInterface::Deref ( )

inlineinherited

Definition at line 284 of file C4KeyboardInput.h.

{ if (!--iRef) delete this; }

Referenced by C4CustomKey::KillCallbacks().

Here is the caller graph for this function:

IsOriginalKey()

bool C4KeyboardCallbackInterface::IsOriginalKey ( const class C4CustomKey *  pCheckKey ) const

inlineinherited

Definition at line 289 of file C4KeyboardInput.h.

{ return pCheckKey == pOriginalKey; }

References C4KeyboardCallbackInterface::pOriginalKey.

OnKeyEvent()

template<class TargetClass , class ParameterType >

bool C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent ( const C4KeyCodeEx &  key, C4KeyEventType  eEv  )

inlineoverrideprotectedvirtual

Implements C4KeyboardCallbackInterface.

Definition at line 366 of file C4KeyboardInput.h.

    {
        if (!CheckCondition()) return false;
        switch (eEv)
        {
        case KEYEV_Down: return pFuncDown ? (rTarget.*pFuncDown)(par) : false;
        case KEYEV_Up: return pFuncUp ? (rTarget.*pFuncUp)(par) : false;
        case KEYEV_Pressed: return pFuncPressed ? (rTarget.*pFuncPressed)(par) : false;
        case KEYEV_Moved: return pFuncMoved ? (rTarget.*pFuncMoved)(par) : false;
        default: return false;
        }
    }

References C4KeyCBEx< TargetClass, ParameterType >::CheckCondition(), KEYEV_Down, KEYEV_Moved, KEYEV_Pressed, KEYEV_Up, C4KeyCBEx< TargetClass, ParameterType >::par, C4KeyCBEx< TargetClass, ParameterType >::pFuncDown, C4KeyCBEx< TargetClass, ParameterType >::pFuncMoved, C4KeyCBEx< TargetClass, ParameterType >::pFuncPressed, C4KeyCBEx< TargetClass, ParameterType >::pFuncUp, and C4KeyCBEx< TargetClass, ParameterType >::rTarget.

Here is the call graph for this function:

Ref()

void C4KeyboardCallbackInterface::Ref ( )

inlineinherited

Definition at line 283 of file C4KeyboardInput.h.

{ ++iRef; }

Referenced by C4CustomKey::C4CustomKey().

Here is the caller graph for this function:

Member Data Documentation

par

template<class TargetClass , class ParameterType >

ParameterType C4KeyCBEx< TargetClass, ParameterType >::par

protected

Definition at line 363 of file C4KeyboardInput.h.

Referenced by C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent().

pFuncDown

template<class TargetClass , class ParameterType >

CallbackFunc C4KeyCBEx< TargetClass, ParameterType >::pFuncDown

protected

Definition at line 362 of file C4KeyboardInput.h.

Referenced by C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent().

pFuncMoved

template<class TargetClass , class ParameterType >

CallbackFunc C4KeyCBEx< TargetClass, ParameterType >::pFuncMoved

protected

Definition at line 362 of file C4KeyboardInput.h.

Referenced by C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent().

pFuncPressed

template<class TargetClass , class ParameterType >

CallbackFunc C4KeyCBEx< TargetClass, ParameterType >::pFuncPressed

protected

Definition at line 362 of file C4KeyboardInput.h.

Referenced by C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent().

pFuncUp

template<class TargetClass , class ParameterType >

CallbackFunc C4KeyCBEx< TargetClass, ParameterType >::pFuncUp

protected

Definition at line 362 of file C4KeyboardInput.h.

Referenced by C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent().

pOriginalKey

class C4CustomKey* C4KeyboardCallbackInterface::pOriginalKey {nullptr}

inherited

Definition at line 275 of file C4KeyboardInput.h.

Referenced by C4CustomKey::C4CustomKey(), and C4KeyboardCallbackInterface::IsOriginalKey().

rTarget

template<class TargetClass , class ParameterType >

TargetClass& C4KeyCBEx< TargetClass, ParameterType >::rTarget

protected

Definition at line 361 of file C4KeyboardInput.h.

Referenced by C4GUI::DlgKeyCBEx< TargetClass, ParameterType >::CheckCondition(), and C4KeyCBEx< TargetClass, ParameterType >::OnKeyEvent().

---

The documentation for this class was generated from the following file:

• C4KeyboardInput.h