#include <gdk/gdk.h>
#include <cinttypes>
#include <functional>
#include <memory>
#include "flutter/shell/platform/embedder/embedder.h"
#include "flutter/shell/platform/linux/fl_key_event.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_binary_messenger.h"

Classes
struct	_FlKeyboardViewDelegateInterface

Typedefs
typedef std::function< void()>	KeyboardLayoutNotifier

Functions
G_BEGIN_DECLS	G_DECLARE_INTERFACE (FlKeyboardViewDelegate, fl_keyboard_view_delegate, FL, KEYBOARD_VIEW_DELEGATE, GObject)

void	fl_keyboard_view_delegate_send_key_event (FlKeyboardViewDelegate delegate, const FlutterKeyEvent event, FlutterKeyEventCallback callback, void *user_data)

gboolean	fl_keyboard_view_delegate_text_filter_key_press (FlKeyboardViewDelegate delegate, FlKeyEvent event)

FlBinaryMessenger *	fl_keyboard_view_delegate_get_messenger (FlKeyboardViewDelegate *delegate)

void	fl_keyboard_view_delegate_redispatch_event (FlKeyboardViewDelegate delegate, FlKeyEvent event)

void	fl_keyboard_view_delegate_subscribe_to_layout_change (FlKeyboardViewDelegate *delegate, KeyboardLayoutNotifier notifier)

guint	fl_keyboard_view_delegate_lookup_key (FlKeyboardViewDelegate delegate, const GdkKeymapKey key)

GHashTable *	fl_keyboard_view_delegate_get_keyboard_state (FlKeyboardViewDelegate *delegate)

Typedef Documentation

◆ KeyboardLayoutNotifier

typedef std::function<void()> KeyboardLayoutNotifier

Definition at line 17 of file fl_keyboard_view_delegate.h.

Function Documentation

◆ fl_keyboard_view_delegate_get_keyboard_state()

GHashTable* fl_keyboard_view_delegate_get_keyboard_state ( FlKeyboardViewDelegate * delegate )

fl_keyboard_view_delegate_get_keyboard_state:

Returns the keyboard pressed state. The hash table contains one entry per pressed keys, mapping from the logical key to the physical key.*

Definition at line 67 of file fl_keyboard_view_delegate.cc.

                                   {
   g_return_val_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(self), nullptr);
  
   return FL_KEYBOARD_VIEW_DELEGATE_GET_IFACE(self)->get_keyboard_state(self);
 }

Referenced by get_keyboard_state().

◆ fl_keyboard_view_delegate_get_messenger()

FlBinaryMessenger* fl_keyboard_view_delegate_get_messenger ( FlKeyboardViewDelegate * delegate )

fl_keyboard_view_delegate_get_messenger:

Returns a binary messenger that can be used to send messages to the framework.

The ownership of messenger is kept by the view delegate.

Definition at line 35 of file fl_keyboard_view_delegate.cc.

                                   {
   g_return_val_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(self), nullptr);
  
   return FL_KEYBOARD_VIEW_DELEGATE_GET_IFACE(self)->get_messenger(self);
 }

Referenced by fl_keyboard_handler_new().

◆ fl_keyboard_view_delegate_lookup_key()

guint fl_keyboard_view_delegate_lookup_key	(	FlKeyboardViewDelegate *	delegate,
		const GdkKeymapKey *	key
	)

Definition at line 60 of file fl_keyboard_view_delegate.cc.

                                                                     {
   g_return_val_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(self), 0);
  
   return FL_KEYBOARD_VIEW_DELEGATE_GET_IFACE(self)->lookup_key(self, key);
 }

Referenced by convert_key_to_char().

◆ fl_keyboard_view_delegate_redispatch_event()

void fl_keyboard_view_delegate_redispatch_event	(	FlKeyboardViewDelegate *	delegate,
		FlKeyEvent *	event
	)

fl_keyboard_view_delegate_redispatch_event:

Handles FlKeyboardHandler's request to insert a GDK event to the system for redispatching.

Definition at line 42 of file fl_keyboard_view_delegate.cc.

                                                                    {
   g_return_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(self));
   g_return_if_fail(event != nullptr);
  
   return FL_KEYBOARD_VIEW_DELEGATE_GET_IFACE(self)->redispatch_event(self,
                                                                      event);
 }

References event.

Referenced by responder_handle_event_callback().

◆ fl_keyboard_view_delegate_send_key_event()

void fl_keyboard_view_delegate_send_key_event	(	FlKeyboardViewDelegate *	delegate,
		const FlutterKeyEvent *	event,
		FlutterKeyEventCallback	callback,
		void *	user_data
	)

fl_keyboard_view_delegate_send_key_event:

Handles FlKeyboardHandler's request to send a FlutterKeyEvent through the embedder API to the framework.

The ownership of the event is kept by the keyboard handler, and the event might be immediately destroyed after this function returns.

The callback must eventually be called exactly once with the event result and the user_data.

Definition at line 14 of file fl_keyboard_view_delegate.cc.

                                                                {
   g_return_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(self));
   g_return_if_fail(event != nullptr);
  
   FL_KEYBOARD_VIEW_DELEGATE_GET_IFACE(self)->send_key_event(
       self, event, callback, user_data);
 }

References callback, event, and user_data.

Referenced by fl_keyboard_handler_new().

◆ fl_keyboard_view_delegate_subscribe_to_layout_change()

void fl_keyboard_view_delegate_subscribe_to_layout_change	(	FlKeyboardViewDelegate *	delegate,
		KeyboardLayoutNotifier	notifier
	)

Definition at line 51 of file fl_keyboard_view_delegate.cc.

                                      {
   g_return_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(self));
  
   return FL_KEYBOARD_VIEW_DELEGATE_GET_IFACE(self)->subscribe_to_layout_change(
       self, std::move(notifier));
 }

Referenced by fl_keyboard_handler_dispose(), and fl_keyboard_handler_new().

◆ fl_keyboard_view_delegate_text_filter_key_press()

gboolean fl_keyboard_view_delegate_text_filter_key_press	(	FlKeyboardViewDelegate *	delegate,
		FlKeyEvent *	event
	)

fl_keyboard_view_delegate_text_filter_key_press:

Handles FlKeyboardHandler's request to check if the GTK text input IM filter would like to handle a GDK event.

The ownership of the event is kept by the keyboard handler.

Definition at line 25 of file fl_keyboard_view_delegate.cc.

                        {
   g_return_val_if_fail(FL_IS_KEYBOARD_VIEW_DELEGATE(self), false);
   g_return_val_if_fail(event != nullptr, false);
  
   return FL_KEYBOARD_VIEW_DELEGATE_GET_IFACE(self)->text_filter_key_press(
       self, event);
 }