flutter::TextInputManager Class Reference

#include <text_input_manager.h>

Inheritance diagram for flutter::TextInputManager:

Public Member Functions
	TextInputManager () noexcept=default
virtual	~TextInputManager ()=default
void	SetWindowHandle (HWND window_handle)
void	CreateImeWindow ()
void	DestroyImeWindow ()
void	UpdateImeWindow ()
void	UpdateCaretRect (const Rect &rect)
virtual long	GetComposingCursorPosition () const
virtual std::optional< std::u16string >	GetComposingString () const
virtual std::optional< std::u16string >	GetResultString () const
void	AbortComposing ()

Detailed Description

Definition at line 29 of file text_input_manager.h.

Constructor & Destructor Documentation

TextInputManager()

flutter::TextInputManager::TextInputManager ( )

defaultnoexcept

~TextInputManager()

virtual flutter::TextInputManager::~TextInputManager ( )

virtualdefault

Member Function Documentation

AbortComposing()

void flutter::TextInputManager::AbortComposing

(

)

Aborts IME composing.

Aborts composing, closes the candidates window, and clears the contents of the composing string.

Definition at line 126 of file text_input_manager.cc.

                                      {
  if (window_handle_ == nullptr || !ime_active_) {
    return;
  }
 
  ImmContext imm_context(window_handle_);
  if (imm_context.IsValid()) {
    // Cancel composing and close the candidates window.
    ::ImmNotifyIME(imm_context.get(), NI_COMPOSITIONSTR, CPS_CANCEL, 0);
    ::ImmNotifyIME(imm_context.get(), NI_CLOSECANDIDATE, 0, 0);
 
    // Clear the composing string.
    wchar_t composition_str[] = L"";
    wchar_t reading_str[] = L"";
    ::ImmSetCompositionStringW(imm_context.get(), SCS_SETSTR, composition_str,
                               sizeof(wchar_t), reading_str, sizeof(wchar_t));
  }
}

References flutter::ImmContext::get(), and flutter::ImmContext::IsValid().

CreateImeWindow()

void flutter::TextInputManager::CreateImeWindow

(

)

Definition at line 51 of file text_input_manager.cc.

                                       {
  if (window_handle_ == nullptr) {
    return;
  }
 
  // Some IMEs ignore calls to ::ImmSetCandidateWindow() and use the position of
  // the current system caret instead via ::GetCaretPos(). In order to behave
  // as expected with these IMEs, we create a temporary system caret.
  if (!ime_active_) {
    ::CreateCaret(window_handle_, nullptr, 1, 1);
  }
  ime_active_ = true;
 
  // Set the position of the IME windows.
  UpdateImeWindow();
}

References UpdateImeWindow().

DestroyImeWindow()

void flutter::TextInputManager::DestroyImeWindow

(

)

Definition at line 68 of file text_input_manager.cc.

                                        {
  if (window_handle_ == nullptr) {
    return;
  }
 
  // Destroy the system caret created in CreateImeWindow().
  if (ime_active_) {
    ::DestroyCaret();
  }
  ime_active_ = false;
}

GetComposingCursorPosition()

long flutter::TextInputManager::GetComposingCursorPosition ( ) const

virtual

Definition at line 104 of file text_input_manager.cc.

                                                        {
  if (window_handle_ == nullptr) {
    return false;
  }
 
  ImmContext imm_context(window_handle_);
  if (imm_context.IsValid()) {
    // Read the cursor position within the composing string.
    return ImmGetCompositionString(imm_context.get(), GCS_CURSORPOS, nullptr,
                                   0);
  }
  return -1;
}

References flutter::ImmContext::get(), and flutter::ImmContext::IsValid().

GetComposingString()

std::optional< std::u16string > flutter::TextInputManager::GetComposingString ( ) const

virtual

Definition at line 118 of file text_input_manager.cc.

                                                                     {
  return GetString(GCS_COMPSTR);
}

GetResultString()

std::optional< std::u16string > flutter::TextInputManager::GetResultString ( ) const

virtual

Definition at line 122 of file text_input_manager.cc.

                                                                  {
  return GetString(GCS_RESULTSTR);
}

SetWindowHandle()

void flutter::TextInputManager::SetWindowHandle

(

HWND

window_handle

)

Definition at line 47 of file text_input_manager.cc.

                                                         {
  window_handle_ = window_handle;
}

UpdateCaretRect()

void flutter::TextInputManager::UpdateCaretRect

(

const Rect &

rect

)

Definition at line 91 of file text_input_manager.cc.

                                                       {
  caret_rect_ = rect;
 
  if (window_handle_ == nullptr) {
    return;
  }
 
  ImmContext imm_context(window_handle_);
  if (imm_context.IsValid()) {
    MoveImeWindow(imm_context.get());
  }
}

References flutter::ImmContext::get(), and flutter::ImmContext::IsValid().

UpdateImeWindow()

void flutter::TextInputManager::UpdateImeWindow

(

)

Definition at line 80 of file text_input_manager.cc.

                                       {
  if (window_handle_ == nullptr) {
    return;
  }
 
  ImmContext imm_context(window_handle_);
  if (imm_context.IsValid()) {
    MoveImeWindow(imm_context.get());
  }
}

References flutter::ImmContext::get(), and flutter::ImmContext::IsValid().

Referenced by CreateImeWindow().

---

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

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