C4GUI::DlgKeyCBEx< TargetClass, ParameterType > Class Template Reference

#include <C4Gui.h>

Inheritance diagram for C4GUI::DlgKeyCBEx< TargetClass, ParameterType >:

Collaboration diagram for C4GUI::DlgKeyCBEx< TargetClass, ParameterType >:

Public Member Functions
	DlgKeyCBEx (TargetClass &rTarget, const ParameterType &par, CallbackFunc pFuncDown, CallbackFunc pFuncUp=nullptr, CallbackFunc pFuncPressed=nullptr)
bool	CheckCondition () override
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

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

Detailed Description

template<class TargetClass, class ParameterType>
class C4GUI::DlgKeyCBEx< TargetClass, ParameterType >

Definition at line 2480 of file C4Gui.h.

Constructor & Destructor Documentation

DlgKeyCBEx()

template<class TargetClass , class ParameterType >

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

inline

Definition at line 2486 of file C4Gui.h.

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

Member Function Documentation

CheckCondition()

template<class TargetClass , class ParameterType >

bool C4GUI::DlgKeyCBEx< TargetClass, ParameterType >::CheckCondition ( )

inlineoverridevirtual

Reimplemented from C4KeyCBEx< TargetClass, ParameterType >.

Definition at line 2489 of file C4Gui.h.

{ return Base::rTarget.IsInActiveDlg(true) && Base::rTarget.IsVisible(); }

References C4KeyCBEx< TargetClass, ParameterType >::rTarget.

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  )

inlineoverrideprotectedvirtualinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

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:

• C4Gui.h