-
Notifications
You must be signed in to change notification settings - Fork 636
/
Copy pathwindow.rs
1622 lines (1440 loc) · 63 KB
/
window.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
863
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright © SixtyFPS GmbH <[email protected]>
// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0
// cSpell: ignore backtab
#![warn(missing_docs)]
//! Exposed Window API
use crate::api::{
CloseRequestResponse, LogicalPosition, PhysicalPosition, PhysicalSize, PlatformError, Window,
WindowPosition, WindowSize,
};
use crate::graphics::Point;
use crate::input::{
key_codes, ClickState, InternalKeyboardModifierState, KeyEvent, KeyEventType, MouseEvent,
MouseInputState, TextCursorBlinker,
};
use crate::item_tree::ItemRc;
use crate::item_tree::{ItemTreeRc, ItemTreeRef, ItemTreeVTable, ItemTreeWeak};
use crate::items::{ColorScheme, InputType, ItemRef, MouseCursor};
use crate::lengths::{LogicalLength, LogicalPoint, LogicalRect, SizeLengths};
use crate::properties::{Property, PropertyTracker};
use crate::renderer::Renderer;
use crate::{Callback, Coord, SharedString};
#[cfg(not(feature = "std"))]
use alloc::boxed::Box;
use alloc::rc::{Rc, Weak};
use core::cell::{Cell, RefCell};
use core::pin::Pin;
use euclid::num::Zero;
use vtable::VRcMapped;
fn next_focus_item(item: ItemRc) -> ItemRc {
item.next_focus_item()
}
fn previous_focus_item(item: ItemRc) -> ItemRc {
item.previous_focus_item()
}
/// This trait represents the adaptation layer between the [`Window`] API and then
/// windowing specific window representation, such as a Win32 `HWND` handle or a `wayland_surface_t`.
///
/// Implement this trait to establish the link between the two, and pass messages in both
/// directions:
///
/// - When receiving messages from the windowing system about state changes, such as the window being resized,
/// the user requested the window to be closed, input being received, etc. you need to create a
/// [`crate::platform::WindowEvent`](enum.WindowEvent.html) and send it to Slint via [`create::Window::dispatch_event()`](../struct.Window.html#method.dispatch_event).
///
/// - Slint sends requests to change visibility, position, size, etc. via functions such as [`Self::set_visible`],
/// [`Self::set_size`], [`Self::set_position`], or [`Self::update_window_properties()`]. Re-implement these functions
/// and delegate the requests to the windowing system.
///
/// If the implementation of this bi-directional message passing protocol is incomplete, the user may
/// experience unexpected behavior, or the intention of the developer calling functions on the [`crate::Window`](struct.Window.html)
/// API may not be fulfilled.
///
/// Your implementation must hold a renderer, such as [`crate::software_renderer::SoftwareRenderer`].
/// In the [`Self::renderer()`] function, you must return a reference to it.
///
/// It is also required to hold a [`crate::Window`](struct.Window.html) and return a reference to it in your
/// implementation of [`Self::window()`].
///
/// See also [`MinimalSoftwareWindow`](crate::software_renderer::MinimalSoftwareWindow)
/// for a minimal implementation of this trait using the software renderer
pub trait WindowAdapter {
/// Returns the window API.
fn window(&self) -> &Window;
/// Show the window if the argument is true, hide otherwise.
fn set_visible(&self, _visible: bool) -> Result<(), PlatformError> {
Ok(())
}
/// Returns the position of the window on the screen, in physical screen coordinates and including
/// a window frame (if present).
///
/// The default implementation returns `None`
///
/// Called from [`Window::position()`]
fn position(&self) -> Option<PhysicalPosition> {
None
}
/// Sets the position of the window on the screen, in physical screen coordinates and including
/// a window frame (if present).
///
/// The default implementation does nothing
///
/// Called from [`Window::set_position()`]
fn set_position(&self, _position: WindowPosition) {}
/// Request a new size for the window to the specified size on the screen, in physical or logical pixels
/// and excluding a window frame (if present).
///
/// This is called from [`Window::set_size()`]
///
/// The default implementation does nothing
///
/// This function should sent the size to the Windowing system. If the window size actually changes, you
/// should dispatch a [`WindowEvent::Resized`](crate::platform::WindowEvent::Resized) using
/// [`Window::dispatch_event()`] to propagate the new size to the slint view
fn set_size(&self, _size: WindowSize) {}
/// Return the size of the Window on the screen
fn size(&self) -> PhysicalSize;
/// Issues a request to the windowing system to re-render the contents of the window.
///
/// This request is typically asynchronous.
/// It is called when a property that was used during window rendering is marked as dirty.
///
/// An implementation should repaint the window in a subsequent iteration of the event loop,
/// throttled to the screen refresh rate if possible.
/// It is important not to query any Slint properties to avoid introducing a dependency loop in the properties,
/// including the use of the render function, which itself queries properties.
///
/// See also [`Window::request_redraw()`]
fn request_redraw(&self) {}
/// Return the renderer.
///
/// The `Renderer` trait is an internal trait that you are not expected to implement.
/// In your implementation you should return a reference to an instance of one of the renderers provided by Slint.
///
/// Currently, the only public struct that implement renderer is [`SoftwareRenderer`](crate::software_renderer::SoftwareRenderer).
fn renderer(&self) -> &dyn Renderer;
/// Re-implement this function to update the properties such as window title or layout constraints.
///
/// This function is called before `set_visible(true)`, and will be called again when the properties
/// that were queried on the last call are changed. If you do not query any properties, it may not
/// be called again.
fn update_window_properties(&self, _properties: WindowProperties<'_>) {}
#[doc(hidden)]
fn internal(&self, _: crate::InternalToken) -> Option<&dyn WindowAdapterInternal> {
None
}
/// Re-implement this to support exposing raw window handles (version 0.6).
#[cfg(feature = "raw-window-handle-06")]
fn window_handle_06(
&self,
) -> Result<raw_window_handle_06::WindowHandle<'_>, raw_window_handle_06::HandleError> {
Err(raw_window_handle_06::HandleError::NotSupported)
}
/// Re-implement this to support exposing raw display handles (version 0.6).
#[cfg(feature = "raw-window-handle-06")]
fn display_handle_06(
&self,
) -> Result<raw_window_handle_06::DisplayHandle<'_>, raw_window_handle_06::HandleError> {
Err(raw_window_handle_06::HandleError::NotSupported)
}
}
/// Implementation details behind [`WindowAdapter`], but since this
/// trait is not exported in the public API, it is not possible for the
/// users to call or re-implement these functions.
// TODO: add events for window receiving and loosing focus
#[doc(hidden)]
pub trait WindowAdapterInternal {
/// This function is called by the generated code when a component and therefore its tree of items are created.
fn register_item_tree(&self) {}
/// This function is called by the generated code when a component and therefore its tree of items are destroyed. The
/// implementation typically uses this to free the underlying graphics resources cached via [`crate::graphics::RenderingCache`].
fn unregister_item_tree(
&self,
_component: ItemTreeRef,
_items: &mut dyn Iterator<Item = Pin<ItemRef<'_>>>,
) {
}
/// Create a window for a popup.
///
/// `geometry` is the location of the popup in the window coordinate
///
/// If this function return None (the default implementation), then the
/// popup will be rendered within the window itself.
fn create_popup(&self, _geometry: LogicalRect) -> Option<Rc<dyn WindowAdapter>> {
None
}
/// Set the mouse cursor
// TODO: Make the enum public and make public
fn set_mouse_cursor(&self, _cursor: MouseCursor) {}
/// This method allow editable input field to communicate with the platform about input methods
fn input_method_request(&self, _: InputMethodRequest) {}
/// Return self as any so the backend can upcast
// TODO: consider using the as_any crate, or deriving the traint from Any to provide a better default
fn as_any(&self) -> &dyn core::any::Any {
&()
}
/// Handle focus change
// used for accessibility
fn handle_focus_change(&self, _old: Option<ItemRc>, _new: Option<ItemRc>) {}
/// returns the color scheme used
fn color_scheme(&self) -> ColorScheme {
ColorScheme::Unknown
}
/// Re-implement this to support exposing raw window handles (version 0.6).
#[cfg(feature = "raw-window-handle-06")]
fn window_handle_06_rc(
&self,
) -> Result<Rc<dyn raw_window_handle_06::HasWindowHandle>, raw_window_handle_06::HandleError>
{
Err(raw_window_handle_06::HandleError::NotSupported)
}
/// Re-implement this to support exposing raw display handles (version 0.6).
#[cfg(feature = "raw-window-handle-06")]
fn display_handle_06_rc(
&self,
) -> Result<Rc<dyn raw_window_handle_06::HasDisplayHandle>, raw_window_handle_06::HandleError>
{
Err(raw_window_handle_06::HandleError::NotSupported)
}
}
/// This is the parameter from [`WindowAdapterInternal::input_method_request()`] which lets the editable text input field
/// communicate with the platform about input methods.
#[non_exhaustive]
#[derive(Debug, Clone)]
pub enum InputMethodRequest {
/// Enables the input method with the specified properties.
Enable(InputMethodProperties),
/// Updates the input method with new properties.
Update(InputMethodProperties),
/// Disables the input method.
Disable,
}
/// This struct holds properties related to an input method.
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct InputMethodProperties {
/// The text surrounding the cursor.
///
/// This field does not include pre-edit text or composition.
pub text: SharedString,
/// The position of the cursor in bytes within the `text`.
pub cursor_position: usize,
/// When there is a selection, this is the position of the second anchor
/// for the beginning (or the end) of the selection.
pub anchor_position: Option<usize>,
/// The current value of the pre-edit text as known by the input method.
/// This is the text currently being edited but not yet committed.
/// When empty, there is no pre-edit text.
pub preedit_text: SharedString,
/// When the `preedit_text` is not empty, this is the offset of the pre-edit within the `text`.
pub preedit_offset: usize,
/// The top-left corner of the cursor rectangle in window coordinates.
pub cursor_rect_origin: LogicalPosition,
/// The size of the cursor rectangle.
pub cursor_rect_size: crate::api::LogicalSize,
/// The position of the anchor (bottom). Only meaningful if anchor_position is Some
pub anchor_point: LogicalPosition,
/// The type of input for the text edit.
pub input_type: InputType,
}
/// This struct describes layout constraints of a resizable element, such as a window.
#[non_exhaustive]
#[derive(Copy, Clone, Debug, PartialEq, Default)]
pub struct LayoutConstraints {
/// The minimum size.
pub min: Option<crate::api::LogicalSize>,
/// The maximum size.
pub max: Option<crate::api::LogicalSize>,
/// The preferred size.
pub preferred: crate::api::LogicalSize,
}
/// This struct contains getters that provide access to properties of the `Window`
/// element, and is used with [`WindowAdapter::update_window_properties`].
pub struct WindowProperties<'a>(&'a WindowInner);
impl<'a> WindowProperties<'a> {
/// Returns the Window's title
pub fn title(&self) -> SharedString {
self.0.window_item().map(|w| w.as_pin_ref().title()).unwrap_or_default()
}
/// The background color or brush of the Window
pub fn background(&self) -> crate::Brush {
self.0
.window_item()
.map(|w: VRcMapped<ItemTreeVTable, crate::items::WindowItem>| {
w.as_pin_ref().background()
})
.unwrap_or_default()
}
/// Returns the layout constraints of the window
pub fn layout_constraints(&self) -> LayoutConstraints {
let component = self.0.component();
let component = ItemTreeRc::borrow_pin(&component);
let h = component.as_ref().layout_info(crate::layout::Orientation::Horizontal);
let v = component.as_ref().layout_info(crate::layout::Orientation::Vertical);
let (min, max) = crate::layout::min_max_size_for_layout_constraints(h, v);
LayoutConstraints {
min,
max,
preferred: crate::api::LogicalSize::new(
h.preferred_bounded() as f32,
v.preferred_bounded() as f32,
),
}
}
/// Returns true if the window should be shown fullscreen; false otherwise.
#[deprecated(note = "Please use `is_fullscreen` instead")]
pub fn fullscreen(&self) -> bool {
self.is_fullscreen()
}
/// Returns true if the window should be shown fullscreen; false otherwise.
pub fn is_fullscreen(&self) -> bool {
self.0.fullscreen.get()
}
/// true if the window is in a maximized state, otherwise false
pub fn is_maximized(&self) -> bool {
self.0.maximized.get()
}
/// true if the window is in a minimized state, otherwise false
pub fn is_minimized(&self) -> bool {
self.0.minimized.get()
}
}
struct WindowPropertiesTracker {
window_adapter_weak: Weak<dyn WindowAdapter>,
}
impl crate::properties::PropertyDirtyHandler for WindowPropertiesTracker {
fn notify(self: Pin<&Self>) {
let win = self.window_adapter_weak.clone();
crate::timers::Timer::single_shot(Default::default(), move || {
if let Some(window_adapter) = win.upgrade() {
WindowInner::from_pub(window_adapter.window()).update_window_properties();
};
})
}
}
struct WindowRedrawTracker {
window_adapter_weak: Weak<dyn WindowAdapter>,
}
impl crate::properties::PropertyDirtyHandler for WindowRedrawTracker {
fn notify(self: Pin<&Self>) {
if let Some(window_adapter) = self.window_adapter_weak.upgrade() {
window_adapter.request_redraw();
};
}
}
/// This enum describes the different ways a popup can be rendered by the back-end.
enum PopupWindowLocation {
/// The popup is rendered in its own top-level window that is know to the windowing system.
TopLevel(Rc<dyn WindowAdapter>),
/// The popup is rendered as an embedded child window at the given position.
ChildWindow(LogicalPoint),
}
/// This structure defines a graphical element that is designed to pop up from the surrounding
/// UI content, for example to show a context menu.
struct PopupWindow {
/// The location defines where the pop up is rendered.
location: PopupWindowLocation,
/// The component that is responsible for providing the popup content.
component: ItemTreeRc,
/// If true, Slint will close the popup after any mouse click within the popup.
/// Set to false and call close() on the PopupWindow to close it manually.
close_on_click: bool,
}
#[pin_project::pin_project]
struct WindowPinnedFields {
#[pin]
redraw_tracker: PropertyTracker<WindowRedrawTracker>,
/// Gets dirty when the layout restrictions, or some other property of the windows change
#[pin]
window_properties_tracker: PropertyTracker<WindowPropertiesTracker>,
#[pin]
scale_factor: Property<f32>,
#[pin]
active: Property<bool>,
#[pin]
text_input_focused: Property<bool>,
}
/// Inner datastructure for the [`crate::api::Window`]
pub struct WindowInner {
window_adapter_weak: Weak<dyn WindowAdapter>,
component: RefCell<ItemTreeWeak>,
/// When the window is visible, keep a strong reference
strong_component_ref: RefCell<Option<ItemTreeRc>>,
mouse_input_state: Cell<MouseInputState>,
pub(crate) modifiers: Cell<InternalKeyboardModifierState>,
/// ItemRC that currently have the focus. (possibly a, instance of TextInput)
pub focus_item: RefCell<crate::item_tree::ItemWeak>,
/// The last text that was sent to the input method
pub(crate) last_ime_text: RefCell<SharedString>,
/// Don't let ComponentContainers's instantiation change the focus.
/// This is a workaround for a recursion when instantiating ComponentContainer because the
/// init code for the component might have code that sets the focus, but we don't want that
/// for the ComponentContainer
pub(crate) prevent_focus_change: Cell<bool>,
cursor_blinker: RefCell<pin_weak::rc::PinWeak<crate::input::TextCursorBlinker>>,
pinned_fields: Pin<Box<WindowPinnedFields>>,
fullscreen: Cell<bool>,
maximized: Cell<bool>,
minimized: Cell<bool>,
active_popup: RefCell<Option<PopupWindow>>,
had_popup_on_press: Cell<bool>,
close_requested: Callback<(), CloseRequestResponse>,
click_state: ClickState,
pub(crate) ctx: once_cell::unsync::Lazy<crate::SlintContext>,
}
impl Drop for WindowInner {
fn drop(&mut self) {
if let Some(existing_blinker) = self.cursor_blinker.borrow().upgrade() {
existing_blinker.stop();
}
}
}
impl WindowInner {
/// Create a new instance of the window, given the window_adapter factory fn
pub fn new(window_adapter_weak: Weak<dyn WindowAdapter>) -> Self {
#![allow(unused_mut)]
let mut window_properties_tracker =
PropertyTracker::new_with_dirty_handler(WindowPropertiesTracker {
window_adapter_weak: window_adapter_weak.clone(),
});
let mut redraw_tracker = PropertyTracker::new_with_dirty_handler(WindowRedrawTracker {
window_adapter_weak: window_adapter_weak.clone(),
});
#[cfg(slint_debug_property)]
{
window_properties_tracker
.set_debug_name("i_slint_core::Window::window_properties_tracker".into());
redraw_tracker.set_debug_name("i_slint_core::Window::redraw_tracker".into());
}
Self {
window_adapter_weak,
component: Default::default(),
strong_component_ref: Default::default(),
mouse_input_state: Default::default(),
modifiers: Default::default(),
pinned_fields: Box::pin(WindowPinnedFields {
redraw_tracker,
window_properties_tracker,
scale_factor: Property::new_named(1., "i_slint_core::Window::scale_factor"),
active: Property::new_named(false, "i_slint_core::Window::active"),
text_input_focused: Property::new_named(
false,
"i_slint_core::Window::text_input_focused",
),
}),
#[cfg(feature = "std")]
fullscreen: Cell::new(std::env::var("SLINT_FULLSCREEN").is_ok()),
#[cfg(not(feature = "std"))]
fullscreen: Cell::new(false),
maximized: Cell::new(false),
minimized: Cell::new(false),
focus_item: Default::default(),
last_ime_text: Default::default(),
cursor_blinker: Default::default(),
active_popup: Default::default(),
had_popup_on_press: Default::default(),
close_requested: Default::default(),
click_state: ClickState::default(),
prevent_focus_change: Default::default(),
// The ctx is lazy so that a Window can be initialized before the backend.
// (for example in test_empty_window)
ctx: once_cell::unsync::Lazy::new(|| {
crate::context::GLOBAL_CONTEXT.with(|ctx| ctx.get().unwrap().clone())
}),
}
}
/// Associates this window with the specified component. Further event handling and rendering, etc. will be
/// done with that component.
pub fn set_component(&self, component: &ItemTreeRc) {
self.close_popup();
self.focus_item.replace(Default::default());
self.mouse_input_state.replace(Default::default());
self.modifiers.replace(Default::default());
self.component.replace(ItemTreeRc::downgrade(component));
self.pinned_fields.window_properties_tracker.set_dirty(); // component changed, layout constraints for sure must be re-calculated
let window_adapter = self.window_adapter();
window_adapter.renderer().set_window_adapter(&window_adapter);
{
let component = ItemTreeRc::borrow_pin(component);
let root_item = component.as_ref().get_item_ref(0);
let window_item = ItemRef::downcast_pin::<crate::items::WindowItem>(root_item).unwrap();
let default_font_size_prop =
crate::items::WindowItem::FIELD_OFFSETS.default_font_size.apply_pin(window_item);
if default_font_size_prop.get().get() <= 0 as Coord {
default_font_size_prop.set(window_adapter.renderer().default_font_size());
}
}
self.set_window_item_geometry(
window_adapter.size().to_logical(self.scale_factor()).to_euclid(),
);
window_adapter.request_redraw();
let weak = Rc::downgrade(&window_adapter);
crate::timers::Timer::single_shot(Default::default(), move || {
if let Some(window_adapter) = weak.upgrade() {
WindowInner::from_pub(window_adapter.window()).update_window_properties();
}
})
}
/// return the component.
/// Panics if it wasn't set.
pub fn component(&self) -> ItemTreeRc {
self.component.borrow().upgrade().unwrap()
}
/// returns the component or None if it isn't set.
pub fn try_component(&self) -> Option<ItemTreeRc> {
self.component.borrow().upgrade()
}
/// Receive a mouse event and pass it to the items of the component to
/// change their state.
///
/// Arguments:
/// * `pos`: The position of the mouse event in window physical coordinates.
/// * `what`: The type of mouse event.
/// * `component`: The Slint compiled component that provides the tree of items.
pub fn process_mouse_input(&self, mut event: MouseEvent) {
crate::animations::update_animations();
// handle multiple press release
event = self.click_state.check_repeat(event, self.ctx.platform().click_interval());
let pressed_event = matches!(event, MouseEvent::Pressed { .. });
let released_event = matches!(event, MouseEvent::Released { .. });
let window_adapter = self.window_adapter();
let mut mouse_input_state = self.mouse_input_state.take();
let last_top_item = mouse_input_state.top_item_including_delayed();
if released_event {
mouse_input_state =
crate::input::process_delayed_event(&window_adapter, mouse_input_state);
}
if pressed_event {
self.had_popup_on_press.set(self.active_popup.borrow().is_some());
}
let close_popup_on_click = self.close_popup_on_click();
let mut mouse_inside_popup = false;
mouse_input_state = if let Some(mut event) =
crate::input::handle_mouse_grab(event, &window_adapter, &mut mouse_input_state)
{
let (item_tree, offset) = if let Some(PopupWindow {
location: PopupWindowLocation::ChildWindow(coordinates),
component,
..
}) = self.active_popup.borrow().as_ref()
{
let geom = ItemTreeRc::borrow_pin(component).as_ref().item_geometry(0);
mouse_inside_popup = event
.position()
.map_or(true, |pos| geom.contains(pos - coordinates.to_vector()));
if mouse_inside_popup {
(Some(component.clone()), *coordinates)
} else {
(None, LogicalPoint::default())
}
} else {
(self.component.borrow().upgrade(), LogicalPoint::default())
};
if let Some(item_tree) = item_tree {
event.translate(-offset.to_vector());
let mut new_input_state = crate::input::process_mouse_input(
item_tree,
event,
&window_adapter,
mouse_input_state,
);
new_input_state.offset = offset;
new_input_state
} else {
// When outside, send exit event
let mut new_input_state = MouseInputState::default();
crate::input::send_exit_events(
&mouse_input_state,
&mut new_input_state,
event.position(),
&window_adapter,
);
new_input_state
}
} else {
mouse_input_state
};
if last_top_item != mouse_input_state.top_item_including_delayed() {
self.click_state.reset();
self.click_state.check_repeat(event, self.ctx.platform().click_interval());
}
self.mouse_input_state.set(mouse_input_state);
if close_popup_on_click
&& ((mouse_inside_popup && released_event && self.had_popup_on_press.get())
|| (!mouse_inside_popup && pressed_event))
{
self.close_popup();
}
crate::properties::ChangeTracker::run_change_handlers();
}
/// Called by the input code's internal timer to send an event that was delayed
pub(crate) fn process_delayed_event(&self) {
self.mouse_input_state.set(crate::input::process_delayed_event(
&self.window_adapter(),
self.mouse_input_state.take(),
));
}
/// Receive a key event and pass it to the items of the component to
/// change their state.
///
/// Arguments:
/// * `event`: The key event received by the windowing system.
/// * `component`: The Slint compiled component that provides the tree of items.
pub fn process_key_input(&self, mut event: KeyEvent) {
if let Some(updated_modifier) = self
.modifiers
.get()
.state_update(event.event_type == KeyEventType::KeyPressed, &event.text)
{
// Updates the key modifiers depending on the key code and pressed state.
self.modifiers.set(updated_modifier);
}
event.modifiers = self.modifiers.get().into();
let mut item = self.focus_item.borrow().clone().upgrade();
while let Some(focus_item) = item {
if !focus_item.is_visible() {
// Reset the focus... not great, but better than keeping it.
self.take_focus_item();
} else if focus_item.borrow().as_ref().key_event(
&event,
&self.window_adapter(),
&focus_item,
) == crate::input::KeyEventResult::EventAccepted
{
crate::properties::ChangeTracker::run_change_handlers();
return;
}
item = focus_item.parent_item();
}
// Make Tab/Backtab handle keyboard focus
let extra_mod = event.modifiers.control || event.modifiers.meta || event.modifiers.alt;
if event.text.starts_with(key_codes::Tab)
&& !event.modifiers.shift
&& !extra_mod
&& event.event_type == KeyEventType::KeyPressed
{
self.focus_next_item();
} else if (event.text.starts_with(key_codes::Backtab)
|| (event.text.starts_with(key_codes::Tab) && event.modifiers.shift))
&& event.event_type == KeyEventType::KeyPressed
&& !extra_mod
{
self.focus_previous_item();
}
crate::properties::ChangeTracker::run_change_handlers();
}
/// Installs a binding on the specified property that's toggled whenever the text cursor is supposed to be visible or not.
pub fn set_cursor_blink_binding(&self, prop: &crate::Property<bool>) {
let existing_blinker = self.cursor_blinker.borrow().clone();
let blinker = existing_blinker.upgrade().unwrap_or_else(|| {
let new_blinker = TextCursorBlinker::new();
*self.cursor_blinker.borrow_mut() =
pin_weak::rc::PinWeak::downgrade(new_blinker.clone());
new_blinker
});
TextCursorBlinker::set_binding(blinker, prop);
}
/// Sets the focus to the item pointed to by item_ptr. This will remove the focus from any
/// currently focused item. If set_focus is false, the focus is cleared.
pub fn set_focus_item(&self, new_focus_item: &ItemRc, set_focus: bool) {
if self.prevent_focus_change.get() {
return;
}
if !set_focus {
let current_focus_item = self.focus_item.borrow().clone();
if let Some(current_focus_item_rc) = current_focus_item.upgrade() {
if current_focus_item_rc != *new_focus_item {
// can't clear focus unless called with currently focused item.
return;
}
}
}
let old = self.take_focus_item();
let new =
if set_focus { self.move_focus(new_focus_item.clone(), next_focus_item) } else { None };
let window_adapter = self.window_adapter();
if let Some(window_adapter) = window_adapter.internal(crate::InternalToken) {
window_adapter.handle_focus_change(old, new);
}
}
/// Take the focus_item out of this Window
///
/// This sends the FocusOut event!
fn take_focus_item(&self) -> Option<ItemRc> {
let focus_item = self.focus_item.take();
if let Some(focus_item_rc) = focus_item.upgrade() {
focus_item_rc.borrow().as_ref().focus_event(
&crate::input::FocusEvent::FocusOut,
&self.window_adapter(),
&focus_item_rc,
);
Some(focus_item_rc)
} else {
None
}
}
/// Publish the new focus_item to this Window and return the FocusEventResult
///
/// This sends a FocusIn event!
fn publish_focus_item(&self, item: &Option<ItemRc>) -> crate::input::FocusEventResult {
match item {
Some(item) => {
*self.focus_item.borrow_mut() = item.downgrade();
item.borrow().as_ref().focus_event(
&crate::input::FocusEvent::FocusIn,
&self.window_adapter(),
item,
)
}
None => {
*self.focus_item.borrow_mut() = Default::default();
crate::input::FocusEventResult::FocusAccepted // We were removing the focus, treat that as OK
}
}
}
fn move_focus(&self, start_item: ItemRc, forward: impl Fn(ItemRc) -> ItemRc) -> Option<ItemRc> {
let mut current_item = start_item;
let mut visited = alloc::vec::Vec::new();
loop {
if current_item.is_visible()
&& self.publish_focus_item(&Some(current_item.clone()))
== crate::input::FocusEventResult::FocusAccepted
{
return Some(current_item); // Item was just published.
}
visited.push(current_item.clone());
current_item = forward(current_item);
if visited.iter().any(|i| *i == current_item) {
return None; // Nothing to do: We took the focus_item already
}
}
}
/// Move keyboard focus to the next item
pub fn focus_next_item(&self) {
let component = self.component();
let start_item = self
.take_focus_item()
.map(next_focus_item)
.unwrap_or_else(|| ItemRc::new(component, 0));
let end_item = self.move_focus(start_item.clone(), next_focus_item);
let window_adapter = self.window_adapter();
if let Some(window_adapter) = window_adapter.internal(crate::InternalToken) {
window_adapter.handle_focus_change(Some(start_item), end_item);
}
}
/// Move keyboard focus to the previous item.
pub fn focus_previous_item(&self) {
let component = self.component();
let start_item = previous_focus_item(
self.take_focus_item().unwrap_or_else(|| ItemRc::new(component, 0)),
);
let end_item = self.move_focus(start_item.clone(), previous_focus_item);
let window_adapter = self.window_adapter();
if let Some(window_adapter) = window_adapter.internal(crate::InternalToken) {
window_adapter.handle_focus_change(Some(start_item), end_item);
}
}
/// Marks the window to be the active window. This typically coincides with the keyboard
/// focus. One exception though is when a popup is shown, in which case the window may
/// remain active but temporarily loose focus to the popup.
///
/// This results in WindowFocusReceived and WindowFocusLost events.
pub fn set_active(&self, have_focus: bool) {
self.pinned_fields.as_ref().project_ref().active.set(have_focus);
let event = if have_focus {
crate::input::FocusEvent::WindowReceivedFocus
} else {
crate::input::FocusEvent::WindowLostFocus
};
if let Some(focus_item) = self.focus_item.borrow().upgrade() {
focus_item.borrow().as_ref().focus_event(&event, &self.window_adapter(), &focus_item);
}
// If we lost focus due to for example a global shortcut, then when we regain focus
// should not assume that the modifiers are in the same state.
if !have_focus {
self.modifiers.take();
}
}
/// Returns true of the window is the active window. That typically implies having the
/// keyboard focus, except when a popup is shown and temporarily takes the focus.
pub fn active(&self) -> bool {
self.pinned_fields.as_ref().project_ref().active.get()
}
/// If the component's root item is a Window element, then this function synchronizes its properties, such as the title
/// for example, with the properties known to the windowing system.
pub fn update_window_properties(&self) {
let window_adapter = self.window_adapter();
// No `if !dirty { return; }` check here because the backend window may be newly mapped and not up-to-date, so force
// an evaluation.
self.pinned_fields
.as_ref()
.project_ref()
.window_properties_tracker
.evaluate_as_dependency_root(|| {
window_adapter.update_window_properties(WindowProperties(self));
});
}
/// Calls the render_components to render the main component and any sub-window components, tracked by a
/// property dependency tracker.
/// Returns None if no component is set yet.
pub fn draw_contents<T>(
&self,
render_components: impl FnOnce(&[(&ItemTreeRc, LogicalPoint)]) -> T,
) -> Option<T> {
let draw_fn = || {
let component_rc = self.try_component()?;
let popup_component =
self.active_popup.borrow().as_ref().and_then(|popup| match popup.location {
PopupWindowLocation::TopLevel(..) => None,
PopupWindowLocation::ChildWindow(coordinates) => {
Some((popup.component.clone(), coordinates))
}
});
Some(if let Some((popup_component, popup_coordinates)) = popup_component {
render_components(&[
(&component_rc, LogicalPoint::default()),
(&popup_component, popup_coordinates),
])
} else {
render_components(&[(&component_rc, LogicalPoint::default())])
})
};
self.pinned_fields
.as_ref()
.project_ref()
.redraw_tracker
.evaluate_as_dependency_root(draw_fn)
}
/// Registers the window with the windowing system, in order to render the component's items and react
/// to input events once the event loop spins.
pub fn show(&self) -> Result<(), PlatformError> {
if let Some(component) = self.try_component() {
let was_visible = self.strong_component_ref.replace(Some(component)).is_some();
if !was_visible {
*(self.ctx.0.window_count.borrow_mut()) += 1;
}
}
self.update_window_properties();
self.window_adapter().set_visible(true)?;
// Make sure that the window's inner size is in sync with the root window item's
// width/height.
let size = self.window_adapter().size();
self.set_window_item_geometry(size.to_logical(self.scale_factor()).to_euclid());
self.window_adapter().renderer().resize(size).unwrap();
if let Some(hook) = self.ctx.0.window_shown_hook.borrow_mut().as_mut() {
hook(&self.window_adapter());
}
Ok(())
}
/// De-registers the window with the windowing system.
pub fn hide(&self) -> Result<(), PlatformError> {
let result = self.window_adapter().set_visible(false);
let was_visible = self.strong_component_ref.borrow_mut().take().is_some();
if was_visible {
let mut count = self.ctx.0.window_count.borrow_mut();
*count -= 1;
if *count <= 0 {
drop(count);
let _ = self.ctx.event_loop_proxy().and_then(|p| p.quit_event_loop().ok());
}
}
result
}
/// returns the color theme used
pub fn color_scheme(&self) -> ColorScheme {
self.window_adapter()
.internal(crate::InternalToken)
.map_or(ColorScheme::Unknown, |x| x.color_scheme())
}
/// Show a popup at the given position relative to the item
pub fn show_popup(
&self,
popup_componentrc: &ItemTreeRc,
position: Point,
close_on_click: bool,
parent_item: &ItemRc,
) {
let position = parent_item.map_to_window(
parent_item.geometry().origin + LogicalPoint::from_untyped(position).to_vector(),
);
let popup_component = ItemTreeRc::borrow_pin(popup_componentrc);
let popup_root = popup_component.as_ref().get_item_ref(0);
let (mut w, mut h) = if let Some(window_item) =
ItemRef::downcast_pin::<crate::items::WindowItem>(popup_root)
{
(window_item.width(), window_item.height())
} else {
(LogicalLength::zero(), LogicalLength::zero())
};
let layout_info_h =
popup_component.as_ref().layout_info(crate::layout::Orientation::Horizontal);
let layout_info_v =
popup_component.as_ref().layout_info(crate::layout::Orientation::Vertical);
if w <= LogicalLength::zero() {
w = LogicalLength::new(layout_info_h.preferred);
}
if h <= LogicalLength::zero() {
h = LogicalLength::new(layout_info_v.preferred);
}
w = w.max(LogicalLength::new(layout_info_h.min)).min(LogicalLength::new(layout_info_h.max));
h = h.max(LogicalLength::new(layout_info_v.min)).min(LogicalLength::new(layout_info_v.max));
let size = crate::lengths::LogicalSize::from_lengths(w, h);
if let Some(window_item) = ItemRef::downcast_pin(popup_root) {
let width_property =
crate::items::WindowItem::FIELD_OFFSETS.width.apply_pin(window_item);
let height_property =
crate::items::WindowItem::FIELD_OFFSETS.height.apply_pin(window_item);
width_property.set(size.width_length());
height_property.set(size.height_length());
};