flutter::FlutterWindowController Class Reference

#include <flutter_window_controller.h>

Inheritance diagram for flutter::FlutterWindowController:

Public Member Functions
	FlutterWindowController (const std::string &icu_data_path)
virtual	~FlutterWindowController ()
	FlutterWindowController (FlutterWindowController const &)=delete
FlutterWindowController &	operator= (FlutterWindowController const &)=delete
bool	CreateWindow (const WindowProperties &window_properties, const std::string &assets_path, const std::vector< std::string > &arguments, const std::string &aot_library_path="")
void	DestroyWindow ()
FlutterWindow *	window ()
bool	RunEventLoopWithTimeout (std::chrono::milliseconds timeout=std::chrono::milliseconds::max())
void	RunEventLoop ()
FlutterDesktopPluginRegistrarRef	GetRegistrarForPlugin (const std::string &plugin_name) override
Public Member Functions inherited from flutter::PluginRegistry
	PluginRegistry ()=default
virtual	~PluginRegistry ()=default
	PluginRegistry (PluginRegistry const &)=delete
PluginRegistry &	operator= (PluginRegistry const &)=delete

Detailed Description

Definition at line 44 of file flutter_window_controller.h.

Constructor & Destructor Documentation

FlutterWindowController() [1/2]

FlutterWindowController::FlutterWindowController ( const std::string &  icu_data_path )

explicit

Definition at line 12 of file flutter_window_controller.cc.

    : icu_data_path_(icu_data_path) {
  init_succeeded_ = FlutterDesktopInit();
}

References FlutterDesktopInit().

~FlutterWindowController()

FlutterWindowController::~FlutterWindowController ( )

virtual

Definition at line 18 of file flutter_window_controller.cc.

                                                  {
  if (controller_) {
    FlutterDesktopDestroyWindow(controller_);
  }
  if (init_succeeded_) {
    FlutterDesktopTerminate();
  }
}

References FlutterDesktopDestroyWindow(), and FlutterDesktopTerminate().

FlutterWindowController() [2/2]

flutter::FlutterWindowController::FlutterWindowController ( FlutterWindowController const &  )

delete

Member Function Documentation

CreateWindow()

bool FlutterWindowController::CreateWindow	(	const WindowProperties &	window_properties,
		const std::string &	assets_path,
		const std::vector< std::string > &	arguments,
		const std::string &	aot_library_path = ""
	)

Definition at line 27 of file flutter_window_controller.cc.

                                       {
  if (!init_succeeded_) {
    std::cerr << "Could not create window; FlutterDesktopInit failed."
              << std::endl;
    return false;
  }
 
  if (controller_) {
    std::cerr << "Only one Flutter window can exist at a time." << std::endl;
    return false;
  }
 
  FlutterDesktopWindowProperties c_window_properties = {};
  c_window_properties.title = window_properties.title.c_str();
  c_window_properties.width = window_properties.width;
  c_window_properties.height = window_properties.height;
  c_window_properties.prevent_resize = window_properties.prevent_resize;
 
  FlutterDesktopEngineProperties c_engine_properties = {};
  c_engine_properties.assets_path = assets_path.c_str();
  c_engine_properties.aot_library_path = aot_library_path.c_str();
  c_engine_properties.icu_data_path = icu_data_path_.c_str();
  std::vector<const char*> engine_switches;
  std::transform(
      arguments.begin(), arguments.end(), std::back_inserter(engine_switches),
      [](const std::string& arg) -> const char* { return arg.c_str(); });
  if (!engine_switches.empty()) {
    c_engine_properties.switches = &engine_switches[0];
    c_engine_properties.switches_count = engine_switches.size();
  }
 
  controller_ =
      FlutterDesktopCreateWindow(c_window_properties, c_engine_properties);
  if (!controller_) {
    std::cerr << "Failed to create window." << std::endl;
    return false;
  }
  window_ =
      std::make_unique<FlutterWindow>(FlutterDesktopGetWindow(controller_));
  return true;
}

References FlutterDesktopEngineProperties::aot_library_path, FlutterDesktopEngineProperties::assets_path, FlutterDesktopCreateWindow(), FlutterDesktopGetWindow(), flutter::WindowProperties::height, FlutterDesktopWindowProperties::height, FlutterDesktopEngineProperties::icu_data_path, flutter::WindowProperties::prevent_resize, FlutterDesktopWindowProperties::prevent_resize, FlutterDesktopEngineProperties::switches, FlutterDesktopEngineProperties::switches_count, flutter::WindowProperties::title, FlutterDesktopWindowProperties::title, flutter::WindowProperties::width, and FlutterDesktopWindowProperties::width.

DestroyWindow()

void FlutterWindowController::DestroyWindow

(

)

Definition at line 73 of file flutter_window_controller.cc.

                                            {
  if (controller_) {
    FlutterDesktopDestroyWindow(controller_);
    controller_ = nullptr;
    window_ = nullptr;
  }
}

References FlutterDesktopDestroyWindow().

Referenced by RunEventLoopWithTimeout().

GetRegistrarForPlugin()

FlutterDesktopPluginRegistrarRef FlutterWindowController::GetRegistrarForPlugin ( const std::string &  plugin_name )

overridevirtual

Implements flutter::PluginRegistry.

Definition at line 81 of file flutter_window_controller.cc.

                                  {
  if (!controller_) {
    std::cerr << "Cannot get plugin registrar without a window; call "
                 "CreateWindow first."
              << std::endl;
    return nullptr;
  }
  return FlutterDesktopGetPluginRegistrar(FlutterDesktopGetEngine(controller_),
                                          plugin_name.c_str());
}

References FlutterDesktopGetEngine(), and FlutterDesktopGetPluginRegistrar().

operator=()

FlutterWindowController & flutter::FlutterWindowController::operator= ( FlutterWindowController const &  )

delete

RunEventLoop()

void FlutterWindowController::RunEventLoop

(

)

Definition at line 118 of file flutter_window_controller.cc.

                                           {
  while (RunEventLoopWithTimeout()) {
  }
}

References RunEventLoopWithTimeout().

RunEventLoopWithTimeout()

bool FlutterWindowController::RunEventLoopWithTimeout

(

std::chrono::milliseconds

timeout = std::chrono::milliseconds::max()

)

Definition at line 93 of file flutter_window_controller.cc.

                                   {
  if (!controller_) {
    std::cerr << "Cannot run event loop without a window window; call "
                 "CreateWindow first."
              << std::endl;
    return false;
  }
  uint32_t timeout_milliseconds;
  if (timeout == std::chrono::milliseconds::max()) {
    // The C API uses 0 to represent no timeout, so convert |max| to 0.
    timeout_milliseconds = 0;
  } else if (timeout.count() > UINT32_MAX) {
    timeout_milliseconds = UINT32_MAX;
  } else {
    timeout_milliseconds = static_cast<uint32_t>(timeout.count());
  }
  bool still_running = FlutterDesktopRunWindowEventLoopWithTimeout(
      controller_, timeout_milliseconds);
  if (!still_running) {
    DestroyWindow();
  }
  return still_running;
}

References DestroyWindow(), FlutterDesktopRunWindowEventLoopWithTimeout(), and UINT32_MAX.

Referenced by RunEventLoop().

window()

FlutterWindow * flutter::FlutterWindowController::window ( )

inline

Definition at line 88 of file flutter_window_controller.h.

{ return window_.get(); }

---

The documentation for this class was generated from the following files:

• shell/platform/glfw/client_wrapper/include/flutter/flutter_window_controller.h
• shell/platform/glfw/client_wrapper/flutter_window_controller.cc