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

Classes
struct	FlPlatformChannelVTable

Enumerations
enum	FlPlatformChannelExitType { FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE , FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED }

enum	FlPlatformChannelExitResponse { FL_PLATFORM_CHANNEL_EXIT_RESPONSE_CANCEL , FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT }

Functions
	G_DECLARE_FINAL_TYPE (FlPlatformChannel, fl_platform_channel, FL, PLATFORM_CHANNEL, GObject)

FlPlatformChannel *	fl_platform_channel_new (FlBinaryMessenger messenger, FlPlatformChannelVTable vtable, gpointer user_data)

void	fl_platform_channel_system_request_app_exit (FlPlatformChannel channel, FlPlatformChannelExitType type, GCancellable cancellable, GAsyncReadyCallback callback, gpointer user_data)

gboolean	fl_platform_channel_system_request_app_exit_finish (GObject object, GAsyncResult result, FlPlatformChannelExitResponse exit_response, GError *error)

void	fl_platform_channel_respond_system_exit_application (FlMethodCall *method_call, FlPlatformChannelExitResponse exit_response)

void	fl_platform_channel_respond_clipboard_get_data (FlMethodCall method_call, const gchar text)

void	fl_platform_channel_respond_clipboard_has_strings (FlMethodCall *method_call, gboolean has_strings)

FlMethodResponse *	fl_platform_channel_make_system_request_app_exit_response (FlPlatformChannelExitResponse exit_response)

Enumeration Type Documentation

◆ FlPlatformChannelExitResponse

enum FlPlatformChannelExitResponse

Enumerator
FL_PLATFORM_CHANNEL_EXIT_RESPONSE_CANCEL
FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT

Definition at line 18 of file fl_platform_channel.h.

              {
   FL_PLATFORM_CHANNEL_EXIT_RESPONSE_CANCEL,
   FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT,
 } FlPlatformChannelExitResponse;

◆ FlPlatformChannelExitType

enum FlPlatformChannelExitType

Enumerator
FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE
FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED

Definition at line 13 of file fl_platform_channel.h.

              {
   FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE,
   FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED,
 } FlPlatformChannelExitType;

Function Documentation

◆ fl_platform_channel_make_system_request_app_exit_response()

FlMethodResponse* fl_platform_channel_make_system_request_app_exit_response ( FlPlatformChannelExitResponse exit_response )

Definition at line 330 of file fl_platform_channel.cc.

                                                  {
   g_autoptr(FlValue) exit_result = fl_value_new_map();
   const gchar* exit_response_string;
   switch (exit_response) {
     case FL_PLATFORM_CHANNEL_EXIT_RESPONSE_CANCEL:
       exit_response_string = kExitResponseCancel;
       break;
     case FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT:
       exit_response_string = kExitResponseExit;
       break;
     default:
       g_assert_not_reached();
   }
   fl_value_set_string_take(exit_result, kExitResponseKey,
                            fl_value_new_string(exit_response_string));
   return FL_METHOD_RESPONSE(fl_method_success_response_new(exit_result));
 }

References fl_method_success_response_new(), FL_PLATFORM_CHANNEL_EXIT_RESPONSE_CANCEL, FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT, fl_value_new_map(), fl_value_new_string(), fl_value_set_string_take(), kExitResponseCancel, kExitResponseExit, and kExitResponseKey.

Referenced by fl_platform_channel_respond_system_exit_application(), and system_exit_application().

◆ fl_platform_channel_new()

FlPlatformChannel* fl_platform_channel_new	(	FlBinaryMessenger *	messenger,
		FlPlatformChannelVTable *	vtable,
		gpointer	user_data
	)

fl_platform_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.platform from the Flutter services library.

Returns: a new #FlPlatformChannel

Definition at line 222 of file fl_platform_channel.cc.

                                                                {
   g_return_val_if_fail(FL_IS_BINARY_MESSENGER(messenger), nullptr);
   g_return_val_if_fail(vtable != nullptr, nullptr);
  
   FlPlatformChannel* self = FL_PLATFORM_CHANNEL(
       g_object_new(fl_platform_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_platform_handler_new(), and TEST().

◆ fl_platform_channel_respond_clipboard_get_data()

void fl_platform_channel_respond_clipboard_get_data	(	FlMethodCall *	method_call,
		const gchar *	text
	)

Definition at line 284 of file fl_platform_channel.cc.

                                                                        {
   g_autoptr(FlValue) result = nullptr;
   if (text != nullptr) {
     result = fl_value_new_map();
     fl_value_set_string_take(result, kTextKey, fl_value_new_string(text));
   }
  
   g_autoptr(FlMethodResponse) response =
       FL_METHOD_RESPONSE(fl_method_success_response_new(result));
  
   g_autoptr(GError) error = nullptr;
   if (!fl_method_call_respond(method_call, response, &error)) {
     g_warning("Failed to send response to %s: %s", kGetClipboardDataMethod,
               error->message);
   }
 }

References error, fl_method_call_respond(), fl_method_success_response_new(), fl_value_new_map(), fl_value_new_string(), fl_value_set_string_take(), kGetClipboardDataMethod, kTextKey, and method_call.

Referenced by clipboard_text_cb().

◆ fl_platform_channel_respond_clipboard_has_strings()

void fl_platform_channel_respond_clipboard_has_strings	(	FlMethodCall *	method_call,
		gboolean	has_strings
	)

Definition at line 302 of file fl_platform_channel.cc.

                           {
   g_autoptr(FlValue) result = fl_value_new_map();
   fl_value_set_string_take(result, kValueKey, fl_value_new_bool(has_strings));
  
   g_autoptr(FlMethodResponse) response =
       FL_METHOD_RESPONSE(fl_method_success_response_new(result));
  
   g_autoptr(GError) error = nullptr;
   if (!fl_method_call_respond(method_call, response, &error)) {
     g_warning("Failed to send response to %s: %s", kClipboardHasStringsMethod,
               error->message);
   }
 }

References error, fl_method_call_respond(), fl_method_success_response_new(), fl_value_new_bool(), fl_value_new_map(), fl_value_set_string_take(), kClipboardHasStringsMethod, kValueKey, and method_call.

Referenced by clipboard_text_has_strings_cb().

◆ fl_platform_channel_respond_system_exit_application()

void fl_platform_channel_respond_system_exit_application	(	FlMethodCall *	method_call,
		FlPlatformChannelExitResponse	exit_response
	)

Definition at line 318 of file fl_platform_channel.cc.

                                                  {
   g_autoptr(FlMethodResponse) response =
       fl_platform_channel_make_system_request_app_exit_response(exit_response);
   g_autoptr(GError) error = nullptr;
   if (!fl_method_call_respond(method_call, response, &error)) {
     g_warning("Failed to send response to System.exitApplication: %s",
               error->message);
   }
 }

References error, fl_method_call_respond(), fl_platform_channel_make_system_request_app_exit_response(), and method_call.

Referenced by request_app_exit_response_cb().

◆ fl_platform_channel_system_request_app_exit()

void fl_platform_channel_system_request_app_exit	(	FlPlatformChannel *	channel,
		FlPlatformChannelExitType	type,
		GCancellable *	cancellable,
		GAsyncReadyCallback	callback,
		gpointer	user_data
	)

fl_platform_channel_system_request_app_exit: @channel: an #FlPlatformChannel

Request the application exits (i.e. due to the window being requested to be closed).

Calling this will only send an exit request to the framework if the framework has already indicated that it is ready to receive requests by sending a "System.initializationComplete" method call on the platform channel. Calls before initialization is complete will result in an immediate exit.

Definition at line 243 of file fl_platform_channel.cc.

                                                                      {
   g_return_if_fail(FL_IS_PLATFORM_CHANNEL(self));
  
   g_autoptr(FlValue) args = fl_value_new_map();
   const gchar* type_string;
   switch (type) {
     case FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE:
       type_string = kExitTypeCancelable;
       break;
     case FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED:
       type_string = kExitTypeRequired;
       break;
     default:
       g_assert_not_reached();
   }
   fl_value_set_string_take(args, kExitTypeKey,
                            fl_value_new_string(type_string));
   fl_method_channel_invoke_method(self->channel, kRequestAppExitMethod, args,
                                   cancellable, callback, user_data);
 }

References args, fl_method_channel_invoke_method(), FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE, FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED, fl_value_new_map(), fl_value_new_string(), fl_value_set_string_take(), kExitTypeCancelable, kExitTypeKey, kExitTypeRequired, kRequestAppExitMethod, type, and user_data.

Referenced by request_app_exit(), and TEST().

◆ fl_platform_channel_system_request_app_exit_finish()

gboolean fl_platform_channel_system_request_app_exit_finish	(	GObject *	object,
		GAsyncResult *	result,
		FlPlatformChannelExitResponse *	exit_response,
		GError **	error
	)

Definition at line 268 of file fl_platform_channel.cc.

                     {
   g_autoptr(FlMethodResponse) response = fl_method_channel_invoke_method_finish(
       FL_METHOD_CHANNEL(object), result, error);
   if (response == nullptr) {
     return FALSE;
   }
  
   *exit_response = get_exit_response(response);
  
   return TRUE;
 }

References error, fl_method_channel_invoke_method_finish(), get_exit_response(), and TRUE.

Referenced by request_app_exit_response_cb(), and TEST().

◆ G_DECLARE_FINAL_TYPE()

G_DECLARE_FINAL_TYPE	(	FlPlatformChannel	,
		fl_platform_channel	,
		FL	,
		PLATFORM_CHANNEL	,
		GObject
	)

Classes

Enumerations

Functions