GHOST_ModifierKeys Struct Reference

#include <GHOST_ModifierKeys.h>

List of all members.

Public Member Functions
	GHOST_ModifierKeys ()
virtual	~GHOST_ModifierKeys ()
virtual bool	get (GHOST_TModifierKeyMask mask) const
virtual void	set (GHOST_TModifierKeyMask mask, bool down)
virtual void	clear ()
virtual bool	equals (const GHOST_ModifierKeys &keys) const
Static Public Member Functions
static GHOST_TKey	getModifierKeyCode (GHOST_TModifierKeyMask mask)
Public Attributes
GHOST_TUns8	m_LeftShift: 1
GHOST_TUns8	m_RightShift: 1
GHOST_TUns8	m_LeftAlt: 1
GHOST_TUns8	m_RightAlt: 1
GHOST_TUns8	m_LeftControl: 1
GHOST_TUns8	m_RightControl: 1
GHOST_TUns8	m_OS: 1

---

Detailed Description

Stores the state of modifier keys. Discriminates between left and right modifier keys.

Author:

Maarten Gribnau

Date:

May 17, 2001

Definition at line 44 of file GHOST_ModifierKeys.h.

---

Constructor & Destructor Documentation

GHOST_ModifierKeys::GHOST_ModifierKeys

(

)

Constructor.

Copyright (C) 2001 NaN Technologies B.V.

Author:

Maarten Gribnau

Date:

May 31, 2001

Definition at line 43 of file GHOST_ModifierKeys.cpp.

References clear().

GHOST_ModifierKeys::~GHOST_ModifierKeys

(

)

[virtual]

Definition at line 48 of file GHOST_ModifierKeys.cpp.

---

Member Function Documentation

void GHOST_ModifierKeys::clear

(

)

[virtual]

Sets the state of all modifier keys to up.

Definition at line 117 of file GHOST_ModifierKeys.cpp.

References m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, and m_RightShift.

Referenced by GHOST_ModifierKeys(), and GHOST_SystemWin32::s_wndProc().

bool GHOST_ModifierKeys::equals

(

const GHOST_ModifierKeys &

keys

)

const [virtual]

Determines whether to modifier key states are equal.

Parameters:

keys.

The modifier key state to compare to.

Returns:

Indication of equality.

Definition at line 129 of file GHOST_ModifierKeys.cpp.

References m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, and m_RightShift.

bool GHOST_ModifierKeys::get

(

GHOST_TModifierKeyMask

mask

)

const [virtual]

Returns the state of a single modifier key.

Parameters:

mask.

Key state to return.

Returns:

The state of the key (pressed == true).

Definition at line 71 of file GHOST_ModifierKeys.cpp.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightShift, m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, and m_RightShift.

Referenced by GHOST_System::getModifierKeyState(), and GHOST_SystemWin32::hardKey().

GHOST_TKey GHOST_ModifierKeys::getModifierKeyCode

(

GHOST_TModifierKeyMask

mask

)

[static]

Returns the modifier key's key code from a modifier key mask.

Parameters:

mask	The mask of the modifier key.

Returns:

The modifier key's key code.

Definition at line 51 of file GHOST_ModifierKeys.cpp.

References GHOST_kKeyLeftAlt, GHOST_kKeyLeftControl, GHOST_kKeyLeftShift, GHOST_kKeyOS, GHOST_kKeyRightAlt, GHOST_kKeyRightControl, GHOST_kKeyRightShift, GHOST_kKeyUnknown, GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, and GHOST_kModifierKeyRightShift.

void GHOST_ModifierKeys::set	(	GHOST_TModifierKeyMask	mask,
		bool	down
	)		[virtual]

Updates the state of a single modifier key.

Parameters:

mask.	Key state to update.
down.	The new state of the key.

Definition at line 94 of file GHOST_ModifierKeys.cpp.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightShift, m_LeftAlt, m_LeftControl, m_LeftShift, m_OS, m_RightAlt, m_RightControl, and m_RightShift.

Referenced by GHOST_SystemX11::getModifierKeys(), GHOST_SystemWin32::getModifierKeys(), GHOST_SystemSDL::getModifierKeys(), GHOST_SystemCocoa::getModifierKeys(), GHOST_SystemCarbon::getModifierKeys(), and GHOST_SystemWin32::hardKey().

---

Member Data Documentation

GHOST_TUns8 GHOST_ModifierKeys::m_LeftAlt

Bitfield that stores the appropriate key state.

Definition at line 92 of file GHOST_ModifierKeys.h.

Referenced by clear(), equals(), get(), and set().

GHOST_TUns8 GHOST_ModifierKeys::m_LeftControl

Bitfield that stores the appropriate key state.

Definition at line 96 of file GHOST_ModifierKeys.h.

Referenced by clear(), equals(), get(), and set().

GHOST_TUns8 GHOST_ModifierKeys::m_LeftShift

Bitfield that stores the appropriate key state.

Definition at line 88 of file GHOST_ModifierKeys.h.

Referenced by clear(), equals(), get(), and set().

GHOST_TUns8 GHOST_ModifierKeys::m_OS

Bitfield that stores the appropriate key state.

Definition at line 100 of file GHOST_ModifierKeys.h.

Referenced by clear(), equals(), get(), and set().

GHOST_TUns8 GHOST_ModifierKeys::m_RightAlt

Bitfield that stores the appropriate key state.

Definition at line 94 of file GHOST_ModifierKeys.h.

Referenced by clear(), equals(), get(), and set().

GHOST_TUns8 GHOST_ModifierKeys::m_RightControl

Bitfield that stores the appropriate key state.

Definition at line 98 of file GHOST_ModifierKeys.h.

Referenced by clear(), equals(), get(), and set().

GHOST_TUns8 GHOST_ModifierKeys::m_RightShift

Bitfield that stores the appropriate key state.

Definition at line 90 of file GHOST_ModifierKeys.h.

Referenced by clear(), equals(), get(), and set().

---

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

• GHOST_ModifierKeys.h
• GHOST_ModifierKeys.cpp