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.

             {
  FL_TEXT_AFFINITY_UPSTREAM,
  FL_TEXT_AFFINITY_DOWNSTREAM,
} FlTextAffinity;

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.

             {
  FL_TEXT_INPUT_TYPE_TEXT,
  // Send newline when multi-line and enter is pressed.
  FL_TEXT_INPUT_TYPE_MULTILINE,
  // The input method is not shown at all.
  FL_TEXT_INPUT_TYPE_NONE,
} FlTextInputType;

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.

                                                                  {
  g_return_val_if_fail(FL_IS_BINARY_MESSENGER(messenger), nullptr);
  g_return_val_if_fail(vtable != nullptr, nullptr);
 
  FlTextInputChannel* self = FL_TEXT_INPUT_CHANNEL(
      g_object_new(fl_text_input_channel_get_type(), nullptr));
 
  self->vtable = vtable;
  self->user_data = user_data;
 
  g_autoptr(FlJsonMethodCodec) codec = fl_json_method_codec_new();
  self->channel =
      fl_method_channel_new(messenger, kChannelName, FL_METHOD_CODEC(codec));
  fl_method_channel_set_method_call_handler(self->channel, method_call_cb, self,
                                            nullptr);
 
  return self;
}

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.

                                                              {
  g_return_if_fail(FL_IS_TEXT_INPUT_CHANNEL(self));
 
  g_autoptr(FlValue) args = fl_value_new_list();
  fl_value_append_take(args, fl_value_new_int(client_id));
  fl_value_append_take(args, fl_value_new_string(input_action));
 
  fl_method_channel_invoke_method(self->channel, kPerformActionMethod, args,
                                  cancellable, callback, user_data);
}

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.

                                                                     {
  g_autoptr(FlMethodResponse) response = fl_method_channel_invoke_method_finish(
      FL_METHOD_CHANNEL(object), result, error);
  if (response == nullptr) {
    return FALSE;
  }
  return fl_method_response_get_result(response, error) != nullptr;
}

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.

                        {
  g_return_if_fail(FL_IS_TEXT_INPUT_CHANNEL(self));
 
  g_autoptr(FlValue) args = fl_value_new_list();
  fl_value_append_take(args, fl_value_new_int(client_id));
  g_autoptr(FlValue) value = fl_value_new_map();
 
  fl_value_set_string_take(value, kTextKey, fl_value_new_string(text));
  fl_value_set_string_take(value, kSelectionBaseKey,
                           fl_value_new_int(selection_base));
  fl_value_set_string_take(value, kSelectionExtentKey,
                           fl_value_new_int(selection_extent));
  fl_value_set_string_take(
      value, kSelectionAffinityKey,
      fl_value_new_string(text_affinity_to_string(selection_affinity)));
  fl_value_set_string_take(value, kSelectionIsDirectionalKey,
                           fl_value_new_bool(selection_is_directional));
  fl_value_set_string_take(value, kComposingBaseKey,
                           fl_value_new_int(composing_base));
  fl_value_set_string_take(value, kComposingExtentKey,
                           fl_value_new_int(composing_extent));
 
  fl_value_append(args, value);
 
  fl_method_channel_invoke_method(self->channel, kUpdateEditingStateMethod,
                                  args, cancellable, callback, user_data);
}

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.

                                                                           {
  g_autoptr(FlMethodResponse) response = fl_method_channel_invoke_method_finish(
      FL_METHOD_CHANNEL(object), result, error);
  if (response == nullptr) {
    return FALSE;
  }
  return fl_method_response_get_result(response, error) != nullptr;
}

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.

                        {
  g_return_if_fail(FL_IS_TEXT_INPUT_CHANNEL(self));
 
  g_autoptr(FlValue) args = fl_value_new_list();
  fl_value_append_take(args, fl_value_new_int(client_id));
 
  g_autoptr(FlValue) deltaValue = fl_value_new_map();
  fl_value_set_string_take(deltaValue, "oldText",
                           fl_value_new_string(old_text));
  fl_value_set_string_take(deltaValue, "deltaText",
                           fl_value_new_string(delta_text));
  fl_value_set_string_take(deltaValue, "deltaStart",
                           fl_value_new_int(delta_start));
  fl_value_set_string_take(deltaValue, "deltaEnd", fl_value_new_int(delta_end));
  fl_value_set_string_take(deltaValue, "selectionBase",
                           fl_value_new_int(selection_base));
  fl_value_set_string_take(deltaValue, "selectionExtent",
                           fl_value_new_int(selection_extent));
  fl_value_set_string_take(
      deltaValue, "selectionAffinity",
      fl_value_new_string(text_affinity_to_string(selection_affinity)));
  fl_value_set_string_take(deltaValue, "selectionIsDirectional",
                           fl_value_new_bool(selection_is_directional));
  fl_value_set_string_take(deltaValue, "composingBase",
                           fl_value_new_int(composing_base));
  fl_value_set_string_take(deltaValue, "composingExtent",
                           fl_value_new_int(composing_extent));
 
  g_autoptr(FlValue) deltas = fl_value_new_list();
  fl_value_append(deltas, deltaValue);
  g_autoptr(FlValue) value = fl_value_new_map();
  fl_value_set_string(value, "deltas", deltas);
 
  fl_value_append(args, value);
 
  fl_method_channel_invoke_method(self->channel,
                                  kUpdateEditingStateWithDeltasMethod, args,
                                  cancellable, callback, user_data);
}

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.

                    {
  g_autoptr(FlMethodResponse) response = fl_method_channel_invoke_method_finish(
      FL_METHOD_CHANNEL(object), result, error);
  if (response == nullptr) {
    return FALSE;
  }
  return fl_method_response_get_result(response, error) != nullptr;
}

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
	)