deskflow::KeyMap::KeyItem Struct Reference

KeyID synthesis info. More...

#include <KeyMap.h>

Public Member Functions
bool	operator== (const KeyItem &) const

Public Attributes
KeyID	m_id {}
	KeyID.
int32_t	m_group {}
	Group for key.
KeyButton	m_button {}
	Button to generate KeyID.
KeyModifierMask	m_required {}
	Modifiers required for KeyID.
KeyModifierMask	m_sensitive {}
	Modifiers key is sensitive to.
KeyModifierMask	m_generates {}
	Modifiers key is mapped to.
bool	m_dead {}
	true if this is a dead KeyID
bool	m_lock {}
	true if this locks a modifier
uint32_t	m_client {}
	Client data.

Detailed Description

KeyID synthesis info.

This structure contains the information necessary to synthesize a keystroke that generates a KeyID (stored elsewhere). m_sensitive lists the modifiers that the key is affected by and must therefore be in the correct state, which is listed in m_required. If the key is mapped to a modifier, that modifier is in m_generates and is not in m_sensitive.

Member Function Documentation

operator==()

bool deskflow::KeyMap::KeyItem::operator==

(

const KeyItem &

x

)

const

Member Data Documentation

m_button

KeyButton deskflow::KeyMap::KeyItem::m_button {}

Button to generate KeyID.

m_client

uint32_t deskflow::KeyMap::KeyItem::m_client {}

Client data.

m_dead

bool deskflow::KeyMap::KeyItem::m_dead {}

true if this is a dead KeyID

m_generates

KeyModifierMask deskflow::KeyMap::KeyItem::m_generates {}

Modifiers key is mapped to.

m_group

int32_t deskflow::KeyMap::KeyItem::m_group {}

Group for key.

m_id

KeyID deskflow::KeyMap::KeyItem::m_id {}

KeyID.

m_lock

bool deskflow::KeyMap::KeyItem::m_lock {}

true if this locks a modifier

m_required

KeyModifierMask deskflow::KeyMap::KeyItem::m_required {}

Modifiers required for KeyID.

m_sensitive

KeyModifierMask deskflow::KeyMap::KeyItem::m_sensitive {}

Modifiers key is sensitive to.

---

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

• src/lib/deskflow/KeyMap.h
• src/lib/deskflow/KeyMap.cpp