zng_app/access.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
//! Accessibility/automation events.
use zng_txt::Txt;
use zng_view_api::access::AccessCmd;
pub use zng_view_api::access::ScrollCmd;
use crate::{
event::{event, event_args},
update::EventUpdate,
widget::WidgetId,
window::WindowId,
};
pub(super) fn on_access_init(window_id: WindowId) -> EventUpdate {
let args = AccessInitedArgs::now(window_id);
ACCESS_INITED_EVENT.new_update(args)
}
pub(super) fn on_access_deinit(window_id: WindowId) -> EventUpdate {
let args = AccessDeinitedArgs::now(window_id);
ACCESS_DEINITED_EVENT.new_update(args)
}
pub(super) fn on_access_command(window_id: WindowId, widget_id: WidgetId, command: AccessCmd) -> Option<EventUpdate> {
match command {
AccessCmd::Click(primary) => {
let args = AccessClickArgs::now(window_id, widget_id, primary);
Some(ACCESS_CLICK_EVENT.new_update(args))
}
AccessCmd::Focus(focus) => {
let args = AccessFocusArgs::now(window_id, widget_id, focus);
Some(ACCESS_FOCUS_EVENT.new_update(args))
}
AccessCmd::FocusNavOrigin => {
let args = AccessFocusNavOriginArgs::now(window_id, widget_id);
Some(ACCESS_FOCUS_NAV_ORIGIN_EVENT.new_update(args))
}
AccessCmd::SetExpanded(expanded) => {
let args = AccessExpanderArgs::now(window_id, widget_id, expanded);
Some(ACCESS_EXPANDER_EVENT.new_update(args))
}
AccessCmd::Increment(inc) => {
let args = AccessIncrementArgs::now(window_id, widget_id, inc);
Some(ACCESS_INCREMENT_EVENT.new_update(args))
}
AccessCmd::SetToolTipVis(vis) => {
let args = AccessToolTipArgs::now(window_id, widget_id, vis);
Some(ACCESS_TOOLTIP_EVENT.new_update(args))
}
AccessCmd::ReplaceSelectedText(s) => {
let args = AccessTextArgs::now(window_id, widget_id, s, true);
Some(ACCESS_TEXT_EVENT.new_update(args))
}
AccessCmd::Scroll(s) => {
let args = AccessScrollArgs::now(window_id, widget_id, s);
Some(ACCESS_SCROLL_EVENT.new_update(args))
}
AccessCmd::SelectText {
start: (start_wgt, start_idx),
caret: (caret_wgt, caret_idx),
} => {
let start_wgt = WidgetId::from_raw(start_wgt.0);
let caret_wgt = WidgetId::from_raw(caret_wgt.0);
let args = AccessSelectionArgs::now(window_id, (start_wgt, start_idx), (caret_wgt, caret_idx));
Some(ACCESS_SELECTION_EVENT.new_update(args))
}
AccessCmd::SetString(s) => {
let args = AccessTextArgs::now(window_id, widget_id, s, false);
Some(ACCESS_TEXT_EVENT.new_update(args))
}
AccessCmd::SetNumber(n) => {
let args = AccessNumberArgs::now(window_id, widget_id, n);
Some(ACCESS_NUMBER_EVENT.new_update(args))
}
a => {
tracing::warn!("access command `{a:?}` not implemented");
None
}
}
}
event_args! {
/// Arguments for the [`ACCESS_INITED_EVENT`].
pub struct AccessInitedArgs {
/// Target window.
pub window_id: WindowId,
..
/// Event is broadcast.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_all()
}
}
/// Arguments for the [`ACCESS_DEINITED_EVENT`].
pub struct AccessDeinitedArgs {
/// Target window.
pub window_id: WindowId,
..
/// Event is broadcast.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_all()
}
}
/// Arguments for the [`ACCESS_CLICK_EVENT`].
pub struct AccessClickArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// Is primary click (default action).
///
/// If `false` is context click.
pub is_primary: bool,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id);
}
}
/// Arguments for the [`ACCESS_FOCUS_EVENT`].
pub struct AccessFocusArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// If the widget must be focused.
///
/// If `true` the widget is focused, if `false` and the widget is focused, does ESC.
pub focus: bool,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_FOCUS_NAV_ORIGIN_EVENT`].
pub struct AccessFocusNavOriginArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_EXPANDER_EVENT`].
pub struct AccessExpanderArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// New expanded value.
pub expanded: bool,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_INCREMENT_EVENT`].
pub struct AccessIncrementArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// Increment steps.
///
/// Usually is -1 or 1.
pub delta: i32,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_TOOLTIP_EVENT`].
pub struct AccessToolTipArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// New tooltip visibility.
pub visible: bool,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_SCROLL_EVENT`].
pub struct AccessScrollArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// Scroll command.
pub command: ScrollCmd,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_TEXT_EVENT`].
pub struct AccessTextArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// Replacement text.
pub txt: Txt,
/// If only the selected text is replaced.
///
/// Note that if the selection is empty the text is just inserted at the caret position, or is appended if there
/// is no caret.
pub selection_only: bool,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_NUMBER_EVENT`].
pub struct AccessNumberArgs {
/// Target window.
pub window_id: WindowId,
/// Target widget.
pub widget_id: WidgetId,
/// Replacement number.
pub num: f64,
..
/// Target the widget.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.widget_id)
}
}
/// Arguments for the [`ACCESS_SELECTION_EVENT`].
pub struct AccessSelectionArgs {
/// Target window.
pub window_id: WindowId,
/// Selection start.
///
/// Text widget and character index where the selection *starts*.
pub start: (WidgetId, usize),
/// Selection end.
///
/// This is where the caret is placed, it does not need to be greater than the start.
pub caret: (WidgetId, usize),
..
/// Target both widgets.
fn delivery_list(&self, list: &mut UpdateDeliveryList) {
list.search_widget(self.start.0);
list.search_widget(self.caret.0);
}
}
}
impl AccessClickArgs {
/// Is context click.
pub fn is_context(&self) -> bool {
!self.is_primary
}
}
event! {
/// Accessibility info is now required for the window.
pub static ACCESS_INITED_EVENT: AccessInitedArgs;
/// Accessibility info is no longer required for the window.
pub static ACCESS_DEINITED_EVENT: AccessDeinitedArgs;
/// Run the primary or context click action.
pub static ACCESS_CLICK_EVENT: AccessClickArgs;
/// Focus or escape focus on a widget.
pub static ACCESS_FOCUS_EVENT: AccessFocusArgs;
/// Sets the focus navigation origin.
pub static ACCESS_FOCUS_NAV_ORIGIN_EVENT: AccessFocusNavOriginArgs;
/// Expand or collapse the widget content.
pub static ACCESS_EXPANDER_EVENT: AccessExpanderArgs;
/// Increment or decrement the widget value by steps.
pub static ACCESS_INCREMENT_EVENT: AccessIncrementArgs;
/// Show or hide the widget's tooltip.
pub static ACCESS_TOOLTIP_EVENT: AccessToolTipArgs;
/// Run a scroll command.
pub static ACCESS_SCROLL_EVENT: AccessScrollArgs;
/// Replace the text content.
pub static ACCESS_TEXT_EVENT: AccessTextArgs;
/// Replace the number value.
pub static ACCESS_NUMBER_EVENT: AccessNumberArgs;
/// Select text.
pub static ACCESS_SELECTION_EVENT: AccessSelectionArgs;
}
/// Accessibility service.
pub struct ACCESS;
impl ACCESS {
/// Click the widget in the window.
///
/// If `is_primary` is `true` a primary click is generated, if it is `false` a context click is generated.
pub fn click(&self, window_id: impl Into<WindowId>, widget_id: impl Into<WidgetId>, is_primary: bool) {
let win = window_id.into();
let wgt = widget_id.into();
ACCESS_CLICK_EVENT.notify(AccessClickArgs::now(win, wgt, is_primary));
}
/// Show tooltip for widget in the window, if it has any tooltip.
///
/// The tooltip can auto-hide following the same rules as tooltips shown by hover.
pub fn show_tooltip(&self, window_id: impl Into<WindowId>, widget_id: impl Into<WidgetId>) {
let win = window_id.into();
let wgt = widget_id.into();
ACCESS_TOOLTIP_EVENT.notify(AccessToolTipArgs::now(win, wgt, true));
}
/// Hide tooltip for the widget in the window, if it has any tooltip showing.
pub fn hide_tooltip(&self, window_id: impl Into<WindowId>, widget_id: impl Into<WidgetId>) {
let win = window_id.into();
let wgt = widget_id.into();
ACCESS_TOOLTIP_EVENT.notify(AccessToolTipArgs::now(win, wgt, false));
}
}