flutter::KeyboardKeyHandler Class Reference

#include <keyboard_key_handler.h>

Inheritance diagram for flutter::KeyboardKeyHandler:

Classes
class	KeyboardKeyHandlerDelegate

Public Member Functions
	KeyboardKeyHandler (flutter::BinaryMessenger *messenger)
	~KeyboardKeyHandler ()
void	InitKeyboardChannel ()
void	AddDelegate (std::unique_ptr< KeyboardKeyHandlerDelegate > delegate)
void	SyncModifiersIfNeeded (int modifiers_state) override
void	KeyboardHook (int key, int scancode, int action, char32_t character, bool extended, bool was_down, KeyEventCallback callback) override
std::map< uint64_t, uint64_t >	GetPressedState () override
Public Member Functions inherited from flutter::KeyboardHandlerBase
virtual	~KeyboardHandlerBase ()=default

Additional Inherited Members
Public Types inherited from flutter::KeyboardHandlerBase
using	KeyEventCallback = std::function< void(bool)>

Detailed Description

Definition at line 35 of file keyboard_key_handler.h.

Constructor & Destructor Documentation

KeyboardKeyHandler()

flutter::KeyboardKeyHandler::KeyboardKeyHandler ( flutter::BinaryMessenger *  messenger )

explicit

Definition at line 31 of file keyboard_key_handler.cc.

    : last_sequence_id_(1),
      channel_(std::make_unique<MethodChannel<EncodableValue>>(
          messenger,
          kChannelName,
          &StandardMethodCodec::GetInstance())) {}

~KeyboardKeyHandler()

flutter::KeyboardKeyHandler::~KeyboardKeyHandler ( )

default

References callback.

Member Function Documentation

AddDelegate()

void flutter::KeyboardKeyHandler::AddDelegate

(

std::unique_ptr< KeyboardKeyHandlerDelegate >

delegate

)

Definition at line 66 of file keyboard_key_handler.cc.

                                                        {
  delegates_.push_back(std::move(delegate));
}

GetPressedState()

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

overridevirtual

Implements flutter::KeyboardHandlerBase.

Definition at line 77 of file keyboard_key_handler.cc.

                                                               {
  // The embedder responder is the first element in delegates_.
  auto& key_embedder_handler = delegates_.front();
  return key_embedder_handler->GetPressedState();
}

InitKeyboardChannel()

void flutter::KeyboardKeyHandler::InitKeyboardChannel

(

)

Definition at line 40 of file keyboard_key_handler.cc.

                                             {
  channel_->SetMethodCallHandler(
      [this](const MethodCall<EncodableValue>& call,
             std::unique_ptr<MethodResult<EncodableValue>> result) {
        HandleMethodCall(call, std::move(result));
      });
}

KeyboardHook()

void flutter::KeyboardKeyHandler::KeyboardHook ( int  key, int  scancode, int  action, char32_t  character, bool  extended, bool  was_down, KeyEventCallback  callback  )

overridevirtual

Implements flutter::KeyboardHandlerBase.

Definition at line 83 of file keyboard_key_handler.cc.

                                                                 {
  std::unique_ptr<PendingEvent> incoming = std::make_unique<PendingEvent>();
 
  uint64_t sequence_id = ++last_sequence_id_;
  incoming->sequence_id = sequence_id;
  incoming->unreplied = delegates_.size();
  incoming->any_handled = false;
  incoming->callback = std::move(callback);
 
  if (pending_responds_.size() > kMaxPendingEvents) {
    FML_LOG(ERROR)
        << "There are " << pending_responds_.size()
        << " keyboard events that have not yet received a response from the "
        << "framework. Are responses being sent?";
  }
  pending_responds_.push_back(std::move(incoming));
 
  for (const auto& delegate : delegates_) {
    delegate->KeyboardHook(key, scancode, action, character, extended, was_down,
                           [sequence_id, this](bool handled) {
                             ResolvePendingEvent(sequence_id, handled);
                           });
  }
 
  // |ResolvePendingEvent| might trigger redispatching synchronously,
  // which might occur before |KeyboardHook| is returned. This won't
  // make events out of order though, because |KeyboardHook| will always
  // return true at this time, preventing this event from affecting
  // others.
}

References action, callback, character, extended, FML_LOG, key, scancode, and was_down.

SyncModifiersIfNeeded()

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

overridevirtual

Implements flutter::KeyboardHandlerBase.

Definition at line 71 of file keyboard_key_handler.cc.

                                                                  {
  // Only call SyncModifierIfNeeded on the key embedder handler.
  auto& key_embedder_handler = delegates_.front();
  key_embedder_handler->SyncModifiersIfNeeded(modifiers_state);
}

---

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

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