fl_text_input_handler.h File Reference

#include <gtk/gtk.h>
#include "flutter/shell/platform/linux/fl_key_event.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_binary_messenger.h"

Go to the source code of this file.

Functions
G_BEGIN_DECLS	G_DECLARE_FINAL_TYPE (FlTextInputHandler, fl_text_input_handler, FL, TEXT_INPUT_HANDLER, GObject)
FlTextInputHandler *	fl_text_input_handler_new (FlBinaryMessenger *messenger)
GtkIMContext *	fl_text_input_handler_get_im_context (FlTextInputHandler *handler)
void	fl_text_input_handler_set_widget (FlTextInputHandler *handler, GtkWidget *widget)
GtkWidget *	fl_text_input_handler_get_widget (FlTextInputHandler *handler)
gboolean	fl_text_input_handler_filter_keypress (FlTextInputHandler *handler, FlKeyEvent *event)

Function Documentation

fl_text_input_handler_filter_keypress()

gboolean fl_text_input_handler_filter_keypress	(	FlTextInputHandler *	handler,
		FlKeyEvent *	event
	)

fl_text_input_handler_filter_keypress @handler: an #FlTextInputHandler. @event: a #FlKeyEvent

Process a key event.

Returns: TRUE if the event was used.

Definition at line 499 of file fl_text_input_handler.cc.

                                                                  {
  g_return_val_if_fail(FL_IS_TEXT_INPUT_HANDLER(self), FALSE);
 
  if (self->client_id == kClientIdUnset) {
    return FALSE;
  }
 
  if (gtk_im_context_filter_keypress(
          self->im_context,
          reinterpret_cast<GdkEventKey*>(fl_key_event_get_origin(event)))) {
    return TRUE;
  }
 
  std::string text_before_change = self->text_model->GetText();
  flutter::TextRange selection_before_change = self->text_model->selection();
  std::string text = self->text_model->GetText();
 
  // Handle the enter/return key.
  gboolean do_action = FALSE;
  // Handle navigation keys.
  gboolean changed = FALSE;
  if (fl_key_event_get_is_press(event)) {
    switch (fl_key_event_get_keyval(event)) {
      case GDK_KEY_End:
      case GDK_KEY_KP_End:
        if (fl_key_event_get_state(event) & GDK_SHIFT_MASK) {
          changed = self->text_model->SelectToEnd();
        } else {
          changed = self->text_model->MoveCursorToEnd();
        }
        break;
      case GDK_KEY_Return:
      case GDK_KEY_KP_Enter:
      case GDK_KEY_ISO_Enter:
        if (self->input_type == FL_TEXT_INPUT_TYPE_MULTILINE &&
            strcmp(self->input_action, kNewlineInputAction) == 0) {
          self->text_model->AddCodePoint('\n');
          text = "\n";
          changed = TRUE;
        }
        do_action = TRUE;
        break;
      case GDK_KEY_Home:
      case GDK_KEY_KP_Home:
        if (fl_key_event_get_state(event) & GDK_SHIFT_MASK) {
          changed = self->text_model->SelectToBeginning();
        } else {
          changed = self->text_model->MoveCursorToBeginning();
        }
        break;
      case GDK_KEY_BackSpace:
      case GDK_KEY_Delete:
      case GDK_KEY_KP_Delete:
      case GDK_KEY_Left:
      case GDK_KEY_KP_Left:
      case GDK_KEY_Right:
      case GDK_KEY_KP_Right:
        // Already handled inside the framework in RenderEditable.
        break;
    }
  }
 
  if (changed) {
    if (self->enable_delta_model) {
      flutter::TextEditingDelta delta = flutter::TextEditingDelta(
          text_before_change, selection_before_change, text);
      update_editing_state_with_delta(self, &delta);
    } else {
      update_editing_state(self);
    }
  }
  if (do_action) {
    perform_action(self);
  }
 
  return changed;
}

References fl_key_event_get_is_press(), fl_key_event_get_keyval(), fl_key_event_get_origin(), fl_key_event_get_state(), FL_TEXT_INPUT_TYPE_MULTILINE, gtk_im_context_filter_keypress(), kClientIdUnset, kNewlineInputAction, perform_action(), self, text, TRUE, update_editing_state(), and update_editing_state_with_delta().

Referenced by handle_key_event(), and send_key_event().

fl_text_input_handler_get_im_context()

GtkIMContext * fl_text_input_handler_get_im_context

(

FlTextInputHandler *

handler

)

fl_text_input_handler_get_im_context: @handler: an #FlTextInputHandler.

Get the IM context that is being used. Provided for testing purposes.

Returns: a #GtkIMContext.

Definition at line 480 of file fl_text_input_handler.cc.

                                                                             {
  g_return_val_if_fail(FL_IS_TEXT_INPUT_HANDLER(self), nullptr);
  return self->im_context;
}

References self.

Referenced by TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

fl_text_input_handler_get_widget()

GtkWidget * fl_text_input_handler_get_widget

(

FlTextInputHandler *

handler

)

fl_text_input_handler_get_widget: @handler: an #FlTextInputHandler.

Get the widget that has input focus.

Returns: a #GtkWidget or NULL if none active.

Definition at line 494 of file fl_text_input_handler.cc.

                                                                      {
  g_return_val_if_fail(FL_IS_TEXT_INPUT_HANDLER(self), nullptr);
  return self->widget;
}

References self.

Referenced by fl_view_dispose(), setup_keyboard(), and TEST_F().

fl_text_input_handler_new()

FlTextInputHandler * fl_text_input_handler_new

(

FlBinaryMessenger *

messenger

)

FlTextInputHandler:

#FlTextInputHandler is a handler that implements the shell side of SystemChannels.textInput from the Flutter services library. fl_text_input_handler_new: @messenger: an #FlBinaryMessenger.

Creates a new handler that implements SystemChannels.textInput from the Flutter services library.

Returns: a new #FlTextInputHandler.

Definition at line 443 of file fl_text_input_handler.cc.

                                                                            {
  g_return_val_if_fail(FL_IS_BINARY_MESSENGER(messenger), nullptr);
 
  FlTextInputHandler* self = FL_TEXT_INPUT_HANDLER(
      g_object_new(fl_text_input_handler_get_type(), nullptr));
 
  self->channel =
      fl_text_input_channel_new(messenger, &text_input_vtable, self);
 
  self->im_context = GTK_IM_CONTEXT(gtk_im_multicontext_new());
 
  // On Wayland, this call sets up the input method so it can be enabled
  // immediately when required. Without it, on-screen keyboard's don't come up
  // the first time a text field is focused.
  gtk_im_context_focus_out(self->im_context);
 
  g_signal_connect_object(self->im_context, "preedit-start",
                          G_CALLBACK(im_preedit_start_cb), self,
                          G_CONNECT_SWAPPED);
  g_signal_connect_object(self->im_context, "preedit-end",
                          G_CALLBACK(im_preedit_end_cb), self,
                          G_CONNECT_SWAPPED);
  g_signal_connect_object(self->im_context, "preedit-changed",
                          G_CALLBACK(im_preedit_changed_cb), self,
                          G_CONNECT_SWAPPED);
  g_signal_connect_object(self->im_context, "commit", G_CALLBACK(im_commit_cb),
                          self, G_CONNECT_SWAPPED);
  g_signal_connect_object(self->im_context, "retrieve-surrounding",
                          G_CALLBACK(im_retrieve_surrounding_cb), self,
                          G_CONNECT_SWAPPED);
  g_signal_connect_object(self->im_context, "delete-surrounding",
                          G_CALLBACK(im_delete_surrounding_cb), self,
                          G_CONNECT_SWAPPED);
 
  return self;
}

References fl_text_input_channel_new(), gtk_im_context_focus_out(), im_commit_cb(), im_delete_surrounding_cb(), im_preedit_changed_cb(), im_preedit_end_cb(), im_preedit_start_cb(), im_retrieve_surrounding_cb(), self, and text_input_vtable.

Referenced by FlTextInputHandlerTest::SetUp(), and setup_keyboard().

fl_text_input_handler_set_widget()

void fl_text_input_handler_set_widget	(	FlTextInputHandler *	handler,
		GtkWidget *	widget
	)

fl_text_input_handler_set_widget: @handler: an #FlTextInputHandler. @widget: the widget with keyboard focus.

Set the widget that has input focus.

Definition at line 485 of file fl_text_input_handler.cc.

                                                         {
  g_return_if_fail(FL_IS_TEXT_INPUT_HANDLER(self));
  self->widget = widget;
  gtk_im_context_set_client_window(
      self->im_context,
      widget != nullptr ? gtk_widget_get_window(widget) : nullptr);
}

References gtk_im_context_set_client_window(), gtk_widget_get_window(), and self.

Referenced by fl_view_dispose(), fl_view_focus_in_event(), setup_keyboard(), TEST_F(), and TEST_F().

G_DECLARE_FINAL_TYPE()

G_BEGIN_DECLS G_DECLARE_FINAL_TYPE	(	FlTextInputHandler	,
		fl_text_input_handler	,
		FL	,
		TEXT_INPUT_HANDLER	,
		GObject
	)