Blender  V3.3
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GHOST_ModifierKeys Struct Reference

#include <GHOST_ModifierKeys.h>

Public Member Functions

 GHOST_ModifierKeys ()
 
 ~GHOST_ModifierKeys ()
 
bool get (GHOST_TModifierKey mask) const
 
void set (GHOST_TModifierKey mask, bool down)
 
void clear ()
 
bool equals (const GHOST_ModifierKeys &keys) const
 

Static Public Member Functions

static GHOST_TKey getModifierKeyCode (GHOST_TModifierKey mask)
 

Public Attributes

uint8_t m_LeftShift: 1
 
uint8_t m_RightShift: 1
 
uint8_t m_LeftAlt: 1
 
uint8_t m_RightAlt: 1
 
uint8_t m_LeftControl: 1
 
uint8_t m_RightControl: 1
 
uint8_t m_OS: 1
 

Detailed Description

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

Definition at line 17 of file GHOST_ModifierKeys.h.

Constructor & Destructor Documentation

◆ GHOST_ModifierKeys()

GHOST_ModifierKeys::GHOST_ModifierKeys ( )

Constructor.

Copyright (C) 2001 NaN Technologies B.V.

Definition at line 14 of file GHOST_ModifierKeys.cpp.

References clear().

◆ ~GHOST_ModifierKeys()

GHOST_ModifierKeys::~GHOST_ModifierKeys ( )

Definition at line 19 of file GHOST_ModifierKeys.cpp.

Member Function Documentation

◆ clear()

void GHOST_ModifierKeys::clear ( )

Sets the state of all modifier keys to up.

Definition at line 107 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().

◆ equals()

bool GHOST_ModifierKeys::equals ( const GHOST_ModifierKeys keys) const

Determines whether to modifier key states are equal.

Parameters
keysThe modifier key state to compare to.
Returns
Indication of equality.

Definition at line 118 of file GHOST_ModifierKeys.cpp.

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

◆ get()

bool GHOST_ModifierKeys::get ( GHOST_TModifierKey  mask) const

◆ getModifierKeyCode()

GHOST_TKey GHOST_ModifierKeys::getModifierKeyCode ( GHOST_TModifierKey  mask)
static

◆ set()

void GHOST_ModifierKeys::set ( GHOST_TModifierKey  mask,
bool  down 
)

Member Data Documentation

◆ m_LeftAlt

uint8_t GHOST_ModifierKeys::m_LeftAlt

Bitfield that stores the appropriate key state.

Definition at line 63 of file GHOST_ModifierKeys.h.

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

◆ m_LeftControl

uint8_t GHOST_ModifierKeys::m_LeftControl

Bitfield that stores the appropriate key state.

Definition at line 67 of file GHOST_ModifierKeys.h.

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

◆ m_LeftShift

uint8_t GHOST_ModifierKeys::m_LeftShift

Bitfield that stores the appropriate key state.

Definition at line 59 of file GHOST_ModifierKeys.h.

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

◆ m_OS

uint8_t GHOST_ModifierKeys::m_OS

Bitfield that stores the appropriate key state.

Definition at line 71 of file GHOST_ModifierKeys.h.

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

◆ m_RightAlt

uint8_t GHOST_ModifierKeys::m_RightAlt

Bitfield that stores the appropriate key state.

Definition at line 65 of file GHOST_ModifierKeys.h.

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

◆ m_RightControl

uint8_t GHOST_ModifierKeys::m_RightControl

Bitfield that stores the appropriate key state.

Definition at line 69 of file GHOST_ModifierKeys.h.

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

◆ m_RightShift

uint8_t GHOST_ModifierKeys::m_RightShift

Bitfield that stores the appropriate key state.

Definition at line 61 of file GHOST_ModifierKeys.h.

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


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