InterfaceMgr::GetAlternateKey

Defined in: C4Interface.h

Returns a boolean value indicating whether the alternate key is pressed.

Prototype

static bool GetAlternateKey(void);

Description

The GetAlternateKey function returns true if the alternate key is currently pressed and false otherwise. No distinction is made between left and right alternate keys, and true is returned if either is pressed.

The name "alternate key" is used as a platform-neutral term, and it refers to different physical keys on different platforms. Under Windows, the GetAlternateKey function returns true if the Alt key is pressed. Under Mac OS X, the GetAlternateKey function returns true if the Option key is pressed.