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

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

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

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

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 705 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));
 
  setup_engine(self);
 
  fl_engine_set_implicit_view(engine, FL_RENDERABLE(self));
 
  return self;
}

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 719 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));
 
  size_t min_width = 1, min_height = 1, max_width = 1, max_height = 1;
  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
  self->view_id = fl_engine_add_view(
      engine, FL_RENDERABLE(self), min_width, min_height, max_width, max_height,
      scale_factor, self->cancellable, view_added_cb, self);
 
  setup_engine(self);
 
  return self;
}

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 735 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));
 
  self->sized_to_content = TRUE;
  size_t min_width = 1, min_height = 1, max_width = G_MAXSIZE,
         max_height = G_MAXSIZE;
  gint scale_factor = gtk_widget_get_scale_factor(GTK_WIDGET(self));
  self->view_id = fl_engine_add_view(
      engine, FL_RENDERABLE(self), min_width, min_height, max_width, max_height,
      scale_factor, self->cancellable, view_added_cb, self);
 
  setup_engine(self);
 
  return self;
}

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

                                                                        {
  g_return_if_fail(FL_IS_VIEW(self));
  fl_view_renderer_set_background_color(self->renderer, color);
}

References fl_view_renderer_set_background_color().