[Classes] [Prev] [Next] [Methods]

CKey

Methods Index

Heritage
Description
Usage
Protected Data Members
Public Methods
Constructor and Operator Methods
State Methods
Protected Methods

CKey


Heritage

Superclass: None

Subclass: None


Description

CKey encapsulates an s_event::_v::s_char structure. CKey is designed to be platform independent, so that the public access methods are expected to be consistent across all keyboards.


Usage

A CKey object is generated by the switchboard as a wrapper of a key event, and propagated via the DoKey() methods. You may instantiate a CKey object for one of the following reasons:


Protected Data Members

static unsigned itsDefaultSensitivity; Determines type of equality test
xvt_event_char itsEventChar; Internal representation of the keyboard event


Public Methods

Constructor and Operator Methods

CKey();
CKey(const CKey&);
CKey(XVT_WCHAR theKey, 
BOOLEAN isShifted = FALSE,
BOOLEAN isControl = FALSE,
BOOLEAN isAlt = FALSE,
BOOLEAN isMeta = FALSE);
CKey(const xvt_event_char&);
CKey& operator=(const CKey&);
CKey(eVirtualKey, XVT_WCHAR);
BOOLEAN operator==(const CKey&) const;
BOOLEAN operator!=(const CKey&) const;

State Methods

static void SetDefaultSensitivity(unsigned theSensitivity);
static unsigned GetDefaultSensitivity();
BOOLEAN IsEqual(const CKey&, unsigned = GetDefaultSensitivity()) const;
XVT_WCHAR GetChar() const;
BOOLEAN IsShifted() const;
BOOLEAN IsCtrl() const;
BOOLEAN IsAlt() const;
BOOLEAN IsMeta() const;
BOOLEAN IsVirtualKey() const;
const xvt_event_char& GetKeyEventChar() const;

Protected Methods

BOOLEAN IsCharEqualSensitive(const CKey&) const;
BOOLEAN IsCharEqualInsensitive(const CKey&) const;


[Classes] [Prev] [Next] [Methods]

support@xvt.com


Visit our online help desk for tech support

Copyright © 2009, Providence Software Solutions Inc. All rights reserved.