fl_key_event.h File Reference

#include <gdk/gdk.h>

Go to the source code of this file.

Classes
struct	_FlKeyEvent

Typedefs
typedef struct _FlKeyEvent	FlKeyEvent

Functions
FlKeyEvent *	fl_key_event_new_from_gdk_event (GdkEvent *event)
void	fl_key_event_dispose (FlKeyEvent *event)
FlKeyEvent *	fl_key_event_clone (const FlKeyEvent *source)

Typedef Documentation

FlKeyEvent

typedef struct _FlKeyEvent FlKeyEvent

FlKeyEvent: A struct that stores information from GdkEvent.

This is a class only used within the GTK embedding, created by FlView and consumed by FlKeyboardManager. It is not sent to the embedder.

This object contains information from GdkEvent as well as an origin event object, so that Flutter can create an event object in unit tests even after migrating to GDK 4.0 which stops supporting creating GdkEvent.

Function Documentation

fl_key_event_clone()

FlKeyEvent * fl_key_event_clone

(

const FlKeyEvent *

source

)

Definition at line 39 of file fl_key_event.cc.

                                                        {
  FlKeyEvent* new_event = g_new(FlKeyEvent, 1);
  *new_event = *event;
  return new_event;
}

fl_key_event_dispose()

void fl_key_event_dispose

(

FlKeyEvent *

event

)

fl_key_event_dispose: @event: the event to dispose.

Properly disposes the content of event and then the pointer.

Definition at line 32 of file fl_key_event.cc.

                                             {
  if (event->origin != nullptr) {
    gdk_event_free(event->origin);
  }
  g_free(event);
}

fl_key_event_new_from_gdk_event()

FlKeyEvent * fl_key_event_new_from_gdk_event

(

GdkEvent *

event

)

fl_key_event_new_from_gdk_event: @event: the #GdkEvent this FlKeyEvent is based on. The event must be a #GdkEventKey, and will be destroyed by fl_key_event_dispose.

Create a new FlKeyEvent based on a #GdkEvent.

Returns: a new FlKeyEvent. Must be freed with fl_key_event_dispose.

Definition at line 7 of file fl_key_event.cc.

                                                             {
  g_return_val_if_fail(event != nullptr, nullptr);
  GdkEventType type = gdk_event_get_event_type(event);
  g_return_val_if_fail(type == GDK_KEY_PRESS || type == GDK_KEY_RELEASE,
                       nullptr);
  FlKeyEvent* result = g_new(FlKeyEvent, 1);
 
  guint16 keycode = 0;
  gdk_event_get_keycode(event, &keycode);
  guint keyval = 0;
  gdk_event_get_keyval(event, &keyval);
  GdkModifierType state = static_cast<GdkModifierType>(0);
  gdk_event_get_state(event, &state);
 
  result->time = gdk_event_get_time(event);
  result->is_press = type == GDK_KEY_PRESS;
  result->keycode = keycode;
  result->keyval = keyval;
  result->state = state;
  result->group = event->key.group;
  result->origin = event;
 
  return result;
}