flutter::KeyboardKeyChannelHandler Class Reference

#include <keyboard_key_channel_handler.h>

Inheritance diagram for flutter::KeyboardKeyChannelHandler:

Public Member Functions
	KeyboardKeyChannelHandler (flutter::BinaryMessenger *messenger)
	~KeyboardKeyChannelHandler ()
void	KeyboardHook (int key, int scancode, int action, char32_t character, bool extended, bool was_down, std::function< void(bool)> callback)
void	SyncModifiersIfNeeded (int modifiers_state)
std::map< uint64_t, uint64_t >	GetPressedState ()
Public Member Functions inherited from flutter::KeyboardKeyHandler::KeyboardKeyHandlerDelegate
virtual	~KeyboardKeyHandlerDelegate ()

Detailed Description

Definition at line 24 of file keyboard_key_channel_handler.h.

Constructor & Destructor Documentation

KeyboardKeyChannelHandler()

flutter::KeyboardKeyChannelHandler::KeyboardKeyChannelHandler ( flutter::BinaryMessenger *  messenger )

explicit

Definition at line 102 of file keyboard_key_channel_handler.cc.

    : channel_(
          std::make_unique<flutter::BasicMessageChannel<rapidjson::Document>>(
              messenger,
              kChannelName,
              &flutter::JsonMessageCodec::GetInstance())) {}

~KeyboardKeyChannelHandler()

flutter::KeyboardKeyChannelHandler::~KeyboardKeyChannelHandler ( )

default

Member Function Documentation

GetPressedState()

std::map< uint64_t, uint64_t > flutter::KeyboardKeyChannelHandler::GetPressedState ( )

virtual

Implements flutter::KeyboardKeyHandler::KeyboardKeyHandlerDelegate.

Definition at line 116 of file keyboard_key_channel_handler.cc.

                                                                      {
  // Returns an empty state because it will never be called.
  // KeyboardKeyEmbedderHandler is the only KeyboardKeyHandlerDelegate to handle
  // GetPressedState() calls.
  std::map<uint64_t, uint64_t> empty_state;
  return empty_state;
}

KeyboardHook()

void flutter::KeyboardKeyChannelHandler::KeyboardHook ( int  key, int  scancode, int  action, char32_t  character, bool  extended, bool  was_down, std::function< void(bool)>  callback  )

virtual

Implements flutter::KeyboardKeyHandler::KeyboardKeyHandlerDelegate.

Definition at line 124 of file keyboard_key_channel_handler.cc.

                                      {
  // TODO: Translate to a cross-platform key code system rather than passing
  // the native key code.
  rapidjson::Document event(rapidjson::kObjectType);
  auto& allocator = event.GetAllocator();
  event.AddMember(kKeyCodeKey, key, allocator);
  event.AddMember(kScanCodeKey, scancode | (extended ? kScancodeExtended : 0),
                  allocator);
  event.AddMember(kCharacterCodePointKey, UndeadChar(character), allocator);
  event.AddMember(kKeyMapKey, kWindowsKeyMap, allocator);
  event.AddMember(kModifiersKey, GetModsForKeyState(), allocator);
 
  switch (action) {
    case WM_SYSKEYDOWN:
    case WM_KEYDOWN:
      event.AddMember(kTypeKey, kKeyDown, allocator);
      break;
    case WM_SYSKEYUP:
    case WM_KEYUP:
      event.AddMember(kTypeKey, kKeyUp, allocator);
      break;
    default:
      FML_LOG(WARNING) << "Unknown key event action: " << action;
      callback(false);
      return;
  }
  channel_->Send(event, [callback = std::move(callback)](const uint8_t* reply,
                                                         size_t reply_size) {
    auto decoded = flutter::JsonMessageCodec::GetInstance().DecodeMessage(
        reply, reply_size);
    bool handled = decoded ? (*decoded)[kHandledKey].GetBool() : false;
    callback(handled);
  });
}

References action, callback, character, flutter::MessageCodec< T >::DecodeMessage(), extended, FML_LOG, flutter::JsonMessageCodec::GetInstance(), key, kKeyCodeKey, kKeyDown, kKeyMapKey, kKeyUp, kModifiersKey, kScanCodeKey, flutter::kTypeKey, scancode, and flutter::UndeadChar().

SyncModifiersIfNeeded()

void flutter::KeyboardKeyChannelHandler::SyncModifiersIfNeeded ( int  modifiers_state )

virtual

Implements flutter::KeyboardKeyHandler::KeyboardKeyHandlerDelegate.

Definition at line 112 of file keyboard_key_channel_handler.cc.

                                                                         {
  // Do nothing.
}

---

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

• shell/platform/windows/keyboard_key_channel_handler.h
• shell/platform/windows/keyboard_key_channel_handler.cc