flutter::FlutterWindowsView Class Reference

#include <flutter_windows_view.h>

Inheritance diagram for flutter::FlutterWindowsView:

Public Member Functions
	FlutterWindowsView (FlutterViewId view_id, FlutterWindowsEngine *engine, std::unique_ptr< WindowBindingHandler > window_binding, std::shared_ptr< WindowsProcTable > windows_proc_table=nullptr)
virtual	~FlutterWindowsView ()
FlutterViewId	view_id () const
bool	IsImplicitView () const
void	CreateRenderSurface ()
egl::WindowSurface *	surface () const
virtual HWND	GetWindowHandle () const
FlutterWindowsEngine *	GetEngine () const
void	ForceRedraw ()
virtual bool	ClearSoftwareBitmap ()
virtual bool	PresentSoftwareBitmap (const void *allocation, size_t row_bytes, size_t height)
FlutterWindowMetricsEvent	CreateWindowMetricsEvent () const
void	SendInitialBounds ()
void	AnnounceAlert (const std::wstring &text)
void	OnHighContrastChanged () override
bool	OnEmptyFrameGenerated ()
bool	OnFrameGenerated (size_t width, size_t height)
virtual void	OnFramePresented ()
void	UpdateFlutterCursor (const std::string &cursor_name)
void	SetFlutterCursor (HCURSOR cursor)
bool	OnWindowSizeChanged (size_t width, size_t height) override
void	OnWindowRepaint () override
void	OnPointerMove (double x, double y, FlutterPointerDeviceKind device_kind, int32_t device_id, int modifiers_state) override
void	OnPointerDown (double x, double y, FlutterPointerDeviceKind device_kind, int32_t device_id, FlutterPointerMouseButtons button) override
void	OnPointerUp (double x, double y, FlutterPointerDeviceKind device_kind, int32_t device_id, FlutterPointerMouseButtons button) override
void	OnPointerLeave (double x, double y, FlutterPointerDeviceKind device_kind, int32_t device_id=0) override
virtual void	OnPointerPanZoomStart (int32_t device_id) override
virtual void	OnPointerPanZoomUpdate (int32_t device_id, double pan_x, double pan_y, double scale, double rotation) override
virtual void	OnPointerPanZoomEnd (int32_t device_id) override
void	OnText (const std::u16string &) override
void	OnKey (int key, int scancode, int action, char32_t character, bool extended, bool was_down, KeyEventCallback callback) override
void	OnComposeBegin () override
void	OnComposeCommit () override
void	OnComposeEnd () override
void	OnComposeChange (const std::u16string &text, int cursor_pos) override
void	OnScroll (double x, double y, double delta_x, double delta_y, int scroll_offset_multiplier, FlutterPointerDeviceKind device_kind, int32_t device_id) override
void	OnScrollInertiaCancel (int32_t device_id) override
virtual void	OnUpdateSemanticsEnabled (bool enabled) override
virtual gfx::NativeViewAccessible	GetNativeViewAccessible () override
virtual void	OnCursorRectUpdated (const Rect &rect)
virtual void	OnResetImeComposing ()
void	OnDwmCompositionChanged ()
ui::AXPlatformNodeWin *	AlertNode () const
virtual ui::AXFragmentRootDelegateWin *	GetAxFragmentRootDelegate () override
virtual void	UpdateSemanticsEnabled (bool enabled)
std::weak_ptr< AccessibilityBridgeWindows >	accessibility_bridge ()
void	OnWindowStateEvent (HWND hwnd, WindowStateEvent event) override

Protected Member Functions
virtual void	NotifyWinEventWrapper (ui::AXPlatformNodeWin *node, ax::mojom::Event event)
virtual std::shared_ptr< AccessibilityBridgeWindows >	CreateAccessibilityBridge ()

Friends
class	ViewModifier

Additional Inherited Members
Public Types inherited from flutter::WindowBindingHandlerDelegate
using	KeyEventCallback = std::function< void(bool)>

Detailed Description

Definition at line 34 of file flutter_windows_view.h.

Constructor & Destructor Documentation

FlutterWindowsView()

flutter::FlutterWindowsView::FlutterWindowsView	(	FlutterViewId	view_id,
		FlutterWindowsEngine *	engine,
		std::unique_ptr< WindowBindingHandler >	window_binding,
		std::shared_ptr< WindowsProcTable >	windows_proc_table = nullptr
	)

Definition at line 104 of file flutter_windows_view.cc.

    : view_id_(view_id),
      engine_(engine),
      windows_proc_table_(std::move(windows_proc_table)) {
  if (windows_proc_table_ == nullptr) {
    windows_proc_table_ = std::make_shared<WindowsProcTable>();
  }
 
  // Take the binding handler, and give it a pointer back to self.
  binding_handler_ = std::move(window_binding);
  binding_handler_->SetView(this);
}

~FlutterWindowsView()

flutter::FlutterWindowsView::~FlutterWindowsView ( )

virtual

Definition at line 121 of file flutter_windows_view.cc.

                                        {
  // The view owns the child window.
  // Notify the engine the view's child window will no longer be visible.
  engine_->OnWindowStateEvent(GetWindowHandle(), WindowStateEvent::kHide);
 
  if (surface_) {
    DestroyWindowSurface(*engine_, std::move(surface_));
  }
}

Member Function Documentation

accessibility_bridge()

std::weak_ptr< AccessibilityBridgeWindows > flutter::FlutterWindowsView::accessibility_bridge ( )

inline

Definition at line 242 of file flutter_windows_view.h.

                                                                 {
    return accessibility_bridge_;
  }

AlertNode()

ui::AXPlatformNodeWin * flutter::FlutterWindowsView::AlertNode

(

)

const

Definition at line 787 of file flutter_windows_view.cc.

                                                         {
  return binding_handler_->GetAlert();
}

AnnounceAlert()

void flutter::FlutterWindowsView::AnnounceAlert

(

const std::wstring &

text

)

Definition at line 766 of file flutter_windows_view.cc.

                                                             {
  auto alert_delegate = binding_handler_->GetAlertDelegate();
  if (!alert_delegate) {
    return;
  }
  alert_delegate->SetText(fml::WideStringToUtf16(text));
  ui::AXPlatformNodeWin* alert_node = binding_handler_->GetAlert();
  NotifyWinEventWrapper(alert_node, ax::mojom::Event::kAlert);
}

ClearSoftwareBitmap()

bool flutter::FlutterWindowsView::ClearSoftwareBitmap ( )

virtual

Definition at line 678 of file flutter_windows_view.cc.

                                             {
  return binding_handler_->OnBitmapSurfaceCleared();
}

CreateAccessibilityBridge()

std::shared_ptr< AccessibilityBridgeWindows > flutter::FlutterWindowsView::CreateAccessibilityBridge ( )

protectedvirtual

Definition at line 792 of file flutter_windows_view.cc.

                                              {
  return std::make_shared<AccessibilityBridgeWindows>(this);
}

CreateRenderSurface()

void flutter::FlutterWindowsView::CreateRenderSurface

(

)

Definition at line 697 of file flutter_windows_view.cc.

                                             {
  FML_DCHECK(surface_ == nullptr);
 
  if (engine_->egl_manager()) {
    PhysicalWindowBounds bounds = binding_handler_->GetPhysicalWindowBounds();
    surface_ = engine_->egl_manager()->CreateWindowSurface(
        GetWindowHandle(), bounds.width, bounds.height);
 
    UpdateVsync(*engine_, surface_.get(), NeedsVsync());
 
    resize_target_width_ = bounds.width;
    resize_target_height_ = bounds.height;
  }
}

CreateWindowMetricsEvent()

FlutterWindowMetricsEvent flutter::FlutterWindowsView::CreateWindowMetricsEvent

(

)

const

Definition at line 375 of file flutter_windows_view.cc.

                                                                             {
  PhysicalWindowBounds bounds = binding_handler_->GetPhysicalWindowBounds();
  double pixel_ratio = binding_handler_->GetDpiScale();
 
  FlutterWindowMetricsEvent event = {};
  event.struct_size = sizeof(event);
  event.width = bounds.width;
  event.height = bounds.height;
  event.pixel_ratio = pixel_ratio;
  event.view_id = view_id_;
 
  return event;
}

ForceRedraw()

void flutter::FlutterWindowsView::ForceRedraw

(

)

Definition at line 187 of file flutter_windows_view.cc.

                                     {
  if (resize_status_ == ResizeState::kDone) {
    // Request new frame.
    engine_->ScheduleFrame();
  }
}

GetAxFragmentRootDelegate()

ui::AXFragmentRootDelegateWin * flutter::FlutterWindowsView::GetAxFragmentRootDelegate ( )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 783 of file flutter_windows_view.cc.

                                                                           {
  return accessibility_bridge_.get();
}

GetEngine()

FlutterWindowsEngine * flutter::FlutterWindowsView::GetEngine

(

)

const

Definition at line 762 of file flutter_windows_view.cc.

                                                          {
  return engine_;
}

GetNativeViewAccessible()

gfx::NativeViewAccessible flutter::FlutterWindowsView::GetNativeViewAccessible ( )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 346 of file flutter_windows_view.cc.

                                                                    {
  if (!accessibility_bridge_) {
    return nullptr;
  }
 
  return accessibility_bridge_->GetChildOfAXFragmentRoot();
}

GetWindowHandle()

HWND flutter::FlutterWindowsView::GetWindowHandle ( ) const

virtual

Definition at line 758 of file flutter_windows_view.cc.

                                               {
  return binding_handler_->GetWindowHandle();
}

IsImplicitView()

bool flutter::FlutterWindowsView::IsImplicitView

(

)

const

Definition at line 693 of file flutter_windows_view.cc.

                                              {
  return view_id_ == kImplicitViewId;
}

NotifyWinEventWrapper()

void flutter::FlutterWindowsView::NotifyWinEventWrapper ( ui::AXPlatformNodeWin *  node, ax::mojom::Event  event  )

protectedvirtual

Definition at line 776 of file flutter_windows_view.cc.

                                                                   {
  if (node) {
    node->NotifyAccessibilityEvent(event);
  }
}

OnComposeBegin()

void flutter::FlutterWindowsView::OnComposeBegin ( )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 309 of file flutter_windows_view.cc.

                                        {
  SendComposeBegin();
}

OnComposeChange()

void flutter::FlutterWindowsView::OnComposeChange ( const std::u16string &  text, int  cursor_pos  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 321 of file flutter_windows_view.cc.

                                                         {
  SendComposeChange(text, cursor_pos);
}

OnComposeCommit()

void flutter::FlutterWindowsView::OnComposeCommit ( )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 313 of file flutter_windows_view.cc.

                                         {
  SendComposeCommit();
}

OnComposeEnd()

void flutter::FlutterWindowsView::OnComposeEnd ( )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 317 of file flutter_windows_view.cc.

                                      {
  SendComposeEnd();
}

OnCursorRectUpdated()

void flutter::FlutterWindowsView::OnCursorRectUpdated ( const Rect &  rect )

virtual

Definition at line 354 of file flutter_windows_view.cc.

                                                             {
  binding_handler_->OnCursorRectUpdated(rect);
}

OnDwmCompositionChanged()

void flutter::FlutterWindowsView::OnDwmCompositionChanged

(

)

Definition at line 808 of file flutter_windows_view.cc.

                                                 {
  UpdateVsync(*engine_, surface_.get(), NeedsVsync());
}

OnEmptyFrameGenerated()

bool flutter::FlutterWindowsView::OnEmptyFrameGenerated

(

)

Definition at line 131 of file flutter_windows_view.cc.

                                               {
  // Called on the raster thread.
  std::unique_lock<std::mutex> lock(resize_mutex_);
 
  if (surface_ == nullptr || !surface_->IsValid()) {
    return false;
  }
 
  if (resize_status_ != ResizeState::kResizeStarted) {
    return true;
  }
 
  if (!ResizeRenderSurface(resize_target_height_, resize_target_width_)) {
    return false;
  }
 
  // Platform thread is blocked for the entire duration until the
  // resize_status_ is set to kDone by |OnFramePresented|.
  resize_status_ = ResizeState::kFrameGenerated;
  return true;
}

OnFrameGenerated()

bool flutter::FlutterWindowsView::OnFrameGenerated	(	size_t	width,
		size_t	height
	)

Definition at line 153 of file flutter_windows_view.cc.

                                                                     {
  // Called on the raster thread.
  std::unique_lock<std::mutex> lock(resize_mutex_);
 
  if (surface_ == nullptr || !surface_->IsValid()) {
    return false;
  }
 
  if (resize_status_ != ResizeState::kResizeStarted) {
    return true;
  }
 
  if (resize_target_width_ != width || resize_target_height_ != height) {
    return false;
  }
 
  if (!ResizeRenderSurface(resize_target_width_, resize_target_height_)) {
    return false;
  }
 
  // Platform thread is blocked for the entire duration until the
  // resize_status_ is set to kDone by |OnFramePresented|.
  resize_status_ = ResizeState::kFrameGenerated;
  return true;
}

OnFramePresented()

void flutter::FlutterWindowsView::OnFramePresented ( )

virtual

Definition at line 646 of file flutter_windows_view.cc.

                                          {
  // Called on the engine's raster thread.
  std::unique_lock<std::mutex> lock(resize_mutex_);
 
  switch (resize_status_) {
    case ResizeState::kResizeStarted:
      // The caller must first call |OnFrameGenerated| or
      // |OnEmptyFrameGenerated| before calling this method. This
      // indicates one of the following:
      //
      // 1. The caller did not call these methods.
      // 2. The caller ignored these methods' result.
      // 3. The platform thread started a resize after the caller called these
      //    methods. We might have presented a frame of the wrong size to the
      //    view.
      return;
    case ResizeState::kFrameGenerated: {
      // A frame was generated for a pending resize.
      // Unblock the platform thread.
      resize_status_ = ResizeState::kDone;
      lock.unlock();
      resize_cv_.notify_all();
 
      // Blocking the raster thread until DWM flushes alleviates glitches where
      // previous size surface is stretched over current size view.
      windows_proc_table_->DwmFlush();
    }
    case ResizeState::kDone:
      return;
  }
}

OnHighContrastChanged()

void flutter::FlutterWindowsView::OnHighContrastChanged ( )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 754 of file flutter_windows_view.cc.

                                               {
  engine_->UpdateHighContrastMode();
}

OnKey()

void flutter::FlutterWindowsView::OnKey ( int  key, int  scancode, int  action, char32_t  character, bool  extended, bool  was_down, KeyEventCallback  callback  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 299 of file flutter_windows_view.cc.

                                                          {
  SendKey(key, scancode, action, character, extended, was_down, callback);
}

OnPointerDown()

void flutter::FlutterWindowsView::OnPointerDown ( double  x, double  y, FlutterPointerDeviceKind  device_kind, int32_t  device_id, FlutterPointerMouseButtons  button  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 245 of file flutter_windows_view.cc.

                                               {
  if (flutter_button != 0) {
    auto state = GetOrCreatePointerState(device_kind, device_id);
    state->buttons |= flutter_button;
    SendPointerDown(x, y, state);
  }
}

OnPointerLeave()

void flutter::FlutterWindowsView::OnPointerLeave ( double  x, double  y, FlutterPointerDeviceKind  device_kind, int32_t  device_id = 0  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 271 of file flutter_windows_view.cc.

                                                           {
  SendPointerLeave(x, y, GetOrCreatePointerState(device_kind, device_id));
}

OnPointerMove()

void flutter::FlutterWindowsView::OnPointerMove ( double  x, double  y, FlutterPointerDeviceKind  device_kind, int32_t  device_id, int  modifiers_state  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 236 of file flutter_windows_view.cc.

                                                            {
  engine_->keyboard_key_handler()->SyncModifiersIfNeeded(modifiers_state);
  SendPointerMove(x, y, GetOrCreatePointerState(device_kind, device_id));
}

OnPointerPanZoomEnd()

void flutter::FlutterWindowsView::OnPointerPanZoomEnd ( int32_t  device_id )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 291 of file flutter_windows_view.cc.

                                                              {
  SendPointerPanZoomEnd(device_id);
}

OnPointerPanZoomStart()

void flutter::FlutterWindowsView::OnPointerPanZoomStart ( int32_t  device_id )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 278 of file flutter_windows_view.cc.

                                                                {
  PointerLocation point = binding_handler_->GetPrimaryPointerLocation();
  SendPointerPanZoomStart(device_id, point.x, point.y);
}

OnPointerPanZoomUpdate()

void flutter::FlutterWindowsView::OnPointerPanZoomUpdate ( int32_t  device_id, double  pan_x, double  pan_y, double  scale, double  rotation  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 283 of file flutter_windows_view.cc.

                                                                 {
  SendPointerPanZoomUpdate(device_id, pan_x, pan_y, scale, rotation);
}

OnPointerUp()

void flutter::FlutterWindowsView::OnPointerUp ( double  x, double  y, FlutterPointerDeviceKind  device_kind, int32_t  device_id, FlutterPointerMouseButtons  button  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 258 of file flutter_windows_view.cc.

                                               {
  if (flutter_button != 0) {
    auto state = GetOrCreatePointerState(device_kind, device_id);
    state->buttons &= ~flutter_button;
    SendPointerUp(x, y, state);
  }
}

OnResetImeComposing()

void flutter::FlutterWindowsView::OnResetImeComposing ( )

virtual

Definition at line 358 of file flutter_windows_view.cc.

                                             {
  binding_handler_->OnResetImeComposing();
}

OnScroll()

void flutter::FlutterWindowsView::OnScroll ( double  x, double  y, double  delta_x, double  delta_y, int  scroll_offset_multiplier, FlutterPointerDeviceKind  device_kind, int32_t  device_id  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 326 of file flutter_windows_view.cc.

                                                     {
  SendScroll(x, y, delta_x, delta_y, scroll_offset_multiplier, device_kind,
             device_id);
}

OnScrollInertiaCancel()

void flutter::FlutterWindowsView::OnScrollInertiaCancel ( int32_t  device_id )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 337 of file flutter_windows_view.cc.

                                                                {
  PointerLocation point = binding_handler_->GetPrimaryPointerLocation();
  SendScrollInertiaCancel(device_id, point.x, point.y);
}

OnText()

void flutter::FlutterWindowsView::OnText ( const std::u16string &  text )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 295 of file flutter_windows_view.cc.

                                                        {
  SendText(text);
}

OnUpdateSemanticsEnabled()

void flutter::FlutterWindowsView::OnUpdateSemanticsEnabled ( bool  enabled )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 342 of file flutter_windows_view.cc.

                                                              {
  engine_->UpdateSemanticsEnabled(enabled);
}

OnWindowRepaint()

void flutter::FlutterWindowsView::OnWindowRepaint ( )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 232 of file flutter_windows_view.cc.

                                         {
  ForceRedraw();
}

OnWindowSizeChanged()

bool flutter::FlutterWindowsView::OnWindowSizeChanged ( size_t  width, size_t  height  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 194 of file flutter_windows_view.cc.

                                                                        {
  // Called on the platform thread.
  std::unique_lock<std::mutex> lock(resize_mutex_);
 
  if (!engine_->egl_manager()) {
    SendWindowMetrics(width, height, binding_handler_->GetDpiScale());
    return true;
  }
 
  if (!surface_ || !surface_->IsValid()) {
    SendWindowMetrics(width, height, binding_handler_->GetDpiScale());
    return true;
  }
 
  // We're using OpenGL rendering. Resizing the surface must happen on the
  // raster thread.
  bool surface_will_update =
      SurfaceWillUpdate(surface_->width(), surface_->height(), width, height);
  if (!surface_will_update) {
    SendWindowMetrics(width, height, binding_handler_->GetDpiScale());
    return true;
  }
 
  resize_status_ = ResizeState::kResizeStarted;
  resize_target_width_ = width;
  resize_target_height_ = height;
 
  SendWindowMetrics(width, height, binding_handler_->GetDpiScale());
 
  // Block the platform thread until a frame is presented with the target
  // size. See |OnFrameGenerated|, |OnEmptyFrameGenerated|, and
  // |OnFramePresented|.
  return resize_cv_.wait_for(lock, kWindowResizeTimeout,
                             [&resize_status = resize_status_] {
                               return resize_status == ResizeState::kDone;
                             });
}

OnWindowStateEvent()

void flutter::FlutterWindowsView::OnWindowStateEvent ( HWND  hwnd, WindowStateEvent  event  )

overridevirtual

Implements flutter::WindowBindingHandlerDelegate.

Definition at line 812 of file flutter_windows_view.cc.

                                                                             {
  engine_->OnWindowStateEvent(hwnd, event);
}

PresentSoftwareBitmap()

bool flutter::FlutterWindowsView::PresentSoftwareBitmap ( const void *  allocation, size_t  row_bytes, size_t  height  )

virtual

Definition at line 682 of file flutter_windows_view.cc.

                                                              {
  return binding_handler_->OnBitmapSurfaceUpdated(allocation, row_bytes,
                                                  height);
}

SendInitialBounds()

void flutter::FlutterWindowsView::SendInitialBounds

(

)

Definition at line 389 of file flutter_windows_view.cc.

                                           {
  // Non-implicit views' initial window metrics are sent when the view is added
  // to the engine.
  if (!IsImplicitView()) {
    return;
  }
 
  engine_->SendWindowMetricsEvent(CreateWindowMetricsEvent());
}

SetFlutterCursor()

void flutter::FlutterWindowsView::SetFlutterCursor

(

HCURSOR

cursor

)

Definition at line 183 of file flutter_windows_view.cc.

                                                        {
  binding_handler_->SetFlutterCursor(cursor);
}

surface()

egl::WindowSurface * flutter::FlutterWindowsView::surface

(

)

const

Definition at line 750 of file flutter_windows_view.cc.

                                                    {
  return surface_.get();
}

UpdateFlutterCursor()

void flutter::FlutterWindowsView::UpdateFlutterCursor

(

const std::string &

cursor_name

)

Definition at line 179 of file flutter_windows_view.cc.

                                                                         {
  binding_handler_->UpdateFlutterCursor(cursor_name);
}

UpdateSemanticsEnabled()

void flutter::FlutterWindowsView::UpdateSemanticsEnabled ( bool  enabled )

virtual

Definition at line 796 of file flutter_windows_view.cc.

                                                            {
  if (semantics_enabled_ != enabled) {
    semantics_enabled_ = enabled;
 
    if (!semantics_enabled_ && accessibility_bridge_) {
      accessibility_bridge_.reset();
    } else if (semantics_enabled_ && !accessibility_bridge_) {
      accessibility_bridge_ = CreateAccessibilityBridge();
    }
  }
}

view_id()

FlutterViewId flutter::FlutterWindowsView::view_id

(

)

const

Definition at line 689 of file flutter_windows_view.cc.

                                                {
  return view_id_;
}

Friends And Related Symbol Documentation

ViewModifier

friend class ViewModifier

friend

Definition at line 259 of file flutter_windows_view.h.

---

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

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