flutter::WindowManager Class Reference

#include <window_manager.h>

Public Member Functions
	WindowManager (FlutterWindowsEngine *engine)
virtual	~WindowManager ()=default
void	Initialize (const WindowingInitRequest *request)
FlutterViewId	CreateRegularWindow (const RegularWindowCreationRequest *request)
FlutterViewId	CreateDialogWindow (const DialogWindowCreationRequest *request)
FlutterViewId	CreateTooltipWindow (const TooltipWindowCreationRequest *request)
FlutterViewId	CreatePopupWindow (const PopupWindowCreationRequest *request)
std::optional< LRESULT >	HandleMessage (HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam)
void	OnEngineShutdown ()

Detailed Description

Definition at line 114 of file window_manager.h.

Constructor & Destructor Documentation

WindowManager()

flutter::WindowManager::WindowManager ( FlutterWindowsEngine *  engine )

explicit

Definition at line 25 of file window_manager.cc.

: engine_(engine) {}

~WindowManager()

virtual flutter::WindowManager::~WindowManager ( )

virtualdefault

Member Function Documentation

CreateDialogWindow()

FlutterViewId flutter::WindowManager::CreateDialogWindow

(

const DialogWindowCreationRequest *

request

)

Definition at line 46 of file window_manager.cc.

                                                {
  auto window = HostWindow::CreateDialogWindow(
      this, engine_, request->preferred_size, request->preferred_constraints,
      request->title, request->parent_or_null);
  if (!window || !window->GetWindowHandle()) {
    FML_LOG(ERROR) << "Failed to create host window";
    return -1;
  }
  FlutterViewId const view_id = window->view_controller_->view()->view_id();
  active_windows_[window->GetWindowHandle()] = std::move(window);
  return view_id;
}

References flutter::HostWindow::CreateDialogWindow(), FML_LOG, flutter::DialogWindowCreationRequest::parent_or_null, flutter::DialogWindowCreationRequest::preferred_constraints, flutter::DialogWindowCreationRequest::preferred_size, flutter::DialogWindowCreationRequest::title, view_id, and window.

CreatePopupWindow()

FlutterViewId flutter::WindowManager::CreatePopupWindow

(

const PopupWindowCreationRequest *

request

)

Definition at line 74 of file window_manager.cc.

                                               {
  auto window = HostWindow::CreatePopupWindow(
      this, engine_, request->preferred_constraints,
      request->get_position_callback, request->parent);
  if (!window || !window->GetWindowHandle()) {
    FML_LOG(ERROR) << "Failed to create host window";
    return -1;
  }
  FlutterViewId const view_id = window->view_controller_->view()->view_id();
  active_windows_[window->GetWindowHandle()] = std::move(window);
  return view_id;
}

References flutter::HostWindow::CreatePopupWindow(), FML_LOG, flutter::PopupWindowCreationRequest::get_position_callback, flutter::PopupWindowCreationRequest::parent, flutter::PopupWindowCreationRequest::preferred_constraints, view_id, and window.

CreateRegularWindow()

FlutterViewId flutter::WindowManager::CreateRegularWindow

(

const RegularWindowCreationRequest *

request

)

Definition at line 32 of file window_manager.cc.

                                                 {
  auto window = HostWindow::CreateRegularWindow(
      this, engine_, request->preferred_size, request->preferred_constraints,
      request->title);
  if (!window || !window->GetWindowHandle()) {
    FML_LOG(ERROR) << "Failed to create host window";
    return -1;
  }
  FlutterViewId const view_id = window->view_controller_->view()->view_id();
  active_windows_[window->GetWindowHandle()] = std::move(window);
  return view_id;
}

References flutter::HostWindow::CreateRegularWindow(), FML_LOG, flutter::RegularWindowCreationRequest::preferred_constraints, flutter::RegularWindowCreationRequest::preferred_size, flutter::RegularWindowCreationRequest::title, view_id, and window.

CreateTooltipWindow()

FlutterViewId flutter::WindowManager::CreateTooltipWindow

(

const TooltipWindowCreationRequest *

request

)

Definition at line 60 of file window_manager.cc.

                                                 {
  auto window = HostWindow::CreateTooltipWindow(
      this, engine_, request->preferred_constraints,
      request->get_position_callback, request->parent);
  if (!window || !window->GetWindowHandle()) {
    FML_LOG(ERROR) << "Failed to create host window";
    return -1;
  }
  FlutterViewId const view_id = window->view_controller_->view()->view_id();
  active_windows_[window->GetWindowHandle()] = std::move(window);
  return view_id;
}

References flutter::HostWindow::CreateTooltipWindow(), FML_LOG, flutter::TooltipWindowCreationRequest::get_position_callback, flutter::TooltipWindowCreationRequest::parent, flutter::TooltipWindowCreationRequest::preferred_constraints, view_id, and window.

HandleMessage()

std::optional< LRESULT > flutter::WindowManager::HandleMessage	(	HWND	hwnd,
		UINT	message,
		WPARAM	wparam,
		LPARAM	lparam
	)

Definition at line 104 of file window_manager.cc.

                                                                   {
  if (message == WM_NCDESTROY) {
    active_windows_.erase(hwnd);
    return std::nullopt;
  }
 
  HostWindow* host_window = HostWindow::GetThisFromHandle(hwnd);
  FlutterWindowsView* view =
      host_window ? host_window->view_controller_->view() : nullptr;
 
  if (!view) {
    FML_LOG(WARNING) << "Received message for unknown view";
    return std::nullopt;
  }
 
  WindowsMessage message_struct = {.view_id = view->view_id(),
                                   .hwnd = hwnd,
                                   .message = message,
                                   .wParam = wparam,
                                   .lParam = lparam,
                                   .result = 0,
                                   .handled = false};
 
  // Not initialized yet.
  if (!isolate_) {
    return std::nullopt;
  }
 
  IsolateScope scope(*isolate_);
  on_message_(&message_struct);
  if (message_struct.handled) {
    return message_struct.result;
  } else {
    return std::nullopt;
  }
}

References FML_LOG, flutter::HostWindow::GetThisFromHandle(), flutter::WindowsMessage::handled, message, flutter::WindowsMessage::result, view, flutter::HostWindow::view_controller_, and flutter::WindowsMessage::view_id.

Initialize()

void flutter::WindowManager::Initialize

(

const WindowingInitRequest *

request

)

Definition at line 27 of file window_manager.cc.

                                                                  {
  on_message_ = request->on_message;
  isolate_ = Isolate::Current();
}

References flutter::Isolate::Current(), and flutter::WindowingInitRequest::on_message.

OnEngineShutdown()

void flutter::WindowManager::OnEngineShutdown

(

)

Definition at line 88 of file window_manager.cc.

                                     {
  // Don't send any more messages to isolate.
  on_message_ = nullptr;
  std::vector<HWND> active_handles;
  active_handles.reserve(active_windows_.size());
  for (auto& [hwnd, window] : active_windows_) {
    active_handles.push_back(hwnd);
  }
  for (auto hwnd : active_handles) {
    // This will destroy the window, which will in turn remove the
    // HostWindow from map when handling WM_NCDESTROY inside
    // HandleMessage.
    InternalFlutterWindows_WindowManager_OnDestroyWindow(hwnd);
  }
}

References InternalFlutterWindows_WindowManager_OnDestroyWindow(), and window.

---

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

• shell/platform/windows/window_manager.h
• shell/platform/windows/window_manager.cc