C4CustomKey Class Reference

#include <C4KeyboardInput.h>

Inheritance diagram for C4CustomKey:

Public 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

Public Member Functions
	C4CustomKey (const C4CustomKey &rCpy, bool fCopyCallbacks)
virtual	~C4CustomKey ()
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)

Public Attributes
CBVec	vecCallbacks

Protected Member Functions
	C4CustomKey (const C4KeyCodeEx &DefCode, const char *szName, C4KeyScope Scope, C4KeyboardCallbackInterface *pCallback, unsigned int uiPriority=PRIO_Base)
	C4CustomKey (CodeList rDefCodes, const char *szName, C4KeyScope Scope, C4KeyboardCallbackInterface *pCallback, unsigned int uiPriority=PRIO_Base)

Protected Attributes
int	iRef

Friends
class	C4Game

Detailed Description

Definition at line 418 of file C4KeyboardInput.h.

Member Typedef Documentation

CodeList

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

Definition at line 421 of file C4KeyboardInput.h.

Member Enumeration Documentation

Priority

enum C4CustomKey::Priority

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

C4CustomKey() [1/3]

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

protected

Definition at line 619 of file C4KeyboardInput.cpp.

        : Scope(Scope), Name(), uiPriority(uiPriority), iRef(0), is_down(false)
{
    // generate code
    if (DefCode.Key != KEY_Default) DefaultCodes.push_back(DefCode);
    // ctor for default key
    Name.Copy(szName);
    if (pCallback)
    {
        pCallback->Ref();
        vecCallbacks.push_back(pCallback);
        pCallback->pOriginalKey = this;
    }
}

References StdStrBuf::Copy(), C4KeyCodeEx::Key, KEY_Default, C4KeyboardCallbackInterface::pOriginalKey, C4KeyboardCallbackInterface::Ref(), and vecCallbacks.

Here is the call graph for this function:

C4CustomKey() [2/3]

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

protected

Definition at line 634 of file C4KeyboardInput.cpp.

        : DefaultCodes(std::move(rDefCodes)), Scope(Scope), Name(), uiPriority(uiPriority), iRef(0), is_down(false)
{
    // ctor for default key
    Name.Copy(szName);
    if (pCallback)
    {
        pCallback->Ref();
        vecCallbacks.push_back(pCallback);
        pCallback->pOriginalKey = this;
    }
}

References StdStrBuf::Copy(), C4KeyboardCallbackInterface::pOriginalKey, C4KeyboardCallbackInterface::Ref(), and vecCallbacks.

Here is the call graph for this function:

C4CustomKey() [3/3]

C4CustomKey::C4CustomKey	(	const C4CustomKey &	rCpy,
		bool	fCopyCallbacks
	)

Definition at line 647 of file C4KeyboardInput.cpp.

        : Codes(rCpy.Codes), DefaultCodes(rCpy.DefaultCodes), Scope(rCpy.Scope), Name(), uiPriority(rCpy.uiPriority), iRef(0), is_down(false)
{
    Name.Copy(rCpy.GetName());
    if (fCopyCallbacks)
    {
        for (auto callback : rCpy.vecCallbacks)
        {
            callback->Ref();
            vecCallbacks.push_back(callback);
        }
    }
}

References StdStrBuf::Copy(), GetName(), and vecCallbacks.

Here is the call graph for this function:

~C4CustomKey()

C4CustomKey::~C4CustomKey ( )

virtual

Definition at line 661 of file C4KeyboardInput.cpp.

{
    // free callback handles
    for (CBVec::const_iterator i = vecCallbacks.begin(); i != vecCallbacks.end(); ++i)
        (*i)->Deref();
}

References vecCallbacks.

Member Function Documentation

CompileFunc()

void C4CustomKey::CompileFunc

(

StdCompiler *

pComp

)

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 ( )

inline

Definition at line 457 of file C4KeyboardInput.h.

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

References iRef.

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

Here is the caller graph for this function:

Execute()

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

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 vecCallbacks.

Referenced by C4KeyboardInput::DoInput().

Here is the caller graph for this function:

GetCodes()

const CodeList& C4CustomKey::GetCodes ( ) const

inline

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(), IsCodeMatched(), C4KeyboardInput::RegisterKey(), and C4KeyboardInput::UnregisterKey().

Here is the caller graph for this function:

GetName()

const StdStrBuf& C4CustomKey::GetName ( ) const

inline

Definition at line 460 of file C4KeyboardInput.h.

{ return Name; }

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

Here is the caller graph for this function:

GetPriority()

unsigned int C4CustomKey::GetPriority ( ) const

inline

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

inline

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

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 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

inline

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

)

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 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 ( )

inline

Definition at line 456 of file C4KeyboardInput.h.

{ ++iRef; }

References iRef.

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

Here is the caller graph for this function:

Update()

void C4CustomKey::Update

(

const C4CustomKey *

pByKey

)

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, PRIO_None, and vecCallbacks.

Referenced by C4KeyboardInput::RegisterKey().

Here is the caller graph for this function:

Friends And Related Function Documentation

C4Game

friend class C4Game

friend

Definition at line 450 of file C4KeyboardInput.h.

Member Data Documentation

iRef

int C4CustomKey::iRef

protected

Definition at line 447 of file C4KeyboardInput.h.

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

vecCallbacks

CBVec C4CustomKey::vecCallbacks

Definition at line 431 of file C4KeyboardInput.h.

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

---

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

• C4KeyboardInput.h
• C4KeyboardInput.cpp