Matthew Kosarek 97c11cf89a
Implement Regular Windows for the win32 framework + add an example application for regular windows (#173715)
## What's new?
- Implement and test `_window_win32.dart`, the Win32 implementation of
`_window.dart` 🎉
- Wrote a bunch of tests in `window_win32_test.dart` which uses a mock
API barrier to mock the native Win32 layer
- Update `BaseWindowController` to extend `ChangeNotifier` and use it to
inform the `WindowScope` of when things change
- Made `RegularWindowController.empty()` a non-internal constructor, as
it is needed by implementations
- Added a _large_ example application for windowing where users can test
out different windowing concepts and see how they work!

To test, simply run the tests or try out the example app!

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
2025-09-26 13:37:02 +00:00

94 lines
2.7 KiB
Dart

// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// ignore_for_file: invalid_use_of_internal_member
// ignore_for_file: implementation_imports
import 'package:flutter/widgets.dart';
import 'package:flutter/src/widgets/_window.dart';
class KeyedWindow {
KeyedWindow({
this.parent,
this.isMainWindow = false,
required this.key,
required this.controller,
});
final BaseWindowController? parent;
final bool isMainWindow;
final UniqueKey key;
final BaseWindowController controller;
}
/// Provides access to the windows created by the application.
///
/// The window manager manages a flat list of all of the [BaseWindowController]s
/// that have been created by the application as well as which controller is
/// currently selected by the UI.
class WindowManager extends ChangeNotifier {
WindowManager({required List<KeyedWindow> initialWindows})
: _windows = initialWindows;
final List<KeyedWindow> _windows;
List<KeyedWindow> get windows => _windows;
void add(KeyedWindow window) {
_windows.add(window);
notifyListeners();
}
void remove(UniqueKey key) {
_windows.removeWhere((KeyedWindow window) => window.key == key);
notifyListeners();
}
}
/// Provides access to the [WindowManager] from the widget tree.
class WindowManagerAccessor extends InheritedNotifier<WindowManager> {
const WindowManagerAccessor({
super.key,
required super.child,
required WindowManager windowManager,
}) : super(notifier: windowManager);
static WindowManager of(BuildContext context) {
final WindowManagerAccessor? result = context
.dependOnInheritedWidgetOfExactType<WindowManagerAccessor>();
assert(result != null, 'No WindowManager found in context');
return result!.notifier!;
}
}
/// Settings that control the behavior of newly created windows.
class WindowSettings {
WindowSettings({this.regularSize = const Size(400, 300)});
/// The initial size for newly created regular windows.
Size regularSize;
}
/// Provides access to the [WindowSettings] from the widget tree.
class WindowSettingsAccessor extends InheritedWidget {
const WindowSettingsAccessor({
super.key,
required super.child,
required this.windowSettings,
});
final WindowSettings windowSettings;
static WindowSettings of(BuildContext context) {
final WindowSettingsAccessor? result = context
.dependOnInheritedWidgetOfExactType<WindowSettingsAccessor>();
assert(result != null, 'No WindowSettings found in context');
return result!.windowSettings;
}
@override
bool updateShouldNotify(WindowSettingsAccessor oldWidget) {
return windowSettings != oldWidget.windowSettings;
}
}