flutter::TextInputPlugin Class Reference

#include <text_input_plugin.h>

Inheritance diagram for flutter::TextInputPlugin:

Public Member Functions
	TextInputPlugin (flutter::BinaryMessenger *messenger)
virtual	~TextInputPlugin ()
void	KeyboardHook (GLFWwindow *window, int key, int scancode, int action, int mods) override
void	CharHook (GLFWwindow *window, unsigned int code_point) override
	TextInputPlugin (flutter::BinaryMessenger *messenger, FlutterWindowsEngine *engine)
virtual	~TextInputPlugin ()
virtual void	KeyboardHook (int key, int scancode, int action, char32_t character, bool extended, bool was_down)
virtual void	TextHook (const std::u16string &text)
virtual void	ComposeBeginHook ()
virtual void	ComposeCommitHook ()
virtual void	ComposeEndHook ()
virtual void	ComposeChangeHook (const std::u16string &text, int cursor_pos)
Public Member Functions inherited from flutter::KeyboardHookHandler
virtual	~KeyboardHookHandler ()=default
virtual void	KeyboardHook (GLFWwindow *window, int key, int scancode, int action, int mods)=0
virtual void	CharHook (GLFWwindow *window, unsigned int code_point)=0

Detailed Description

Definition at line 24 of file text_input_plugin.h.

Constructor & Destructor Documentation

TextInputPlugin() [1/2]

flutter::TextInputPlugin::TextInputPlugin ( flutter::BinaryMessenger *  messenger )

explicit

Definition at line 99 of file text_input_plugin.cc.

    : channel_(std::make_unique<flutter::MethodChannel<rapidjson::Document>>(
          messenger,
          kChannelName,
          &flutter::JsonMethodCodec::GetInstance())),
      active_model_(nullptr) {
  channel_->SetMethodCallHandler(
      [this](
          const flutter::MethodCall<rapidjson::Document>& call,
          std::unique_ptr<flutter::MethodResult<rapidjson::Document>> result) {
        HandleMethodCall(call, std::move(result));
      });
}

~TextInputPlugin() [1/2]

flutter::TextInputPlugin::~TextInputPlugin ( )

virtualdefault

TextInputPlugin() [2/2]

flutter::TextInputPlugin::TextInputPlugin	(	flutter::BinaryMessenger *	messenger,
		FlutterWindowsEngine *	engine
	)

Definition at line 107 of file text_input_plugin.cc.

    : channel_(std::make_unique<flutter::MethodChannel<rapidjson::Document>>(
          messenger,
          kChannelName,
          &flutter::JsonMethodCodec::GetInstance())),
      engine_(engine),
      active_model_(nullptr) {
  channel_->SetMethodCallHandler(
      [this](
          const flutter::MethodCall<rapidjson::Document>& call,
          std::unique_ptr<flutter::MethodResult<rapidjson::Document>> result) {
        HandleMethodCall(call, std::move(result));
      });
}

~TextInputPlugin() [2/2]

virtual flutter::TextInputPlugin::~TextInputPlugin ( )

virtual

Member Function Documentation

CharHook()

void flutter::TextInputPlugin::CharHook ( GLFWwindow *  window, unsigned int  code_point  )

overridevirtual

Implements flutter::KeyboardHookHandler.

Definition at line 44 of file text_input_plugin.cc.

                                                                          {
  if (active_model_ == nullptr) {
    return;
  }
  active_model_->AddCodePoint(code_point);
  SendStateUpdate(*active_model_);
}

ComposeBeginHook()

void flutter::TextInputPlugin::ComposeBeginHook ( )

virtual

Definition at line 125 of file text_input_plugin.cc.

                                       {
  if (active_model_ == nullptr) {
    return;
  }
  active_model_->BeginComposing();
  if (enable_delta_model) {
    std::string text = active_model_->GetText();
    TextRange selection = active_model_->selection();
    TextEditingDelta delta = TextEditingDelta(text);
    SendStateUpdateWithDelta(*active_model_, &delta);
  } else {
    SendStateUpdate(*active_model_);
  }
}

ComposeChangeHook()

void flutter::TextInputPlugin::ComposeChangeHook ( const std::u16string &  text, int  cursor_pos  )

virtual

Definition at line 192 of file text_input_plugin.cc.

                                                        {
  if (active_model_ == nullptr) {
    return;
  }
  std::string text_before_change = active_model_->GetText();
  TextRange composing_before_change = active_model_->composing_range();
  active_model_->AddText(text);
  active_model_->UpdateComposingText(text, TextRange(cursor_pos, cursor_pos));
  std::string text_after_change = active_model_->GetText();
  if (enable_delta_model) {
    TextEditingDelta delta = TextEditingDelta(
        fml::Utf8ToUtf16(text_before_change), composing_before_change, text);
    SendStateUpdateWithDelta(*active_model_, &delta);
  } else {
    SendStateUpdate(*active_model_);
  }
}

ComposeCommitHook()

void flutter::TextInputPlugin::ComposeCommitHook ( )

virtual

Definition at line 140 of file text_input_plugin.cc.

                                        {
  if (active_model_ == nullptr) {
    return;
  }
  std::string text_before_change = active_model_->GetText();
  TextRange selection_before_change = active_model_->selection();
  TextRange composing_before_change = active_model_->composing_range();
  std::string composing_text_before_change = text_before_change.substr(
      composing_before_change.start(), composing_before_change.length());
  active_model_->CommitComposing();
 
  // We do not trigger SendStateUpdate here.
  //
  // Until a WM_IME_ENDCOMPOSING event, the user is still composing from the OS
  // point of view. Commit events are always immediately followed by another
  // composing event or an end composing event. However, in the brief window
  // between the commit event and the following event, the composing region is
  // collapsed. Notifying the framework of this intermediate state will trigger
  // any framework code designed to execute at the end of composing, such as
  // input formatters, which may try to update the text and send a message back
  // to the engine with changes.
  //
  // This is a particular problem with Korean IMEs, which build up one
  // character at a time in their composing region until a keypress that makes
  // no sense for the in-progress character. At that point, the result
  // character is committed and a compose event is immedidately received with
  // the new composing region.
  //
  // In the case where this event is immediately followed by a composing event,
  // the state will be sent in ComposeChangeHook.
  //
  // In the case where this event is immediately followed by an end composing
  // event, the state will be sent in ComposeEndHook.
}

ComposeEndHook()

void flutter::TextInputPlugin::ComposeEndHook ( )

virtual

Definition at line 175 of file text_input_plugin.cc.

                                     {
  if (active_model_ == nullptr) {
    return;
  }
  std::string text_before_change = active_model_->GetText();
  TextRange selection_before_change = active_model_->selection();
  active_model_->CommitComposing();
  active_model_->EndComposing();
  if (enable_delta_model) {
    std::string text = active_model_->GetText();
    TextEditingDelta delta = TextEditingDelta(text);
    SendStateUpdateWithDelta(*active_model_, &delta);
  } else {
    SendStateUpdate(*active_model_);
  }
}

KeyboardHook() [1/2]

void flutter::TextInputPlugin::KeyboardHook ( GLFWwindow *  window, int  key, int  scancode, int  action, int  mods  )

overridevirtual

Implements flutter::KeyboardHookHandler.

Definition at line 52 of file text_input_plugin.cc.

                                             {
  if (active_model_ == nullptr) {
    return;
  }
  if (action == GLFW_PRESS || action == GLFW_REPEAT) {
    switch (key) {
      case GLFW_KEY_LEFT:
        if (active_model_->MoveCursorBack()) {
          SendStateUpdate(*active_model_);
        }
        break;
      case GLFW_KEY_RIGHT:
        if (active_model_->MoveCursorForward()) {
          SendStateUpdate(*active_model_);
        }
        break;
      case GLFW_KEY_END:
        active_model_->MoveCursorToEnd();
        SendStateUpdate(*active_model_);
        break;
      case GLFW_KEY_HOME:
        active_model_->MoveCursorToBeginning();
        SendStateUpdate(*active_model_);
        break;
      case GLFW_KEY_BACKSPACE:
        if (active_model_->Backspace()) {
          SendStateUpdate(*active_model_);
        }
        break;
      case GLFW_KEY_DELETE:
        if (active_model_->Delete()) {
          SendStateUpdate(*active_model_);
        }
        break;
      case GLFW_KEY_ENTER:
        EnterPressed(active_model_.get());
        break;
      default:
        break;
    }
  }
}

KeyboardHook() [2/2]

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

virtual

Definition at line 85 of file text_input_plugin.cc.

                                                  {
  if (active_model_ == nullptr) {
    return;
  }
  if (action == WM_KEYDOWN || action == WM_SYSKEYDOWN) {
    // Most editing keys (arrow keys, backspace, delete, etc.) are handled in
    // the framework, so don't need to be handled at this layer.
    switch (key) {
      case VK_RETURN:
        EnterPressed(active_model_.get());
        break;
      default:
        break;
    }
  }
}

TextHook()

void flutter::TextInputPlugin::TextHook ( const std::u16string &  text )

virtual

Definition at line 67 of file text_input_plugin.cc.

                                                       {
  if (active_model_ == nullptr) {
    return;
  }
  std::u16string text_before_change =
      fml::Utf8ToUtf16(active_model_->GetText());
  TextRange selection_before_change = active_model_->selection();
  active_model_->AddText(text);
 
  if (enable_delta_model) {
    TextEditingDelta delta =
        TextEditingDelta(text_before_change, selection_before_change, text);
    SendStateUpdateWithDelta(*active_model_, &delta);
  } else {
    SendStateUpdate(*active_model_);
  }
}

---

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

• shell/platform/glfw/text_input_plugin.h
• shell/platform/windows/text_input_plugin.h
• shell/platform/glfw/text_input_plugin.cc
• shell/platform/windows/text_input_plugin.cc