FlutterKeyboardLayout Class Reference

#import <FlutterKeyboardLayout.h>

Inheritance diagram for FlutterKeyboardLayout:

Instance Methods
(flutter::LayoutClue)	- lookUpLayoutForKeyCode:shift:

Properties
id< FlutterKeyboardLayoutDelegate >	delegate

Detailed Description

A class that allows querying the printable result of a key with a modifier state according to the current keyboard layout. It also provides a delegate protocol for clients interested in listening to keyboard layout changes.

Definition at line 50 of file FlutterKeyboardLayout.h.

Method Documentation

lookUpLayoutForKeyCode:shift:

- (LayoutClue) FlutterKeyboardLayout:		(uint16_t)	keyCode
shift:		(BOOL)	shift

Querying the printable result of a key under the given modifier state.

Definition at line 75 of file FlutterKeyboardLayout.mm.

                                           :(uint16_t)keyCode shift:(BOOL)shift {
  if (_keyboardLayoutData == nil) {
    _keyboardLayoutData = CurrentKeyboardLayoutData();
  }
  const UCKeyboardLayout* layout = reinterpret_cast<const UCKeyboardLayout*>(
      CFDataGetBytePtr((__bridge CFDataRef)_keyboardLayoutData));
 
  UInt32 deadKeyState = 0;
  UniCharCount stringLength = 0;
  UniChar resultChar;
 
  UInt32 modifierState = ((shift ? shiftKey : 0) >> 8) & 0xFF;
  UInt32 keyboardType = LMGetKbdLast();
 
  bool isDeadKey = false;
  OSStatus status =
      UCKeyTranslate(layout, keyCode, kUCKeyActionDown, modifierState, keyboardType,
                     kUCKeyTranslateNoDeadKeysBit, &deadKeyState, 1, &stringLength, &resultChar);
  // For dead keys, press the same key again to get the printable representation of the key.
  if (status == noErr && stringLength == 0 && deadKeyState != 0) {
    isDeadKey = true;
    status =
        UCKeyTranslate(layout, keyCode, kUCKeyActionDown, modifierState, keyboardType,
                       kUCKeyTranslateNoDeadKeysBit, &deadKeyState, 1, &stringLength, &resultChar);
  }
 
  if (status == noErr && stringLength == 1 && !std::iscntrl(resultChar)) {
    return flutter::LayoutClue{resultChar, isDeadKey};
  }
  return flutter::LayoutClue{0, false};
}

Property Documentation

delegate

- (id<FlutterKeyboardLayoutDelegate>) delegate

readwritenonatomicweak

Definition at line 52 of file FlutterKeyboardLayout.h.

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/macos/framework/Source/FlutterKeyboardLayout.h
• shell/platform/darwin/macos/framework/Source/FlutterKeyboardLayout.mm