Flutter Linux Embedder
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)
 
FlView * fl_view_new_sized_to_content (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 826 of file fl_view.cc.

826  {
827  g_return_val_if_fail(FL_IS_VIEW(self), nullptr);
828  return self->engine;
829 }

Referenced by TEST_F().

◆ 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 832 of file fl_view.cc.

832  {
833  g_return_val_if_fail(FL_IS_VIEW(self), -1);
834  return self->view_id;
835 }

Referenced by TEST_F().

◆ 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 778 of file fl_view.cc.

778  {
779  g_autoptr(FlEngine) engine = fl_engine_new(project);
780  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
781 
782  self->view_id = flutter::kFlutterImplicitViewId;
783  self->engine = FL_ENGINE(g_object_ref(engine));
784 
785  setup_engine(self);
786 
787  fl_engine_set_implicit_view(engine, FL_RENDERABLE(self));
788 
789  return self;
790 }
g_autoptr(FlEngine) engine
void fl_engine_set_implicit_view(FlEngine *self, FlRenderable *renderable)
Definition: fl_engine.cc:959
G_MODULE_EXPORT FlEngine * fl_engine_new(FlDartProject *project)
Definition: fl_engine.cc:732
static void setup_engine(FlView *self)
Definition: fl_view.cc:680

References fl_engine_new(), fl_engine_set_implicit_view(), g_autoptr(), and setup_engine().

Referenced by fl_application_activate(), and TEST_F().

◆ 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 792 of file fl_view.cc.

792  {
793  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
794 
795  self->engine = FL_ENGINE(g_object_ref(engine));
796 
797  size_t min_width = 1, min_height = 1, max_width = 1, max_height = 1;
798  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
799  self->view_id = fl_engine_add_view(
800  engine, FL_RENDERABLE(self), min_width, min_height, max_width, max_height,
801  scale_factor, self->cancellable, view_added_cb, self);
802 
803  setup_engine(self);
804 
805  return self;
806 }
FlutterViewId fl_engine_add_view(FlEngine *self, FlRenderable *renderable, size_t min_width, size_t min_height, size_t max_width, size_t max_height, double pixel_ratio, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
Definition: fl_engine.cc:963
static void view_added_cb(GObject *object, GAsyncResult *result, gpointer user_data)
Definition: fl_view.cc:221

References fl_engine_add_view(), setup_engine(), and view_added_cb().

Referenced by FlAccessibilityHandlerTest::SetUp(), and TEST_F().

◆ fl_view_new_sized_to_content()

FlView* fl_view_new_sized_to_content ( FlEngine *  engine)

fl_view_new_sized_to_content: @engine: an #FlEngine.

Creates a widget to show a window in a Flutter application. The window will always display content in the size that Flutter provides. The engine must be not be headless.

Returns: a new #FlView.

Definition at line 808 of file fl_view.cc.

808  {
809  FlView* self = FL_VIEW(g_object_new(fl_view_get_type(), nullptr));
810 
811  self->engine = FL_ENGINE(g_object_ref(engine));
812 
813  self->sized_to_content = TRUE;
814  size_t min_width = 1, min_height = 1, max_width = G_MAXSIZE,
815  max_height = G_MAXSIZE;
816  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
817  self->view_id = fl_engine_add_view(
818  engine, FL_RENDERABLE(self), min_width, min_height, max_width, max_height,
819  scale_factor, self->cancellable, view_added_cb, self);
820 
821  setup_engine(self);
822 
823  return self;
824 }

References fl_engine_add_view(), setup_engine(), TRUE, and view_added_cb().

Referenced by TEST_F().

◆ 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 837 of file fl_view.cc.

838  {
839  g_return_if_fail(FL_IS_VIEW(self));
840  fl_view_renderer_set_background_color(self->renderer, color);
841 }
void fl_view_renderer_set_background_color(FlViewRenderer *self, const GdkRGBA *color)

References fl_view_renderer_set_background_color().