zng_view_api/types.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 594 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
//! General event types.
use crate::{
access::{AccessCmd, AccessNodeId},
api_extension::{ApiExtensionId, ApiExtensionPayload, ApiExtensions},
config::{
AnimationsConfig, ChromeConfig, ColorsConfig, FontAntiAliasing, KeyRepeatConfig, LocaleConfig, MultiClickConfig, TouchConfig,
},
dialog::{DialogId, FileDialogResponse, MsgDialogResponse},
drag_drop::{DragDropData, DragDropEffect},
image::{ImageId, ImageLoadedData, ImagePpi},
ipc::IpcBytes,
keyboard::{Key, KeyCode, KeyLocation, KeyState},
mouse::{ButtonId, ButtonState, MouseButton, MouseScrollDelta},
touch::{TouchPhase, TouchUpdate},
window::{EventFrameRendered, FrameId, HeadlessOpenData, MonitorId, MonitorInfo, WindowChanged, WindowId, WindowOpenData},
};
use serde::{Deserialize, Serialize};
use std::fmt;
use zng_txt::Txt;
use zng_unit::{DipPoint, PxRect, PxSize, Rgba};
macro_rules! declare_id {
($(
$(#[$docs:meta])+
pub struct $Id:ident(_);
)+) => {$(
$(#[$docs])+
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(transparent)]
pub struct $Id(u32);
impl $Id {
/// Dummy ID, zero.
pub const INVALID: Self = Self(0);
/// Create the first valid ID.
pub const fn first() -> Self {
Self(1)
}
/// Create the next ID.
///
/// IDs wrap around to [`first`] when the entire `u32` space is used, it is never `INVALID`.
///
/// [`first`]: Self::first
#[must_use]
pub const fn next(self) -> Self {
let r = Self(self.0.wrapping_add(1));
if r.0 == Self::INVALID.0 {
Self::first()
} else {
r
}
}
/// Returns self and replace self with [`next`].
///
/// [`next`]: Self::next
#[must_use]
pub fn incr(&mut self) -> Self {
std::mem::replace(self, self.next())
}
/// Get the raw ID.
pub const fn get(self) -> u32 {
self.0
}
/// Create an ID using a custom value.
///
/// Note that only the documented process must generate IDs, and that it must only
/// generate IDs using this function or the [`next`] function.
///
/// If the `id` is zero it will still be [`INVALID`] and handled differently by the other process,
/// zero is never valid.
///
/// [`next`]: Self::next
/// [`INVALID`]: Self::INVALID
pub const fn from_raw(id: u32) -> Self {
Self(id)
}
}
)+};
}
pub(crate) use declare_id;
declare_id! {
/// Device ID in channel.
///
/// In the View Process this is mapped to a system id.
///
/// In the App Process this is mapped to an unique id, but does not survived View crashes.
///
/// The View Process defines the ID.
pub struct DeviceId(_);
/// View-process generation, starts at one and changes every respawn, it is never zero.
///
/// The View Process defines the ID.
pub struct ViewProcessGen(_);
}
/// Identifier for a specific analog axis on some device.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct AxisId(pub u32);
/// Identifier for a drag drop operation.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct DragDropId(pub u32);
#[derive(Debug, Clone, Serialize, Deserialize)]
/// View process is online.
///
/// The [`ViewProcessGen`] is the generation of the new view-process, it must be passed to
/// [`Controller::handle_inited`].
///
/// [`Controller::handle_inited`]: crate::Controller::handle_inited
pub struct Inited {
/// View-process generation, changes after respawns and is never zero.
pub generation: ViewProcessGen,
/// If the view-process is a respawn from a previous crashed process.
pub is_respawn: bool,
/// Available monitors.
pub available_monitors: Vec<(MonitorId, MonitorInfo)>,
/// System multi-click config.
pub multi_click_config: MultiClickConfig,
/// System keyboard pressed key repeat start delay config.
pub key_repeat_config: KeyRepeatConfig,
/// System touch config.
pub touch_config: TouchConfig,
/// System font anti-aliasing config.
pub font_aa: FontAntiAliasing,
/// System animations config.
pub animations_config: AnimationsConfig,
/// System locale config.
pub locale_config: LocaleConfig,
/// System preferred color scheme and colors.
pub colors_config: ColorsConfig,
/// Window chrome (decorations) preference.
pub chrome_config: ChromeConfig,
/// API extensions implemented by the view-process.
///
/// The extension IDs will stay valid for the duration of the view-process.
pub extensions: ApiExtensions,
}
/// IME preview or insert event.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Ime {
/// Preview an IME insert at the last non-preview caret/selection.
///
/// The associated values are the preview string and caret/selection inside the preview string.
///
/// The preview must visually replace the last non-preview selection or insert at the last non-preview
/// caret index. If the preview string is empty the preview must be cancelled.
Preview(Txt, (usize, usize)),
/// Apply an IME insert at the last non-preview caret/selection. The caret must be moved to
/// the end of the inserted sub-string.
Commit(Txt),
}
/// System and User events sent from the View Process.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Event {
/// View-process inited.
Inited(Inited),
/// View-process suspended.
Suspended,
/// The event channel disconnected, probably because the view-process crashed.
///
/// The [`ViewProcessGen`] is the generation of the view-process that was lost, it must be passed to
/// [`Controller::handle_disconnect`].
///
/// [`Controller::handle_disconnect`]: crate::Controller::handle_disconnect
Disconnected(ViewProcessGen),
/// Window, context and renderer have finished initializing and is ready to receive commands.
WindowOpened(WindowId, WindowOpenData),
/// Headless context and renderer have finished initializing and is ready to receive commands.
HeadlessOpened(WindowId, HeadlessOpenData),
/// Window open or headless context open request failed.
WindowOrHeadlessOpenError {
/// Id from the request.
id: WindowId,
/// Error message.
error: Txt,
},
/// A frame finished rendering.
///
/// `EventsCleared` is not send after this event.
FrameRendered(EventFrameRendered),
/// Window moved, resized, or minimized/maximized etc.
///
/// This event aggregates events moves, resizes and other state changes into a
/// single event to simplify tracking composite changes, for example, the window changes size and position
/// when maximized, this can be trivially observed with this event.
///
/// The [`EventCause`] can be used to identify a state change initiated by the app.
///
/// [`EventCause`]: crate::window::EventCause
WindowChanged(WindowChanged),
/// A drag&drop gesture started dragging over the window.
DragHovered {
/// Window that is hovered.
window: WindowId,
/// Data payload.
data: Vec<DragDropData>,
/// Allowed effects.
allowed: DragDropEffect,
},
/// A drag&drop gesture moved over the window.
DragMoved {
/// Window that is hovered.
window: WindowId,
/// Cursor positions in between the previous event and this one.
coalesced_pos: Vec<DipPoint>,
/// Cursor position, relative to the window top-left in device independent pixels.
position: DipPoint,
},
/// A drag&drop gesture finished over the window.
DragDropped {
/// Window that received the file drop.
window: WindowId,
/// Data payload.
data: Vec<DragDropData>,
/// Allowed effects.
allowed: DragDropEffect,
/// ID of this drop operation.
///
/// Handlers must call `drag_dropped` with this ID and what effect was applied to the data.
drop_id: DragDropId,
},
/// A drag&drop gesture stopped hovering the window without dropping.
DragCancelled {
/// Window that was previous hovered.
window: WindowId,
},
/// A drag started by the app was dropped or canceled.
AppDragEnded {
/// Window that started the drag.
window: WindowId,
/// Drag ID.
drag: DragDropId,
/// Effect applied to the data by the drop target.
///
/// Is a single flag if the data was dropped in a valid drop target, or is empty if was canceled.
applied: DragDropEffect,
},
/// App window(s) focus changed.
FocusChanged {
/// Window that lost focus.
prev: Option<WindowId>,
/// Window that got focus.
new: Option<WindowId>,
},
/// An event from the keyboard has been received.
///
/// This event is only send if the window is focused, all pressed keys should be considered released
/// after [`FocusChanged`] to `None`. Modifier keys receive special treatment, after they are pressed,
/// the modifier key state is monitored directly so that the `Released` event is always send, unless the
/// focus changed to none.
///
/// [`FocusChanged`]: Self::FocusChanged
KeyboardInput {
/// Window that received the key event.
window: WindowId,
/// Device that generated the key event.
device: DeviceId,
/// Physical key.
key_code: KeyCode,
/// If the key was pressed or released.
state: KeyState,
/// The location of the key on the keyboard.
key_location: KeyLocation,
/// Semantic key unmodified.
///
/// Pressing `Shift+A` key will produce `Key::Char('a')` in QWERTY keyboards, the modifiers are not applied. Note that
/// the numpad keys do not represents the numbers unmodified
key: Key,
/// Semantic key modified by the current active modifiers.
///
/// Pressing `Shift+A` key will produce `Key::Char('A')` in QWERTY keyboards, the modifiers are applied.
key_modified: Key,
/// Text typed.
///
/// This is only set during [`KeyState::Pressed`] of a key that generates text.
///
/// This is usually the `key_modified` char, but is also `'\r'` for `Key::Enter`. On Windows when a dead key was
/// pressed earlier but cannot be combined with the character from this key press, the produced text
/// will consist of two characters: the dead-key-character followed by the character resulting from this key press.
text: Txt,
},
/// IME composition event.
Ime {
/// Window that received the IME event.
window: WindowId,
/// IME event.
ime: Ime,
},
/// The mouse cursor has moved on the window.
///
/// This event can be coalesced, i.e. multiple cursor moves packed into the same event.
MouseMoved {
/// Window that received the cursor move.
window: WindowId,
/// Device that generated the cursor move.
device: DeviceId,
/// Cursor positions in between the previous event and this one.
coalesced_pos: Vec<DipPoint>,
/// Cursor position, relative to the window top-left in device independent pixels.
position: DipPoint,
},
/// The mouse cursor has entered the window.
MouseEntered {
/// Window that now is hovered by the cursor.
window: WindowId,
/// Device that generated the cursor move event.
device: DeviceId,
},
/// The mouse cursor has left the window.
MouseLeft {
/// Window that is no longer hovered by the cursor.
window: WindowId,
/// Device that generated the cursor move event.
device: DeviceId,
},
/// A mouse wheel movement or touchpad scroll occurred.
MouseWheel {
/// Window that was hovered by the cursor when the mouse wheel was used.
window: WindowId,
/// Device that generated the mouse wheel event.
device: DeviceId,
/// Delta of change in the mouse scroll wheel state.
delta: MouseScrollDelta,
/// Touch state if the device that generated the event is a touchpad.
phase: TouchPhase,
},
/// An mouse button press has been received.
MouseInput {
/// Window that was hovered by the cursor when the mouse button was used.
window: WindowId,
/// Mouse device that generated the event.
device: DeviceId,
/// If the button was pressed or released.
state: ButtonState,
/// The mouse button.
button: MouseButton,
},
/// Touchpad pressure event.
TouchpadPressure {
/// Window that was hovered when the touchpad was touched.
window: WindowId,
/// Touchpad device.
device: DeviceId,
/// Pressure level between 0 and 1.
pressure: f32,
/// Click level.
stage: i64,
},
/// Motion on some analog axis. May report data redundant to other, more specific events.
AxisMotion {
/// Window that was focused when the motion was realized.
window: WindowId,
/// Analog device.
device: DeviceId,
/// Axis.
axis: AxisId,
/// Motion value.
value: f64,
},
/// Touch event has been received.
Touch {
/// Window that was touched.
window: WindowId,
/// Touch device.
device: DeviceId,
/// Coalesced touch updates, never empty.
touches: Vec<TouchUpdate>,
},
/// The monitor’s scale factor has changed.
ScaleFactorChanged {
/// Monitor that has changed.
monitor: MonitorId,
/// Windows affected by this change.
///
/// Note that a window's scale factor can also change if it is moved to another monitor,
/// the [`Event::WindowChanged`] event notifies this using the [`WindowChanged::monitor`].
windows: Vec<WindowId>,
/// The new scale factor.
scale_factor: f32,
},
/// The available monitors have changed.
MonitorsChanged(Vec<(MonitorId, MonitorInfo)>),
/// The window has been requested to close.
WindowCloseRequested(WindowId),
/// The window has closed.
WindowClosed(WindowId),
/// An image resource already decoded size and PPI.
ImageMetadataLoaded {
/// The image that started loading.
image: ImageId,
/// The image pixel size.
size: PxSize,
/// The image pixels-per-inch metadata.
ppi: Option<ImagePpi>,
/// The image is a single channel R8.
is_mask: bool,
},
/// An image resource finished decoding.
ImageLoaded(ImageLoadedData),
/// An image resource, progressively decoded has decoded more bytes.
ImagePartiallyLoaded {
/// The image that has decoded more pixels.
image: ImageId,
/// The size of the decoded pixels, can be different then the image size if the
/// image is not *interlaced*.
partial_size: PxSize,
/// The image pixels-per-inch metadata.
ppi: Option<ImagePpi>,
/// If the decoded pixels so-far are all opaque (255 alpha).
is_opaque: bool,
/// If the decoded pixels so-far are a single channel.
is_mask: bool,
/// Updated BGRA8 pre-multiplied pixel buffer or R8 if `is_mask`. This includes all the pixels
/// decoded so-far.
partial_pixels: IpcBytes,
},
/// An image resource failed to decode, the image ID is not valid.
ImageLoadError {
/// The image that failed to decode.
image: ImageId,
/// The error message.
error: Txt,
},
/// An image finished encoding.
ImageEncoded {
/// The image that finished encoding.
image: ImageId,
/// The format of the encoded data.
format: Txt,
/// The encoded image data.
data: IpcBytes,
},
/// An image failed to encode.
ImageEncodeError {
/// The image that failed to encode.
image: ImageId,
/// The encoded format that was requested.
format: Txt,
/// The error message.
error: Txt,
},
/// An image generated from a rendered frame is ready.
FrameImageReady {
/// Window that had pixels copied.
window: WindowId,
/// The frame that was rendered when the pixels where copied.
frame: FrameId,
/// The frame image.
image: ImageId,
/// The pixel selection relative to the top-left.
selection: PxRect,
},
/* Config events */
/// System fonts have changed.
FontsChanged,
/// System text anti-aliasing configuration has changed.
FontAaChanged(FontAntiAliasing),
/// System double-click definition changed.
MultiClickConfigChanged(MultiClickConfig),
/// System animations config changed.
AnimationsConfigChanged(AnimationsConfig),
/// System definition of pressed key repeat event changed.
KeyRepeatConfigChanged(KeyRepeatConfig),
/// System touch config changed.
TouchConfigChanged(TouchConfig),
/// System locale changed.
LocaleChanged(LocaleConfig),
/// System color scheme or colors changed.
ColorsConfigChanged(ColorsConfig),
/// System window chrome (decorations) preference changed.
ChromeConfigChanged(ChromeConfig),
/* Raw device events */
/// Device added or installed.
DeviceAdded(DeviceId),
/// Device removed.
DeviceRemoved(DeviceId),
/// Mouse pointer motion.
///
/// The values if the delta of movement (x, y), not position.
DeviceMouseMotion {
/// Device that generated the event.
device: DeviceId,
/// Delta of change in the cursor position.
delta: euclid::Vector2D<f64, ()>,
},
/// Mouse scroll wheel turn.
DeviceMouseWheel {
/// Mouse device that generated the event.
device: DeviceId,
/// Delta of change in the mouse scroll wheel state.
delta: MouseScrollDelta,
},
/// Motion on some analog axis.
///
/// This includes the mouse device and any other that fits.
DeviceMotion {
/// Device that generated the event.
device: DeviceId,
/// Device dependent axis of the motion.
axis: AxisId,
/// Device dependent value.
value: f64,
},
/// Device button press or release.
DeviceButton {
/// Device that generated the event.
device: DeviceId,
/// Device dependent button that was used.
button: ButtonId,
/// If the button was pressed or released.
state: ButtonState,
},
/// Device key press or release.
DeviceKey {
/// Device that generated the key event.
device: DeviceId,
/// Physical key.
key_code: KeyCode,
/// If the key was pressed or released.
state: KeyState,
},
/// User responded to a native message dialog.
MsgDialogResponse(DialogId, MsgDialogResponse),
/// User responded to a native file dialog.
FileDialogResponse(DialogId, FileDialogResponse),
/// Accessibility info tree is now required for the window.
AccessInit {
/// Window that must now build access info.
window: WindowId,
},
/// Accessibility command.
AccessCommand {
/// Window that had pixels copied.
window: WindowId,
/// Target widget.
target: AccessNodeId,
/// Command.
command: AccessCmd,
},
/// Accessibility info tree is no longer needed for the window.
///
/// Note that accessibility may be enabled again after this. It is not an error
/// to send access updates after this, but they will be ignored.
AccessDeinit {
/// Window that can release access info.
window: WindowId,
},
/// System low memory warning, some platforms may kill the app if it does not release memory.
LowMemory,
/// An internal component panicked, but the view-process managed to recover from it without
/// needing to respawn.
RecoveredFromComponentPanic {
/// Component identifier.
component: Txt,
/// How the view-process recovered from the panic.
recover: Txt,
/// The panic.
panic: Txt,
},
/// Represents a custom event send by the extension.
ExtensionEvent(ApiExtensionId, ApiExtensionPayload),
}
impl Event {
/// Change `self` to incorporate `other` or returns `other` if both events cannot be coalesced.
#[expect(clippy::result_large_err)]
pub fn coalesce(&mut self, other: Event) -> Result<(), Event> {
use Event::*;
match (self, other) {
(
MouseMoved {
window,
device,
coalesced_pos,
position,
},
MouseMoved {
window: n_window,
device: n_device,
coalesced_pos: n_coal_pos,
position: n_pos,
},
) if *window == n_window && *device == n_device => {
coalesced_pos.push(*position);
coalesced_pos.extend(n_coal_pos);
*position = n_pos;
}
(
DragMoved {
window,
coalesced_pos,
position,
},
DragMoved {
window: n_window,
coalesced_pos: n_coal_pos,
position: n_pos,
},
) if *window == n_window => {
coalesced_pos.push(*position);
coalesced_pos.extend(n_coal_pos);
*position = n_pos;
}
// raw mouse motion.
(
DeviceMouseMotion { device, delta },
DeviceMouseMotion {
device: n_device,
delta: n_delta,
},
) if *device == n_device => {
*delta += n_delta;
}
// wheel scroll.
(
MouseWheel {
window,
device,
delta: MouseScrollDelta::LineDelta(delta_x, delta_y),
phase,
},
MouseWheel {
window: n_window,
device: n_device,
delta: MouseScrollDelta::LineDelta(n_delta_x, n_delta_y),
phase: n_phase,
},
) if *window == n_window && *device == n_device && *phase == n_phase => {
*delta_x += n_delta_x;
*delta_y += n_delta_y;
}
// trackpad scroll-move.
(
MouseWheel {
window,
device,
delta: MouseScrollDelta::PixelDelta(delta_x, delta_y),
phase,
},
MouseWheel {
window: n_window,
device: n_device,
delta: MouseScrollDelta::PixelDelta(n_delta_x, n_delta_y),
phase: n_phase,
},
) if *window == n_window && *device == n_device && *phase == n_phase => {
*delta_x += n_delta_x;
*delta_y += n_delta_y;
}
// raw wheel scroll.
(
DeviceMouseWheel {
device,
delta: MouseScrollDelta::LineDelta(delta_x, delta_y),
},
DeviceMouseWheel {
device: n_device,
delta: MouseScrollDelta::LineDelta(n_delta_x, n_delta_y),
},
) if *device == n_device => {
*delta_x += n_delta_x;
*delta_y += n_delta_y;
}
// raw trackpad scroll-move.
(
DeviceMouseWheel {
device,
delta: MouseScrollDelta::PixelDelta(delta_x, delta_y),
},
DeviceMouseWheel {
device: n_device,
delta: MouseScrollDelta::PixelDelta(n_delta_x, n_delta_y),
},
) if *device == n_device => {
*delta_x += n_delta_x;
*delta_y += n_delta_y;
}
// touch
(
Touch { window, device, touches },
Touch {
window: n_window,
device: n_device,
touches: mut n_touches,
},
) if *window == n_window && *device == n_device => {
touches.append(&mut n_touches);
}
// window changed.
(WindowChanged(change), WindowChanged(n_change))
if change.window == n_change.window && change.cause == n_change.cause && change.frame_wait_id.is_none() =>
{
if n_change.state.is_some() {
change.state = n_change.state;
}
if n_change.position.is_some() {
change.position = n_change.position;
}
if n_change.monitor.is_some() {
change.monitor = n_change.monitor;
}
if n_change.size.is_some() {
change.size = n_change.size;
}
if n_change.safe_padding.is_some() {
change.safe_padding = n_change.safe_padding;
}
change.frame_wait_id = n_change.frame_wait_id;
}
// window focus changed.
(FocusChanged { prev, new }, FocusChanged { prev: n_prev, new: n_new })
if prev.is_some() && new.is_none() && n_prev.is_none() && n_new.is_some() =>
{
*new = n_new;
}
// IME commit replaces preview.
(
Ime {
window,
ime: ime @ self::Ime::Preview(_, _),
},
Ime {
window: n_window,
ime: n_ime @ self::Ime::Commit(_),
},
) if *window == n_window => {
*ime = n_ime;
}
// scale factor.
(
ScaleFactorChanged {
monitor,
windows,
scale_factor,
},
ScaleFactorChanged {
monitor: n_monitor,
windows: n_windows,
scale_factor: n_scale_factor,
},
) if *monitor == n_monitor => {
for w in n_windows {
if !windows.contains(&w) {
windows.push(w);
}
}
*scale_factor = n_scale_factor;
}
// fonts changed.
(FontsChanged, FontsChanged) => {}
// text aa.
(FontAaChanged(config), FontAaChanged(n_config)) => {
*config = n_config;
}
// double-click timeout.
(MultiClickConfigChanged(config), MultiClickConfigChanged(n_config)) => {
*config = n_config;
}
// touch config.
(TouchConfigChanged(config), TouchConfigChanged(n_config)) => {
*config = n_config;
}
// animation enabled and caret speed.
(AnimationsConfigChanged(config), AnimationsConfigChanged(n_config)) => {
*config = n_config;
}
// key repeat delay and speed.
(KeyRepeatConfigChanged(config), KeyRepeatConfigChanged(n_config)) => {
*config = n_config;
}
// locale
(LocaleChanged(config), LocaleChanged(n_config)) => {
*config = n_config;
}
// drag hovered
(
DragHovered {
window,
data,
allowed: effects,
},
DragHovered {
window: n_window,
data: mut n_data,
allowed: n_effects,
},
) if *window == n_window && effects.contains(n_effects) => {
data.append(&mut n_data);
}
// drag dropped
(
DragDropped {
window,
data,
allowed,
drop_id,
},
DragDropped {
window: n_window,
data: mut n_data,
allowed: n_allowed,
drop_id: n_drop_id,
},
) if *window == n_window && allowed.contains(n_allowed) && *drop_id == n_drop_id => {
data.append(&mut n_data);
}
// drag cancelled
(DragCancelled { window }, DragCancelled { window: n_window }) if *window == n_window => {}
(_, e) => return Err(e),
}
Ok(())
}
}
/// The View-Process disconnected or has not finished initializing, try again after the *inited* event.
#[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)]
pub struct ViewProcessOffline;
impl fmt::Display for ViewProcessOffline {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "view-process disconnected or is initing, try again after the init event")
}
}
impl std::error::Error for ViewProcessOffline {}
/// View Process IPC result.
pub(crate) type VpResult<T> = std::result::Result<T, ViewProcessOffline>;
/// Offset and color in a gradient.
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct GradientStop {
/// Offset in pixels.
pub offset: f32,
/// Color at the offset.
pub color: Rgba,
}
/// Border side line style and color.
#[derive(Clone, Copy, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct BorderSide {
/// Line color.
pub color: Rgba,
/// Line Style.
pub style: BorderStyle,
}
/// Defines if a widget is part of the same 3D space as the parent.
#[derive(Default, Clone, Copy, serde::Deserialize, Eq, Hash, PartialEq, serde::Serialize)]
#[repr(u8)]
pub enum TransformStyle {
/// Widget is not a part of the 3D space of the parent. If it has
/// 3D children they will be rendered into a flat plane that is placed in the 3D space of the parent.
#[default]
Flat = 0,
/// Widget is a part of the 3D space of the parent. If it has 3D children
/// they will be positioned relative to siblings in the same space.
///
/// Note that some properties require a flat image to work on, in particular all pixel filter properties including opacity.
/// When such a property is set in a widget that is `Preserve3D` and has both a parent and one child also `Preserve3D` the
/// filters are ignored and a warning is logged. When the widget is `Preserve3D` and the parent is not the filters are applied
/// *outside* the 3D space, when the widget is `Preserve3D` with all `Flat` children the filters are applied *inside* the 3D space.
Preserve3D = 1,
}
impl fmt::Debug for TransformStyle {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if f.alternate() {
write!(f, "TransformStyle::")?;
}
match self {
Self::Flat => write!(f, "Flat"),
Self::Preserve3D => write!(f, "Preserve3D"),
}
}
}
/// Identifies a reference frame.
///
/// This ID is mostly defined by the app process. IDs that set the most significant
/// bit of the second part (`id.1 & (1 << 63) != 0`) are reserved for the view process.
#[derive(Default, Debug, Clone, Copy, serde::Deserialize, Eq, Hash, PartialEq, serde::Serialize)]
pub struct ReferenceFrameId(pub u64, pub u64);
impl ReferenceFrameId {
/// If ID does not set the bit that indicates it is generated by the view process.
pub fn is_app_generated(&self) -> bool {
self.1 & (1 << 63) == 0
}
}
/// Nine-patch border repeat mode.
///
/// Defines how the edges and middle region of a nine-patch border is filled.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, serde::Serialize, serde::Deserialize, Default)]
pub enum RepeatMode {
/// The source image's edge regions are stretched to fill the gap between each border.
#[default]
Stretch,
/// The source image's edge regions are tiled (repeated) to fill the gap between each
/// border. Tiles may be clipped to achieve the proper fit.
Repeat,
/// The source image's edge regions are tiled (repeated) to fill the gap between each
/// border. Tiles may be stretched to achieve the proper fit.
Round,
/// The source image's edge regions are tiled (repeated) to fill the gap between each
/// border. Extra space will be distributed in between tiles to achieve the proper fit.
Space,
}
#[cfg(feature = "var")]
zng_var::impl_from_and_into_var! {
/// Converts `true` to `Repeat` and `false` to the default `Stretch`.
fn from(value: bool) -> RepeatMode {
match value {
true => RepeatMode::Repeat,
false => RepeatMode::Stretch,
}
}
}
/// Color mix blend mode.
#[allow(missing_docs)]
#[repr(u8)]
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize, Default)]
pub enum MixBlendMode {
#[default]
Normal = 0,
Multiply = 1,
Screen = 2,
Overlay = 3,
Darken = 4,
Lighten = 5,
ColorDodge = 6,
ColorBurn = 7,
HardLight = 8,
SoftLight = 9,
Difference = 10,
Exclusion = 11,
Hue = 12,
Saturation = 13,
Color = 14,
Luminosity = 15,
PlusLighter = 16,
}
/// Image scaling algorithm in the renderer.
///
/// If an image is not rendered at the same size as their source it must be up-scaled or
/// down-scaled. The algorithms used for this scaling can be selected using this `enum`.
///
/// Note that the algorithms used in the renderer value performance over quality and do a good
/// enough job for small or temporary changes in scale only, such as a small size correction or a scaling animation.
/// If and image is constantly rendered at a different scale you should considered scaling it on the CPU using a
/// slower but more complex algorithm or pre-scaling it before including in the app.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, serde::Serialize, serde::Deserialize)]
pub enum ImageRendering {
/// Let the renderer select the algorithm, currently this is the same as [`CrispEdges`].
///
/// [`CrispEdges`]: ImageRendering::CrispEdges
Auto = 0,
/// The image is scaled with an algorithm that preserves contrast and edges in the image,
/// and which does not smooth colors or introduce blur to the image in the process.
///
/// Currently the [Bilinear] interpolation algorithm is used.
///
/// [Bilinear]: https://en.wikipedia.org/wiki/Bilinear_interpolation
CrispEdges = 1,
/// When scaling the image up, the image appears to be composed of large pixels.
///
/// Currently the [Nearest-neighbor] interpolation algorithm is used.
///
/// [Nearest-neighbor]: https://en.wikipedia.org/wiki/Nearest-neighbor_interpolation
Pixelated = 2,
}
/// Pixel color alpha type.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub enum AlphaType {
/// Components are not pre-multiplied by alpha.
Alpha = 0,
/// Components are pre-multiplied by alpha.
PremultipliedAlpha = 1,
}
/// Gradient extend mode.
#[allow(missing_docs)]
#[repr(u8)]
#[derive(Debug, Copy, Clone, Hash, Eq, PartialEq, Serialize, Deserialize, Ord, PartialOrd)]
pub enum ExtendMode {
Clamp,
Repeat,
}
/// Orientation of a straight line.
#[derive(Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum LineOrientation {
/// Top-to-bottom line.
Vertical,
/// Left-to-right line.
Horizontal,
}
impl fmt::Debug for LineOrientation {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if f.alternate() {
write!(f, "LineOrientation::")?;
}
match self {
LineOrientation::Vertical => {
write!(f, "Vertical")
}
LineOrientation::Horizontal => {
write!(f, "Horizontal")
}
}
}
}
/// Represents a line style.
#[allow(missing_docs)]
#[repr(u8)]
#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
pub enum LineStyle {
Solid,
Dotted,
Dashed,
/// A wavy line, like an error underline.
///
/// The wave magnitude is defined by the overall line thickness, the associated value
/// here defines the thickness of the wavy line.
Wavy(f32),
}
/// The line style for the sides of a widget's border.
#[repr(u8)]
#[derive(Default, Debug, Clone, Copy, PartialEq, Hash, Eq, serde::Serialize, serde::Deserialize)]
pub enum BorderStyle {
/// No border line.
#[default]
None = 0,
/// A single straight solid line.
Solid = 1,
/// Two straight solid lines that add up to the pixel size defined by the side width.
Double = 2,
/// Displays a series of rounded dots.
Dotted = 3,
/// Displays a series of short square-ended dashes or line segments.
Dashed = 4,
/// Fully transparent line.
Hidden = 5,
/// Displays a border with a carved appearance.
Groove = 6,
/// Displays a border with an extruded appearance.
Ridge = 7,
/// Displays a border that makes the widget appear embedded.
Inset = 8,
/// Displays a border that makes the widget appear embossed.
Outset = 9,
}
/// Result of a focus request.
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub enum FocusResult {
/// Focus was requested, an [`Event::FocusChanged`] will be send if the operating system gives focus to the window.
Requested,
/// Window is already focused.
AlreadyFocused,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn key_code_iter() {
let mut iter = KeyCode::all_identified();
let first = iter.next().unwrap();
assert_eq!(first, KeyCode::Backquote);
for k in iter {
assert_eq!(k.name(), &format!("{:?}", k));
}
}
}