C4GUI::DlgKeyCB< TargetClass > Class Template Reference

#include <C4Gui.h>

Inheritance diagram for C4GUI::DlgKeyCB< TargetClass >:

Collaboration diagram for C4GUI::DlgKeyCB< TargetClass >:

Public Member Functions
	DlgKeyCB (TargetClass &rTarget, 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

Detailed Description

template<class TargetClass>
class C4GUI::DlgKeyCB< TargetClass >

Definition at line 2456 of file C4Gui.h.

Constructor & Destructor Documentation

DlgKeyCB()

template<class TargetClass >

C4GUI::DlgKeyCB< TargetClass >::DlgKeyCB ( TargetClass &  rTarget, CallbackFunc  pFuncDown, CallbackFunc  pFuncUp = nullptr, CallbackFunc  pFuncPressed = nullptr  )

inline

Definition at line 2462 of file C4Gui.h.

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

Member Function Documentation

CheckCondition()

template<class TargetClass >

bool C4GUI::DlgKeyCB< TargetClass >::CheckCondition ( )

inlineoverridevirtual

Reimplemented from C4KeyCB< TargetClass >.

Definition at line 2465 of file C4Gui.h.

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

References C4KeyCB< TargetClass >::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 >

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

inlineoverrideprotectedvirtualinherited

Implements C4KeyboardCallbackInterface.

Definition at line 303 of file C4KeyboardInput.h.

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

References C4KeyCB< TargetClass >::CheckCondition(), KEYEV_Down, KEYEV_Moved, KEYEV_Pressed, KEYEV_Up, C4KeyCB< TargetClass >::pFuncDown, C4KeyCB< TargetClass >::pFuncMoved, C4KeyCB< TargetClass >::pFuncPressed, C4KeyCB< TargetClass >::pFuncUp, and C4KeyCB< TargetClass >::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

pFuncDown

template<class TargetClass >

CallbackFunc C4KeyCB< TargetClass >::pFuncDown

protectedinherited

Definition at line 300 of file C4KeyboardInput.h.

Referenced by C4KeyCB< TargetClass >::OnKeyEvent().

pFuncMoved

template<class TargetClass >

CallbackFunc C4KeyCB< TargetClass >::pFuncMoved

protectedinherited

Definition at line 300 of file C4KeyboardInput.h.

Referenced by C4KeyCB< TargetClass >::OnKeyEvent().

pFuncPressed

template<class TargetClass >

CallbackFunc C4KeyCB< TargetClass >::pFuncPressed

protectedinherited

Definition at line 300 of file C4KeyboardInput.h.

Referenced by C4KeyCB< TargetClass >::OnKeyEvent().

pFuncUp

template<class TargetClass >

CallbackFunc C4KeyCB< TargetClass >::pFuncUp

protectedinherited

Definition at line 300 of file C4KeyboardInput.h.

Referenced by C4KeyCB< TargetClass >::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 >

TargetClass& C4KeyCB< TargetClass >::rTarget

protectedinherited

Definition at line 299 of file C4KeyboardInput.h.

Referenced by C4GUI::DlgKeyCB< TargetClass >::CheckCondition(), C4GUI::ControlKeyCB< TargetClass >::CheckCondition(), and C4KeyCB< TargetClass >::OnKeyEvent().

---

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

• C4Gui.h