getModifierSide method

  1. @override
KeyboardSide getModifierSide (
  1. ModifierKey key

Returns a KeyboardSide enum value that describes which side or sides of the given keyboard modifier key were pressed at the time of this event.

If the modifier key wasn't pressed at the time of this event, returns null. If the given key only appears in one place on the keyboard, returns KeyboardSide.all if pressed. Never returns KeyboardSide.any, because that doesn't make sense in this context.


KeyboardSide getModifierSide(ModifierKey key) {
  KeyboardSide findSide(int leftMask, int rightMask, int anyMask) {
    final int combinedMask = leftMask | rightMask;
    final int combined = modifiers & combinedMask;
    if (combined == leftMask) {
      return KeyboardSide.left;
    } else if (combined == rightMask) {
      return KeyboardSide.right;
    } else if (combined == combinedMask || modifiers & (combinedMask | anyMask) == anyMask) {
      // Handles the case where macOS supplies just the "either" modifier
      // flag, but not the left/right flag. (e.g. modifierShift but not
      // modifierLeftShift).
      return KeyboardSide.all;
    return null;

  switch (key) {
    case ModifierKey.controlModifier:
      return findSide(modifierLeftControl, modifierRightControl, modifierControl);
    case ModifierKey.shiftModifier:
      return findSide(modifierLeftShift, modifierRightShift, modifierShift);
    case ModifierKey.altModifier:
      return findSide(modifierLeftOption, modifierRightOption, modifierOption);
    case ModifierKey.metaModifier:
      return findSide(modifierLeftCommand, modifierRightCommand, modifierCommand);
    case ModifierKey.capsLockModifier:
    case ModifierKey.numLockModifier:
    case ModifierKey.scrollLockModifier:
    case ModifierKey.functionModifier:
    case ModifierKey.symbolModifier:
      return KeyboardSide.all;

  assert(false, 'Not handling $key type properly.');
  return null;