| Flutter Linux Embedder |

Classes | Enumerations | Functions
fl_text_input_channel.h File Reference
`#include <gtk/gtk.h>`
`#include "flutter/shell/platform/linux/public/flutter_linux/fl_binary_messenger.h"`

Go to the source code of this file.

## Classes
struct | FlTextInputChannelVTable

## Enumerations
enum | FlTextInputType { FL_TEXT_INPUT_TYPE_TEXT , FL_TEXT_INPUT_TYPE_MULTILINE , FL_TEXT_INPUT_TYPE_NONE }
enum | FlTextAffinity { FL_TEXT_AFFINITY_UPSTREAM , FL_TEXT_AFFINITY_DOWNSTREAM }

## Functions
| G_DECLARE_FINAL_TYPE (FlTextInputChannel, fl_text_input_channel, FL, TEXT_INPUT_CHANNEL, GObject)
FlTextInputChannel * | fl_text_input_channel_new (FlBinaryMessenger *messenger, FlTextInputChannelVTable *vtable, gpointer user_data)
void | fl_text_input_channel_update_editing_state (FlTextInputChannel *channel, int64_t client_id, const gchar *text, int64_t selection_base, int64_t selection_extent, FlTextAffinity selection_affinity, gboolean selection_is_directional, int64_t composing_base, int64_t composing_extent, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean | fl_text_input_channel_update_editing_state_finish (GObject *object, GAsyncResult *result, GError **error)
void | fl_text_input_channel_update_editing_state_with_deltas (FlTextInputChannel *channel, int64_t client_id, const gchar *old_text, const gchar *delta_text, int64_t delta_start, int64_t delta_end, int64_t selection_base, int64_t selection_extent, FlTextAffinity selection_affinity, gboolean selection_is_directional, int64_t composing_base, int64_t composing_extent, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean | fl_text_input_channel_update_editing_state_with_deltas_finish (GObject *object, GAsyncResult *result, GError **error)
void | fl_text_input_channel_perform_action (FlTextInputChannel *channel, int64_t client_id, const gchar *input_action, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean | fl_text_input_channel_perform_action_finish (GObject *object, GAsyncResult *result, GError **error)

## Enumeration Type Documentation

## ◆ FlTextAffinity

enum FlTextAffinity

Enumerator
FL_TEXT_AFFINITY_UPSTREAM |
FL_TEXT_AFFINITY_DOWNSTREAM |

Definition at line 22 of file fl_text_input_channel.h.

22 {
23 FL_TEXT_AFFINITY_UPSTREAM,
24 FL_TEXT_AFFINITY_DOWNSTREAM,
25 } FlTextAffinity;
FlTextAffinity
FlTextAffinity
Definition: fl_text_input_channel.h:22
FL_TEXT_AFFINITY_DOWNSTREAM
@ FL_TEXT_AFFINITY_DOWNSTREAM
Definition: fl_text_input_channel.h:24
FL_TEXT_AFFINITY_UPSTREAM
@ FL_TEXT_AFFINITY_UPSTREAM
Definition: fl_text_input_channel.h:23

## ◆ FlTextInputType

enum FlTextInputType

Enumerator
FL_TEXT_INPUT_TYPE_TEXT |
FL_TEXT_INPUT_TYPE_MULTILINE |
FL_TEXT_INPUT_TYPE_NONE |

Definition at line 14 of file fl_text_input_channel.h.

14 {
15 FL_TEXT_INPUT_TYPE_TEXT,
16 // Send newline when multi-line and enter is pressed.
17 FL_TEXT_INPUT_TYPE_MULTILINE,
18 // The input method is not shown at all.
19 FL_TEXT_INPUT_TYPE_NONE,
20 } FlTextInputType;
FlTextInputType
FlTextInputType
Definition: fl_text_input_channel.h:14
FL_TEXT_INPUT_TYPE_MULTILINE
@ FL_TEXT_INPUT_TYPE_MULTILINE
Definition: fl_text_input_channel.h:17
FL_TEXT_INPUT_TYPE_TEXT
@ FL_TEXT_INPUT_TYPE_TEXT
Definition: fl_text_input_channel.h:15
FL_TEXT_INPUT_TYPE_NONE
@ FL_TEXT_INPUT_TYPE_NONE
Definition: fl_text_input_channel.h:19

## Function Documentation

## ◆ fl_text_input_channel_new()

FlTextInputChannel* fl_text_input_channel_new | ( | FlBinaryMessenger * | messenger,
|  | FlTextInputChannelVTable * | vtable,
|  | gpointer | user_data
| ) |  |

fl_text_input_channel_new: @messenger: an #FlBinaryMessenger. @vtable: callbacks for incoming method calls. @user_data: data to pass in callbacks.

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

Returns: a new #FlTextInputChannel.

Definition at line 245 of file fl_text_input_channel.cc.

247 {
248 g_return_val_if_fail(FL_IS_BINARY_MESSENGER(messenger), nullptr);
249 g_return_val_if_fail(vtable != nullptr, nullptr);
250
251 FlTextInputChannel* self = FL_TEXT_INPUT_CHANNEL(
252 g_object_new(fl_text_input_channel_get_type(), nullptr));
253
254 self->vtable = vtable;
255 self->user_data = user_data;
256
257 g_autoptr(FlJsonMethodCodec) codec = fl_json_method_codec_new();
258 self->channel =
259 fl_method_channel_new(messenger, kChannelName, FL_METHOD_CODEC(codec));
260 fl_method_channel_set_method_call_handler(self->channel, method_call_cb, self,
261 nullptr);
262
263 return self;
264 }
user_data
G_BEGIN_DECLS G_MODULE_EXPORT FlValue gpointer user_data
Definition: fl_event_channel.h:90
fl_json_method_codec_new
G_MODULE_EXPORT FlJsonMethodCodec * fl_json_method_codec_new()
Definition: fl_json_method_codec.cc:205
fl_method_channel_new
G_MODULE_EXPORT FlMethodChannel * fl_method_channel_new(FlBinaryMessenger *messenger, const gchar *name, FlMethodCodec *codec)
Definition: fl_method_channel.cc:112
fl_method_channel_set_method_call_handler
G_MODULE_EXPORT void fl_method_channel_set_method_call_handler(FlMethodChannel *self, FlMethodChannelMethodCallHandler handler, gpointer user_data, GDestroyNotify destroy_notify)
Definition: fl_method_channel.cc:134
method_call_cb
static void method_call_cb(FlMethodChannel *channel, FlMethodCall *method_call, gpointer user_data)
Definition: fl_text_input_channel.cc:198
kChannelName
static constexpr char kChannelName[]
Definition: fl_text_input_channel.cc:10

References fl_json_method_codec_new(), fl_method_channel_new(), fl_method_channel_set_method_call_handler(), kChannelName, method_call_cb(), and user_data.

Referenced by fl_text_input_handler_new().

## ◆ fl_text_input_channel_perform_action()

void fl_text_input_channel_perform_action | ( | FlTextInputChannel * | channel,
|  | int64_t | client_id,
|  | const gchar * | input_action,
|  | GCancellable * | cancellable,
|  | GAsyncReadyCallback | callback,
|  | gpointer | user_data
| ) |  |

fl_text_input_channel_perform_action: @channel: an #FlTextInputChannel. @client_id: @input_action: action to perform. @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.

Definition at line 384 of file fl_text_input_channel.cc.

389 {
390 g_return_if_fail(FL_IS_TEXT_INPUT_CHANNEL(self));
391
392 g_autoptr(FlValue) args = fl_value_new_list();
393 fl_value_append_take(args, fl_value_new_int(client_id));
394 fl_value_append_take(args, fl_value_new_string(input_action));
395
396 fl_method_channel_invoke_method(self->channel, kPerformActionMethod, args,
397 cancellable, callback, user_data);
398 }
args
G_BEGIN_DECLS G_MODULE_EXPORT FlValue * args
Definition: fl_event_channel.h:89
fl_method_channel_invoke_method
G_MODULE_EXPORT void fl_method_channel_invoke_method(FlMethodChannel *self, const gchar *method, FlValue *args, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
Definition: fl_method_channel.cc:162
kPerformActionMethod
static constexpr char kPerformActionMethod[]
Definition: fl_text_input_channel.cc:23
fl_value_new_string
G_MODULE_EXPORT FlValue * fl_value_new_string(const gchar *value)
Definition: fl_value.cc:276
fl_value_new_list
G_MODULE_EXPORT FlValue * fl_value_new_list()
Definition: fl_value.cc:349
fl_value_append_take
G_MODULE_EXPORT void fl_value_append_take(FlValue *self, FlValue *value)
Definition: fl_value.cc:600
fl_value_new_int
G_MODULE_EXPORT FlValue * fl_value_new_int(int64_t value)
Definition: fl_value.cc:262
FlValue
typedefG_BEGIN_DECLS struct _FlValue FlValue
Definition: fl_value.h:42

References args, fl_method_channel_invoke_method(), fl_value_append_take(), fl_value_new_int(), fl_value_new_list(), fl_value_new_string(), kPerformActionMethod, and user_data.

Referenced by perform_action().

## ◆ fl_text_input_channel_perform_action_finish()

gboolean fl_text_input_channel_perform_action_finish | ( | GObject * | object,
|  | GAsyncResult * | result,
|  | GError ** | error
| ) |  |

fl_text_input_channel_perform_action_finish: @object:

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

Completes request started with fl_text_input_channel_perform_action().

Returns: TRUE on success.

Definition at line 400 of file fl_text_input_channel.cc.

402 {
403 g_autoptr(FlMethodResponse) response = fl_method_channel_invoke_method_finish(
404 FL_METHOD_CHANNEL(object), result, error);
405 if (response == nullptr) {
406 return FALSE;
407 }
408 return fl_method_response_get_result(response, error) != nullptr;
409 }
fl_method_channel_invoke_method_finish
G_MODULE_EXPORT FlMethodResponse * fl_method_channel_invoke_method_finish(FlMethodChannel *self, GAsyncResult *result, GError **error)
Definition: fl_method_channel.cc:192
fl_method_response_get_result
G_MODULE_EXPORT FlValue * fl_method_response_get_result(FlMethodResponse *self, GError **error)
Definition: fl_method_response.cc:82
error
const uint8_t uint32_t uint32_t GError ** error
Definition: fl_pixel_buffer_texture_test.cc:40

References error, fl_method_channel_invoke_method_finish(), and fl_method_response_get_result().

Referenced by perform_action_response_cb().

## ◆ fl_text_input_channel_update_editing_state()

void fl_text_input_channel_update_editing_state | ( | FlTextInputChannel * | channel,
|  | int64_t | client_id,
|  | const gchar * | text,
|  | int64_t | selection_base,
|  | int64_t | selection_extent,
|  | FlTextAffinity | selection_affinity,
|  | gboolean | selection_is_directional,
|  | int64_t | composing_base,
|  | int64_t | composing_extent,
|  | GCancellable * | cancellable,
|  | GAsyncReadyCallback | callback,
|  | gpointer | user_data
| ) |  |

fl_text_input_channel_update_editing_state: @channel: an #FlTextInputChannel. @client_id: @text: @selection_base: @selection_extent: @selection_affinity: @selection_is_directional: @composing_base: @composing_extent: @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.

Definition at line 266 of file fl_text_input_channel.cc.

278 {
279 g_return_if_fail(FL_IS_TEXT_INPUT_CHANNEL(self));
280
281 g_autoptr(FlValue) args = fl_value_new_list();
282 fl_value_append_take(args, fl_value_new_int(client_id));
283 g_autoptr(FlValue) value = fl_value_new_map();
284
285 fl_value_set_string_take(value, kTextKey, fl_value_new_string(text));
286 fl_value_set_string_take(value, kSelectionBaseKey,
287 fl_value_new_int(selection_base));
288 fl_value_set_string_take(value, kSelectionExtentKey,
289 fl_value_new_int(selection_extent));
290 fl_value_set_string_take(
291 value, kSelectionAffinityKey,
292 fl_value_new_string(text_affinity_to_string(selection_affinity)));
293 fl_value_set_string_take(value, kSelectionIsDirectionalKey,
294 fl_value_new_bool(selection_is_directional));
295 fl_value_set_string_take(value, kComposingBaseKey,
296 fl_value_new_int(composing_base));
297 fl_value_set_string_take(value, kComposingExtentKey,
298 fl_value_new_int(composing_extent));
299
300 fl_value_append(args, value);
301
302 fl_method_channel_invoke_method(self->channel, kUpdateEditingStateMethod,
303 args, cancellable, callback, user_data);
304 }
value
uint8_t value
Definition: fl_standard_message_codec.cc:36
kSelectionIsDirectionalKey
static constexpr char kSelectionIsDirectionalKey[]
Definition: fl_text_input_channel.cc:36
kSelectionExtentKey
static constexpr char kSelectionExtentKey[]
Definition: fl_text_input_channel.cc:34
text_affinity_to_string
static const gchar * text_affinity_to_string(FlTextAffinity affinity)
Definition: fl_text_input_channel.cc:60
kUpdateEditingStateMethod
static constexpr char kUpdateEditingStateMethod[]
Definition: fl_text_input_channel.cc:19
kComposingExtentKey
static constexpr char kComposingExtentKey[]
Definition: fl_text_input_channel.cc:38
kComposingBaseKey
static constexpr char kComposingBaseKey[]
Definition: fl_text_input_channel.cc:37
kSelectionAffinityKey
static constexpr char kSelectionAffinityKey[]
Definition: fl_text_input_channel.cc:35
kTextKey
static constexpr char kTextKey[]
Definition: fl_text_input_channel.cc:32
kSelectionBaseKey
static constexpr char kSelectionBaseKey[]
Definition: fl_text_input_channel.cc:33
fl_value_set_string_take
G_MODULE_EXPORT void fl_value_set_string_take(FlValue *self, const gchar *key, FlValue *value)
Definition: fl_value.cc:650
fl_value_new_bool
G_MODULE_EXPORT FlValue * fl_value_new_bool(bool value)
Definition: fl_value.cc:255
fl_value_append
G_MODULE_EXPORT void fl_value_append(FlValue *self, FlValue *value)
Definition: fl_value.cc:592
fl_value_new_map
G_MODULE_EXPORT FlValue * fl_value_new_map()
Definition: fl_value.cc:366

References args, fl_method_channel_invoke_method(), fl_value_append(), fl_value_append_take(), fl_value_new_bool(), fl_value_new_int(), fl_value_new_list(), fl_value_new_map(), fl_value_new_string(), fl_value_set_string_take(), kComposingBaseKey, kComposingExtentKey, kSelectionAffinityKey, kSelectionBaseKey, kSelectionExtentKey, kSelectionIsDirectionalKey, kTextKey, kUpdateEditingStateMethod, text_affinity_to_string(), user_data, and value.

Referenced by update_editing_state().

## ◆ fl_text_input_channel_update_editing_state_finish()

gboolean fl_text_input_channel_update_editing_state_finish | ( | GObject * | object,
|  | GAsyncResult * | result,
|  | GError ** | error
| ) |  |

fl_text_input_channel_update_editing_state_finish: @object:

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

Completes request started with fl_text_input_channel_update_editing_state().

Returns: TRUE on success.

Definition at line 306 of file fl_text_input_channel.cc.

308 {
309 g_autoptr(FlMethodResponse) response = fl_method_channel_invoke_method_finish(
310 FL_METHOD_CHANNEL(object), result, error);
311 if (response == nullptr) {
312 return FALSE;
313 }
314 return fl_method_response_get_result(response, error) != nullptr;
315 }

References error, fl_method_channel_invoke_method_finish(), and fl_method_response_get_result().

Referenced by update_editing_state_response_cb().

## ◆ fl_text_input_channel_update_editing_state_with_deltas()

void fl_text_input_channel_update_editing_state_with_deltas | ( | FlTextInputChannel * | channel,
|  | int64_t | client_id,
|  | const gchar * | old_text,
|  | const gchar * | delta_text,
|  | int64_t | delta_start,
|  | int64_t | delta_end,
|  | int64_t | selection_base,
|  | int64_t | selection_extent,
|  | FlTextAffinity | selection_affinity,
|  | gboolean | selection_is_directional,
|  | int64_t | composing_base,
|  | int64_t | composing_extent,
|  | GCancellable * | cancellable,
|  | GAsyncReadyCallback | callback,
|  | gpointer | user_data
| ) |  |

fl_text_input_channel_update_editing_state_with_deltas: @channel: an #FlTextInputChannel. @client_id: @old_text: @delta_text: @delta_start: @delta_end: @selection_base: @selection_extent: @selection_affinity: @selection_is_directional: @composing_base: @composing_extent: @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.

Definition at line 317 of file fl_text_input_channel.cc.

332 {
333 g_return_if_fail(FL_IS_TEXT_INPUT_CHANNEL(self));
334
335 g_autoptr(FlValue) args = fl_value_new_list();
336 fl_value_append_take(args, fl_value_new_int(client_id));
337
338 g_autoptr(FlValue) deltaValue = fl_value_new_map();
339 fl_value_set_string_take(deltaValue, "oldText",
340 fl_value_new_string(old_text));
341 fl_value_set_string_take(deltaValue, "deltaText",
342 fl_value_new_string(delta_text));
343 fl_value_set_string_take(deltaValue, "deltaStart",
344 fl_value_new_int(delta_start));
345 fl_value_set_string_take(deltaValue, "deltaEnd", fl_value_new_int(delta_end));
346 fl_value_set_string_take(deltaValue, "selectionBase",
347 fl_value_new_int(selection_base));
348 fl_value_set_string_take(deltaValue, "selectionExtent",
349 fl_value_new_int(selection_extent));
350 fl_value_set_string_take(
351 deltaValue, "selectionAffinity",
352 fl_value_new_string(text_affinity_to_string(selection_affinity)));
353 fl_value_set_string_take(deltaValue, "selectionIsDirectional",
354 fl_value_new_bool(selection_is_directional));
355 fl_value_set_string_take(deltaValue, "composingBase",
356 fl_value_new_int(composing_base));
357 fl_value_set_string_take(deltaValue, "composingExtent",
358 fl_value_new_int(composing_extent));
359
360 g_autoptr(FlValue) deltas = fl_value_new_list();
361 fl_value_append(deltas, deltaValue);
362 g_autoptr(FlValue) value = fl_value_new_map();
363 fl_value_set_string(value, "deltas", deltas);
364
365 fl_value_append(args, value);
366
367 fl_method_channel_invoke_method(self->channel,
368 kUpdateEditingStateWithDeltasMethod, args,
369 cancellable, callback, user_data);
370 }
kUpdateEditingStateWithDeltasMethod
static constexpr char kUpdateEditingStateWithDeltasMethod[]
Definition: fl_text_input_channel.cc:21
fl_value_set_string
G_MODULE_EXPORT void fl_value_set_string(FlValue *self, const gchar *key, FlValue *value)
Definition: fl_value.cc:639

References args, fl_method_channel_invoke_method(), fl_value_append(), fl_value_append_take(), fl_value_new_bool(), fl_value_new_int(), fl_value_new_list(), fl_value_new_map(), fl_value_new_string(), fl_value_set_string(), fl_value_set_string_take(), kUpdateEditingStateWithDeltasMethod, text_affinity_to_string(), user_data, and value.

Referenced by update_editing_state_with_delta().

## ◆ fl_text_input_channel_update_editing_state_with_deltas_finish()

gboolean fl_text_input_channel_update_editing_state_with_deltas_finish | ( | GObject * | object,
|  | GAsyncResult * | result,
|  | GError ** | error
| ) |  |

fl_text_input_channel_update_editing_state_with_deltas_finish: @object:

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

Completes request started with fl_text_input_channel_update_editing_state_with_deltas().

Returns: TRUE on success.

Definition at line 372 of file fl_text_input_channel.cc.

375 {
376 g_autoptr(FlMethodResponse) response = fl_method_channel_invoke_method_finish(
377 FL_METHOD_CHANNEL(object), result, error);
378 if (response == nullptr) {
379 return FALSE;
380 }
381 return fl_method_response_get_result(response, error) != nullptr;
382 }

References error, fl_method_channel_invoke_method_finish(), and fl_method_response_get_result().

Referenced by update_editing_state_with_deltas_response_cb().

## ◆ G_DECLARE_FINAL_TYPE()

G_DECLARE_FINAL_TYPE | ( | FlTextInputChannel | ,
|  | fl_text_input_channel | ,
|  | FL | ,
|  | TEXT_INPUT_CHANNEL | ,
|  | GObject |
| ) |  |