fl_key_event_channel.h File Reference

#include "flutter/shell/platform/linux/public/flutter_linux/fl_binary_messenger.h"

Go to the source code of this file.

Enumerations
enum	FlKeyEventType {   FL_KEY_EVENT_TYPE_KEYUP,   FL_KEY_EVENT_TYPE_KEYDOWN }

Functions
G_BEGIN_DECLS	G_DECLARE_FINAL_TYPE (FlKeyEventChannel, fl_key_event_channel, FL, KEY_EVENT_CHANNEL, GObject)
FlKeyEventChannel *	fl_key_event_channel_new (FlBinaryMessenger *messenger)
void	fl_key_event_channel_send (FlKeyEventChannel *channel, FlKeyEventType type, int64_t scan_code, int64_t key_code, int64_t modifiers, int64_t unicode_scarlar_values, int64_t specified_logical_key, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean	fl_key_event_channel_send_finish (GObject *object, GAsyncResult *result, gboolean *handled, GError **error)

Enumeration Type Documentation

FlKeyEventType

enum FlKeyEventType

FlKeyEventChannel:

#FlKeyEventChannel is a channel that implements the shell side of SystemChannels.keyEvent from the Flutter services library.

Enumerator
FL_KEY_EVENT_TYPE_KEYUP
FL_KEY_EVENT_TYPE_KEYDOWN

Definition at line 25 of file fl_key_event_channel.h.

             {
  FL_KEY_EVENT_TYPE_KEYUP,
  FL_KEY_EVENT_TYPE_KEYDOWN,
} FlKeyEventType;

Function Documentation

fl_key_event_channel_new()

FlKeyEventChannel* fl_key_event_channel_new

(

FlBinaryMessenger *

messenger

)

fl_key_event_channel_new: @messenger: an #FlBinaryMessenger

Creates a new channel that implements SystemChannels.keyEvent from the Flutter services library.

Returns: a new #FlKeyEventChannel.

Definition at line 50 of file fl_key_event_channel.cc.

                                                                          {
  g_return_val_if_fail(FL_IS_BINARY_MESSENGER(messenger), nullptr);
 
  FlKeyEventChannel* self = FL_KEY_EVENT_CHANNEL(
      g_object_new(fl_key_event_channel_get_type(), nullptr));
 
  g_autoptr(FlJsonMessageCodec) codec = fl_json_message_codec_new();
  self->channel = fl_basic_message_channel_new(messenger, kChannelName,
                                               FL_MESSAGE_CODEC(codec));
 
  return self;
}

References fl_basic_message_channel_new(), fl_json_message_codec_new(), and kChannelName.

Referenced by fl_key_channel_responder_new().

fl_key_event_channel_send()

void fl_key_event_channel_send	(	FlKeyEventChannel *	channel,
		FlKeyEventType	type,
		int64_t	scan_code,
		int64_t	key_code,
		int64_t	modifiers,
		int64_t	unicode_scarlar_values,
		int64_t	specified_logical_key,
		GCancellable *	cancellable,
		GAsyncReadyCallback	callback,
		gpointer	user_data
	)

fl_key_event_channel_send: @channel: an #FlKeyEventChannel @type: event type. @scan_code: scan code. @key_code: key code. @modifiers: modifiers. @unicode_scarlar_values: @specified_logical_key: @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the method returns. @user_data: (closure): user data to pass to @callback.

Send a key event to the platform.

Definition at line 63 of file fl_key_event_channel.cc.

                                                   {
  g_return_if_fail(FL_IS_KEY_EVENT_CHANNEL(self));
 
  const gchar* type_string;
  switch (type) {
    case FL_KEY_EVENT_TYPE_KEYUP:
      type_string = kTypeValueUp;
      break;
    case FL_KEY_EVENT_TYPE_KEYDOWN:
      type_string = kTypeValueDown;
      break;
    default:
      g_assert_not_reached();
  }
 
  g_autoptr(FlValue) message = fl_value_new_map();
  fl_value_set_string_take(message, kTypeKey, fl_value_new_string(type_string));
  fl_value_set_string_take(message, kKeymapKey,
                           fl_value_new_string(kLinuxKeymap));
  fl_value_set_string_take(message, kScanCodeKey, fl_value_new_int(scan_code));
  fl_value_set_string_take(message, kToolkitKey,
                           fl_value_new_string(kGtkToolkit));
  fl_value_set_string_take(message, kKeyCodeKey, fl_value_new_int(key_code));
  fl_value_set_string_take(message, kModifiersKey, fl_value_new_int(modifiers));
  if (unicode_scalar_values != kUnicodeScalarValuesUnset) {
    fl_value_set_string_take(message, kUnicodeScalarValuesKey,
                             fl_value_new_int(unicode_scalar_values));
  }
  if (specified_logical_key != kSpecifiedLogicalKeyUnset) {
    fl_value_set_string_take(message, kSpecifiedLogicalKey,
                             fl_value_new_int(specified_logical_key));
  }
  fl_basic_message_channel_send(self->channel, message, cancellable, callback,
                                user_data);
}

References fl_basic_message_channel_send(), FL_KEY_EVENT_TYPE_KEYDOWN, FL_KEY_EVENT_TYPE_KEYUP, fl_value_new_int(), fl_value_new_map(), fl_value_new_string(), fl_value_set_string_take(), kGtkToolkit, kKeyCodeKey, kKeymapKey, kLinuxKeymap, kModifiersKey, kScanCodeKey, kSpecifiedLogicalKey, kSpecifiedLogicalKeyUnset, kToolkitKey, kTypeKey, kTypeValueDown, kTypeValueUp, kUnicodeScalarValuesKey, kUnicodeScalarValuesUnset, type, and user_data.

Referenced by fl_key_channel_responder_handle_event().

fl_key_event_channel_send_finish()

gboolean fl_key_event_channel_send_finish	(	GObject *	object,
		GAsyncResult *	result,
		gboolean *	handled,
		GError **	error
	)

fl_key_event_channel_send_finish: @object:

Returns

: a #GAsyncResult. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Completes request started with fl_key_event_channel_send().

Returns: TRUE on success.

Definition at line 108 of file fl_key_event_channel.cc.

                                                          {
  g_autoptr(FlValue) message = fl_basic_message_channel_send_finish(
      FL_BASIC_MESSAGE_CHANNEL(object), result, error);
  if (message == nullptr) {
    return FALSE;
  }
 
  FlValue* handled_value = fl_value_lookup_string(message, "handled");
  *handled = fl_value_get_bool(handled_value);
 
  return TRUE;
}

References error, fl_basic_message_channel_send_finish(), fl_value_get_bool(), fl_value_lookup_string(), and TRUE.

Referenced by handle_response().

G_DECLARE_FINAL_TYPE()

G_BEGIN_DECLS G_DECLARE_FINAL_TYPE	(	FlKeyEventChannel	,
		fl_key_event_channel	,
		FL	,
		KEY_EVENT_CHANNEL	,
		GObject
	)