fl_view.h File Reference

#include <gmodule.h>
#include <gtk/gtk.h>
#include "fl_dart_project.h"
#include "fl_engine.h"

Go to the source code of this file.

Functions
G_BEGIN_DECLS G_MODULE_EXPORT FlView *	fl_view_new (FlDartProject *project)
FlView *	fl_view_new_for_engine (FlEngine *engine)
FlEngine *	fl_view_get_engine (FlView *view)
int64_t	fl_view_get_id (FlView *view)
void	fl_view_set_background_color (FlView *view, const GdkRGBA *color)

Function Documentation

fl_view_get_engine()

FlEngine* fl_view_get_engine

(

FlView *

view

)

fl_view_get_engine: @view: an #FlView.

Gets the engine being rendered in the view.

Returns: an #FlEngine.

Definition at line 827 of file fl_view.cc.

                                                           {
  g_return_val_if_fail(FL_IS_VIEW(self), nullptr);
  return self->engine;
}

Referenced by TEST().

fl_view_get_id()

int64_t fl_view_get_id

(

FlView *

view

)

fl_view_get_id: @view: an #FlView.

Gets the Flutter view ID used by this view.

Returns: a view ID or -1 if now ID assigned.

Definition at line 833 of file fl_view.cc.

                                     {
  g_return_val_if_fail(FL_IS_VIEW(self), -1);
  return self->view_id;
}

Referenced by TEST().

fl_view_new()

G_BEGIN_DECLS G_MODULE_EXPORT FlView* fl_view_new

(

FlDartProject *

project

)

FlView:

#FlView is a GTK widget that is capable of displaying a Flutter application.

The following example shows how to set up a view in a GTK application: |[ FlDartProject *project = fl_dart_project_new (); FlView *view = fl_view_new (project); gtk_widget_show (GTK_WIDGET (view)); gtk_container_add (GTK_CONTAINER (parent), view);

FlBinaryMessenger *messenger = fl_engine_get_binary_messenger (fl_view_get_engine (view)); setup_channels_or_plugins (messenger); ]| fl_view_new: @project: The project to show.

Creates a widget to show a Flutter application.

Returns: a new #FlView.

Definition at line 775 of file fl_view.cc.

                                                            {
  g_autoptr(FlEngine) engine = fl_engine_new(project);
  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
 
  self->view_id = flutter::kFlutterImplicitViewId;
  self->engine = FL_ENGINE(g_object_ref(engine));
  FlRenderer* renderer = fl_engine_get_renderer(engine);
  g_assert(FL_IS_RENDERER_GDK(renderer));
  self->renderer = FL_RENDERER_GDK(g_object_ref(renderer));
 
  self->pointer_manager = fl_pointer_manager_new(self->view_id, engine);
 
  fl_engine_set_update_semantics_handler(self->engine, update_semantics_cb,
                                         self, nullptr);
  self->on_pre_engine_restart_cb_id =
      g_signal_connect_swapped(engine, "on-pre-engine-restart",
                               G_CALLBACK(on_pre_engine_restart_cb), self);
 
  g_signal_connect_swapped(self->gl_area, "create-context",
                           G_CALLBACK(create_context_cb), self);
  g_signal_connect_swapped(self->gl_area, "realize", G_CALLBACK(realize_cb),
                           self);
  g_signal_connect_swapped(self->gl_area, "unrealize", G_CALLBACK(unrealize_cb),
                           self);
 
  return self;
}

References create_context_cb(), fl_engine_get_renderer(), fl_engine_new(), fl_engine_set_update_semantics_handler(), fl_pointer_manager_new(), on_pre_engine_restart_cb(), realize_cb(), unrealize_cb(), and update_semantics_cb().

Referenced by fl_application_activate(), and TEST().

fl_view_new_for_engine()

FlView* fl_view_new_for_engine

(

FlEngine *

engine

)

fl_view_new_for_engine: @engine: an #FlEngine.

Creates a widget to show a window in a Flutter application. The engine must be not be headless.

Returns: a new #FlView.

Definition at line 803 of file fl_view.cc.

                                                                 {
  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
 
  self->engine = FL_ENGINE(g_object_ref(engine));
  FlRenderer* renderer = fl_engine_get_renderer(engine);
  g_assert(FL_IS_RENDERER_GDK(renderer));
  self->renderer = FL_RENDERER_GDK(g_object_ref(renderer));
 
  self->on_pre_engine_restart_cb_id =
      g_signal_connect_swapped(engine, "on-pre-engine-restart",
                               G_CALLBACK(on_pre_engine_restart_cb), self);
 
  self->view_id = fl_engine_add_view(self->engine, 1, 1, 1.0, self->cancellable,
                                     view_added_cb, self);
  fl_renderer_add_renderable(FL_RENDERER(self->renderer), self->view_id,
                             FL_RENDERABLE(self));
 
  self->pointer_manager = fl_pointer_manager_new(self->view_id, engine);
 
  setup_cursor(self);
 
  return self;
}

References fl_engine_add_view(), fl_engine_get_renderer(), fl_pointer_manager_new(), fl_renderer_add_renderable(), on_pre_engine_restart_cb(), setup_cursor(), and view_added_cb().

Referenced by TEST().

fl_view_set_background_color()

void fl_view_set_background_color	(	FlView *	view,
		const GdkRGBA *	color
	)

fl_view_set_background_color: @view: an #FlView. @color: a background color.

Set the background color for Flutter (defaults to black).

Definition at line 838 of file fl_view.cc.

                                                                        {
  g_return_if_fail(FL_IS_VIEW(self));
  gdk_rgba_free(self->background_color);
  self->background_color = gdk_rgba_copy(color);
}