GrayLib::cInputKeyPress Class Reference

#include <cInputKey.h>

Public Member Functions
	cInputKeyPress (const cInputKeyPress *pKeyBase) noexcept
	cInputKeyPress (INPUTKEY_TYPE tDevKey=INPUTKEY_NULL, INPKEYMASK_TYPE dwKeyMask=0) noexcept
void	InitKey () noexcept
bool	isKeySet () const noexcept
INPUTKEY_TYPE	get_DevKey () const noexcept
void	put_DevKey (INPUTKEY_TYPE tDevKey) noexcept
INPKEYMASK_TYPE	get_KeyMask () const noexcept
void	put_KeyMask (INPKEYMASK_TYPE dwKeyMask) noexcept
INPKEYCOMBO_t	get_SortValue () const noexcept
const GChar_t *	get_DevKeyName () const
	a text name for this key press. More...
cString	get_KeyBaseName () const

Static Public Member Functions
static INPKEYCOMBO_t	MakeSortKey (INPUTKEY_TYPE iDevKey, INPKEYMASK_TYPE dwKeyMask) noexcept

Detailed Description

A (meaningful) Key Press combo e.g. shift+A Can be sorted by HASHCODE_t INPKEYCOMBO_t Used as a base class to then activate some function on key press.

Constructor & Destructor Documentation

cInputKeyPress() [1/2]

GrayLib::cInputKeyPress::cInputKeyPress ( const cInputKeyPress *  pKeyBase )

inlinenoexcept

cInputKeyPress() [2/2]

GrayLib::cInputKeyPress::cInputKeyPress ( INPUTKEY_TYPE  tDevKey = INPUTKEY_NULL, INPKEYMASK_TYPE  dwKeyMask = 0  )

inlinenoexcept

Member Function Documentation

get_DevKey()

INPUTKEY_TYPE GrayLib::cInputKeyPress::get_DevKey ( ) const

inlinenoexcept

get_DevKeyName()

const GChar_t * GrayLib::cInputKeyPress::get_DevKeyName

(

)

const

a text name for this key press.

get_KeyBaseName()

cString GrayLib::cInputKeyPress::get_KeyBaseName

(

)

const

get_KeyMask()

INPKEYMASK_TYPE GrayLib::cInputKeyPress::get_KeyMask ( ) const

inlinenoexcept

get_SortValue()

INPKEYCOMBO_t GrayLib::cInputKeyPress::get_SortValue ( ) const

inlinenoexcept

Sort by key to make lookups fast.

InitKey()

void GrayLib::cInputKeyPress::InitKey ( )

inlinenoexcept

isKeySet()

bool GrayLib::cInputKeyPress::isKeySet ( ) const

inlinenoexcept

MakeSortKey()

static INPKEYCOMBO_t GrayLib::cInputKeyPress::MakeSortKey ( INPUTKEY_TYPE  iDevKey, INPKEYMASK_TYPE  dwKeyMask  )

inlinestaticnoexcept

put_DevKey()

void GrayLib::cInputKeyPress::put_DevKey ( INPUTKEY_TYPE  tDevKey )

inlinenoexcept

put_KeyMask()

void GrayLib::cInputKeyPress::put_KeyMask ( INPKEYMASK_TYPE  dwKeyMask )

inlinenoexcept

---

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

• c:/Dennis/Source/Gray/GrayLib/include/Input/cInputKey.h
• c:/Dennis/Source/Gray/GrayLib/src/Input/cInputKey.cpp