C4KeyBinding Class Reference

#include <C4KeyboardInput.h>

Inheritance diagram for C4KeyBinding:

Collaboration diagram for C4KeyBinding:

Public Member Functions
	C4KeyBinding (const C4KeyCodeEx &DefCode, const char *szName, C4KeyScope Scope, C4KeyboardCallbackInterface *pCallback, unsigned int uiPriority=PRIO_Base)
	C4KeyBinding (const CodeList &rDefCodes, const char *szName, C4KeyScope Scope, C4KeyboardCallbackInterface *pCallback, unsigned int uiPriority=PRIO_Base)
	~C4KeyBinding () override

Protected Types
enum	Priority {   PRIO_None = 0u , PRIO_Base = 1u , PRIO_Dlg = 2u , PRIO_Ctrl = 3u ,   PRIO_CtrlOverride = 4u , PRIO_FocusCtrl = 5u , PRIO_Context = 6u , PRIO_PlrControl = 7u ,   PRIO_MoreThanMax = 100u }
typedef std::vector< C4KeyCodeEx >	CodeList

Protected Member Functions
void	Ref ()
void	Deref ()
const CodeList &	GetCodes () const
const StdStrBuf &	GetName () const
C4KeyScope	GetScope () const
unsigned int	GetPriority () const
bool	IsCodeMatched (const C4KeyCodeEx &key) const
void	Update (const C4CustomKey *pByKey)
bool	Execute (C4KeyEventType eEv, C4KeyCodeEx key)
bool	IsDown () const
void	KillCallbacks (const C4CustomKey *pOfKey)
void	CompileFunc (StdCompiler *pComp)

Protected Attributes
CBVec	vecCallbacks
int	iRef

Detailed Description

Definition at line 476 of file C4KeyboardInput.h.

Member Typedef Documentation

CodeList

typedef std::vector<C4KeyCodeEx> C4CustomKey::CodeList

inherited

Definition at line 421 of file C4KeyboardInput.h.

Member Enumeration Documentation

Priority

enum C4CustomKey::Priority

inherited

Enumerator
PRIO_None
PRIO_Base
PRIO_Dlg
PRIO_Ctrl
PRIO_CtrlOverride
PRIO_FocusCtrl
PRIO_Context
PRIO_PlrControl
PRIO_MoreThanMax

Definition at line 433 of file C4KeyboardInput.h.

    {
        PRIO_None = 0u,
        PRIO_Base = 1u,
        PRIO_Dlg  = 2u,
        PRIO_Ctrl = 3u, // controls have higher priority than dialogs in GUI
        PRIO_CtrlOverride = 4u, // dialog handlings of keys that overwrite regular control handlings
        PRIO_FocusCtrl = 5u,  // controls override special dialog handling keys (e.g., RenameEdit)
        PRIO_Context = 6u, // context menus above controls
        PRIO_PlrControl = 7u, // player controls overwrite any other controls
        PRIO_MoreThanMax  = 100u // must be larger than otherwise largest used priority
    };

Constructor & Destructor Documentation

C4KeyBinding() [1/2]

C4KeyBinding::C4KeyBinding	(	const C4KeyCodeEx &	DefCode,
		const char *	szName,
		C4KeyScope	Scope,
		C4KeyboardCallbackInterface *	pCallback,
		unsigned int	uiPriority = PRIO_Base
	)

Definition at line 726 of file C4KeyboardInput.cpp.

        : C4CustomKey(DefCode, szName, Scope, pCallback, uiPriority)
{
    // self holds a ref
    Ref();
    // register into keyboard input class
    C4KeyboardInput_Init().RegisterKey(this);
}

References C4KeyboardInput_Init(), C4CustomKey::Ref(), and C4KeyboardInput::RegisterKey().

Here is the call graph for this function:

C4KeyBinding() [2/2]

C4KeyBinding::C4KeyBinding	(	const CodeList &	rDefCodes,
		const char *	szName,
		C4KeyScope	Scope,
		C4KeyboardCallbackInterface *	pCallback,
		unsigned int	uiPriority = PRIO_Base
	)

Definition at line 735 of file C4KeyboardInput.cpp.

        : C4CustomKey(rDefCodes, szName, Scope, pCallback, uiPriority)
{
    // self holds a ref
    Ref();
    // register into keyboard input class
    C4KeyboardInput_Init().RegisterKey(this);
}

References C4KeyboardInput_Init(), C4CustomKey::Ref(), and C4KeyboardInput::RegisterKey().

Here is the call graph for this function:

~C4KeyBinding()

C4KeyBinding::~C4KeyBinding ( )

override

Definition at line 744 of file C4KeyboardInput.cpp.

{
    // deregister from keyboard input class, if that class still exists
    if (C4KeyboardInput::IsValid)
        Game.KeyboardInput.UnregisterKeyBinding(this);
    // shouldn't be refed now
    assert(iRef==1);
    iRef = 0;
}

References Game, C4CustomKey::iRef, C4KeyboardInput::IsValid, C4Game::KeyboardInput, and C4KeyboardInput::UnregisterKeyBinding().

Here is the call graph for this function:

Member Function Documentation

CompileFunc()

void C4CustomKey::CompileFunc ( StdCompiler *  pComp )

inherited

Definition at line 705 of file C4KeyboardInput.cpp.

{
    pComp->Value(mkNamingAdapt(mkSTLContainerAdapt(Codes), Name.getData(), DefaultCodes));
}

References StdStrBuf::getData(), mkNamingAdapt(), mkSTLContainerAdapt(), and StdCompiler::Value().

Here is the call graph for this function:

Deref()

void C4CustomKey::Deref ( )

inlineinherited

Definition at line 457 of file C4KeyboardInput.h.

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

References C4CustomKey::iRef.

Referenced by C4KeyboardInput::RegisterKey(), and C4KeyboardInput::UnregisterKey().

Here is the caller graph for this function:

Execute()

bool C4CustomKey::Execute ( C4KeyEventType  eEv, C4KeyCodeEx  key  )

inherited

Definition at line 710 of file C4KeyboardInput.cpp.

{
    // remember down-state
    is_down = (eEv == KEYEV_Down);
    // execute all callbacks
    for (auto & callback : vecCallbacks)
        if (callback->OnKeyEvent(key, eEv))
            return true;
    // no event processed it
    return false;
}

References KEYEV_Down, and C4CustomKey::vecCallbacks.

Referenced by C4KeyboardInput::DoInput().

Here is the caller graph for this function:

GetCodes()

const CodeList& C4CustomKey::GetCodes ( ) const

inlineinherited

Definition at line 459 of file C4KeyboardInput.h.

{ return Codes.size() ? Codes : DefaultCodes; } // return assigned codes; default if no custom has been assigned

Referenced by C4KeyboardInput::GetKeyCodeNameByKeyName(), C4CustomKey::IsCodeMatched(), C4KeyboardInput::RegisterKey(), and C4KeyboardInput::UnregisterKey().

Here is the caller graph for this function:

GetName()

const StdStrBuf& C4CustomKey::GetName ( ) const

inlineinherited

Definition at line 460 of file C4KeyboardInput.h.

{ return Name; }

Referenced by C4CustomKey::C4CustomKey(), C4KeyboardInput::RegisterKey(), and C4KeyboardInput::UnregisterKeyBinding().

Here is the caller graph for this function:

GetPriority()

unsigned int C4CustomKey::GetPriority ( ) const

inlineinherited

Definition at line 462 of file C4KeyboardInput.h.

{ return uiPriority; }

Referenced by C4KeyboardInput::DoInput().

Here is the caller graph for this function:

GetScope()

C4KeyScope C4CustomKey::GetScope ( ) const

inlineinherited

Definition at line 461 of file C4KeyboardInput.h.

{ return Scope; }

Referenced by C4KeyboardInput::DoInput().

Here is the caller graph for this function:

IsCodeMatched()

bool C4CustomKey::IsCodeMatched ( const C4KeyCodeEx &  key ) const

inherited

Definition at line 668 of file C4KeyboardInput.cpp.

{
    const CodeList &codes = GetCodes();
    for (const auto &code : codes)
        if (code == key)
            return true;
    return false;
}

References C4CustomKey::GetCodes().

Referenced by C4KeyboardInput::DoInput().

Here is the call graph for this function:

Here is the caller graph for this function:

IsDown()

bool C4CustomKey::IsDown ( ) const

inlineinherited

Definition at line 468 of file C4KeyboardInput.h.

{ return is_down; }

Referenced by C4KeyboardInput::DoInput().

Here is the caller graph for this function:

KillCallbacks()

void C4CustomKey::KillCallbacks ( const C4CustomKey *  pOfKey )

inherited

Definition at line 693 of file C4KeyboardInput.cpp.

{
    // remove all instances from list
    CBVec::iterator i;
    while ((i = std::find_if(vecCallbacks.begin(), vecCallbacks.end(), [pOfKey](CBVec::value_type pIntfc) { return pIntfc->IsOriginalKey(pOfKey); })) != vecCallbacks.end())
    {
        C4KeyboardCallbackInterface *pItfc = *i;
        vecCallbacks.erase(i);
        pItfc->Deref();
    }
}

References C4KeyboardCallbackInterface::Deref(), and C4CustomKey::vecCallbacks.

Referenced by C4KeyboardInput::UnregisterKeyBinding().

Here is the call graph for this function:

Here is the caller graph for this function:

Ref()

void C4CustomKey::Ref ( )

inlineinherited

Definition at line 456 of file C4KeyboardInput.h.

{ ++iRef; }

References C4CustomKey::iRef.

Referenced by C4KeyBinding(), and C4KeyboardInput::RegisterKey().

Here is the caller graph for this function:

Update()

void C4CustomKey::Update ( const C4CustomKey *  pByKey )

inherited

Definition at line 677 of file C4KeyboardInput.cpp.

{
    assert(pByKey);
    assert(Name == pByKey->Name);
    // transfer any assigned data, except name which should be equal anyway
    if (pByKey->DefaultCodes.size()) DefaultCodes = pByKey->DefaultCodes;
    if (pByKey->Codes.size()) Codes = pByKey->Codes;
    if (pByKey->Scope != KEYSCOPE_None) Scope = pByKey->Scope;
    if (pByKey->uiPriority != PRIO_None) uiPriority = pByKey->uiPriority;
    for (auto callback : pByKey->vecCallbacks)
    {
        callback->Ref();
        vecCallbacks.push_back(callback);
    }
}

References KEYSCOPE_None, C4CustomKey::PRIO_None, and C4CustomKey::vecCallbacks.

Referenced by C4KeyboardInput::RegisterKey().

Here is the caller graph for this function:

Member Data Documentation

iRef

int C4CustomKey::iRef

protectedinherited

Definition at line 447 of file C4KeyboardInput.h.

Referenced by C4CustomKey::Deref(), C4CustomKey::Ref(), and ~C4KeyBinding().

vecCallbacks

CBVec C4CustomKey::vecCallbacks

inherited

Definition at line 431 of file C4KeyboardInput.h.

Referenced by C4CustomKey::C4CustomKey(), C4CustomKey::Execute(), C4CustomKey::KillCallbacks(), C4CustomKey::Update(), and C4CustomKey::~C4CustomKey().

---

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

• C4KeyboardInput.h
• C4KeyboardInput.cpp