Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::AcceleratorKey::Value Class Reference

This class is used to hold the values of both the keyboard modifier(s), such as Ctrl, Shift, or Alt, and the virtual key value, such as vkLetterV. More...

#include <vcf/ApplicationKit/AcceleratorKey.h>

List of all members.

Public Types

enum  { ShiftBy = 16, MaskBy = 0x0000FFFF }

Public Member Functions

 Value ()
 Value (const uint32 &modifierMask, const VirtualKeyCode &keyCode)
bool isEmpty () const
bool hasShiftKey () const
bool hasCtrlKey () const
bool hasAltKey () const
VirtualKeyCode getKeyCode () const
void setKeyCode (const VirtualKeyCode &keyCode)
uint32 getModifierMask () const
void setModifierMask (const uint32 &modifierMask)
Valueoperator= (const uint32 &val)
Valueoperator= (AcceleratorKey *val)
 operator uint32 () const
bool operator== (const Value &rhs) const
bool operator!= (const Value &rhs) const

Protected Attributes

uint32 val_


Detailed Description

This class is used to hold the values of both the keyboard modifier(s), such as Ctrl, Shift, or Alt, and the virtual key value, such as vkLetterV.

The actual data is stored as 2 unsigned 16 bit values, within one unsigned 32 bit member variable. The virtual key code is stored in the upper 16 bits, and the keyboard modifiers are stored in the lower 16 bits.


Member Enumeration Documentation

anonymous enum
 

Enumerator:
ShiftBy 
MaskBy 


Constructor & Destructor Documentation

VCF::AcceleratorKey::Value::Value  )  [inline]
 

VCF::AcceleratorKey::Value::Value const uint32 modifierMask,
const VirtualKeyCode keyCode
[inline]
 


Member Function Documentation

VirtualKeyCode VCF::AcceleratorKey::Value::getKeyCode  )  const [inline]
 

uint32 VCF::AcceleratorKey::Value::getModifierMask  )  const [inline]
 

bool VCF::AcceleratorKey::Value::hasAltKey  )  const [inline]
 

bool VCF::AcceleratorKey::Value::hasCtrlKey  )  const [inline]
 

bool VCF::AcceleratorKey::Value::hasShiftKey  )  const [inline]
 

bool VCF::AcceleratorKey::Value::isEmpty  )  const [inline]
 

VCF::AcceleratorKey::Value::operator uint32  )  const [inline]
 

bool VCF::AcceleratorKey::Value::operator!= const Value rhs  )  const [inline]
 

Value& VCF::AcceleratorKey::Value::operator= AcceleratorKey val  )  [inline]
 

Value& VCF::AcceleratorKey::Value::operator= const uint32 val  )  [inline]
 

bool VCF::AcceleratorKey::Value::operator== const Value rhs  )  const [inline]
 

void VCF::AcceleratorKey::Value::setKeyCode const VirtualKeyCode keyCode  )  [inline]
 

void VCF::AcceleratorKey::Value::setModifierMask const uint32 modifierMask  )  [inline]
 


Member Data Documentation

uint32 VCF::AcceleratorKey::Value::val_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information