Fix a typo in key_defs_consumerctl.h

`Consumer_SNapshot` really should have been `Consumer_Snapshot`, so lets fix it.
However, the typo'd name is left in place as an alias, in order to not break any
existing user code, however unlikely the use of this key is.

Sadly, we can't easily add a deprecation warning, because key_defs.h, which
defines `Key`, depends on `key_defs_consumerctl.h`, so we'd end up with a
circular dependency if we tried to add a deprecation.

Fixes #339.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
pull/340/head
Gergely Nagy 6 years ago
parent c18fe0584a
commit 65eb079a3a

@ -139,6 +139,11 @@ public:
Plugins are supposed to implement this new API, and then be initialised via
`KALEIDOSCOPE_INIT_PLUGINS`.
#### Consumer_SNapshot
A key with a typo in its name, which was left in place after fixing the typo, so
as to not break any code that may be using it already, however unlikely.
Deprecated and removed APIs
---------------------------

@ -1,6 +1,5 @@
#pragma once
#define Consumer_NumericKeyPad CONSUMER_KEY(HID_CONSUMER_NUMERIC_KEY_PAD, KEY_FLAGS | HID_TYPE_NARY )
#define Consumer_ProgrammableButtons CONSUMER_KEY(HID_CONSUMER_PROGRAMMABLE_BUTTONS, KEY_FLAGS | HID_TYPE_NARY )
#define Consumer_MicrophoneCa CONSUMER_KEY(HID_CONSUMER_MICROPHONE_CA, KEY_FLAGS )
@ -34,7 +33,8 @@
#define Consumer_ClosedCaptionSelect CONSUMER_KEY(HID_CONSUMER_CLOSED_CAPTION_SELECT, KEY_FLAGS | HID_TYPE_OSC )
#define Consumer_VCRSlashTV CONSUMER_KEY(HID_CONSUMER_VCR_SLASH_TV, KEY_FLAGS | HID_TYPE_OOC )
#define Consumer_BroadcastMode CONSUMER_KEY(HID_CONSUMER_BROADCAST_MODE, KEY_FLAGS | HID_TYPE_OSC )
#define Consumer_SNapshot CONSUMER_KEY(HID_CONSUMER_SNAPSHOT, KEY_FLAGS | HID_TYPE_OSC )
#define Consumer_Snapshot CONSUMER_KEY(HID_CONSUMER_SNAPSHOT, KEY_FLAGS | HID_TYPE_OSC )
#define Consumer_SNapshot Consumer_Snapshot
#define Consumer_Still CONSUMER_KEY(HID_CONSUMER_STILL, KEY_FLAGS | HID_TYPE_OSC )
#define Consumer_Selection CONSUMER_KEY(HID_CONSUMER_SELECTION, KEY_FLAGS | HID_TYPE_NARY )

Loading…
Cancel
Save