ui-automation 0.1.1

Control the User Interface, cross-platform.
Documentation 
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

// Copyright (C) 2024 Tristan Gerritsen <tristan@thewoosh.org>
// All Rights Reserved.

use std::sync::Arc;

use crate::{ClickPosition, ClickRequest, ElementBackend, MouseButton, Position, Rect, Role, Size, UIResult};

#[derive(Debug, Clone)]
pub struct Element {
    pub(crate) backend: Arc<dyn ElementBackend>,
}

impl Element {
    #[must_use]
    pub fn children(&self) -> Vec<Element> {
        self.try_children().unwrap_or_default()
    }

    pub fn click(&self) {
        self.try_click().unwrap()
    }

    #[must_use]
    pub fn description(&self) -> String {
        self.try_description().unwrap_or_default()
    }

    #[must_use]
    pub fn position(&self) -> Position {
        self.try_position().unwrap_or_default()
    }

    #[must_use]
    pub fn rect(&self) -> Rect {
        self.try_rect().unwrap_or_default()
    }

    #[must_use]
    pub fn size(&self) -> Size {
        self.try_size().unwrap_or_default()
    }

    pub fn find<P: FnMut(&Element) -> bool>(&self, mut pred: P) -> Option<Element> {
        if pred(self) {
            return Some(self.clone());
        }

        self.children()
            .into_iter()
            .find_map(|element| element.find(&mut pred))
    }

    #[must_use]
    pub fn role(&self) -> Role {
        self.try_role().unwrap_or_default()
    }

    #[must_use]
    pub fn url(&self) -> String {
        self.try_url().unwrap_or_default()
    }

    #[must_use]
    pub fn title(&self) -> String {
        self.try_title().unwrap_or_default()
    }

    pub fn try_children(&self) -> UIResult<Vec<Element>> {
        self.backend.children()
    }

    #[must_use]
    pub fn try_click(&self) -> UIResult<()> {
        let request = ClickRequest::new(ClickPosition::Center, MouseButton::Left);
        self.backend.click(request)
    }

    pub fn try_description(&self) -> UIResult<String> {
        self.backend.description()
    }

    #[must_use]
    pub fn try_position(&self) -> UIResult<Position> {
        self.backend.position()
    }

    #[must_use]
    pub fn try_rect(&self) -> UIResult<Rect> {
        self.backend.rect()
    }

    #[must_use]
    pub fn try_size(&self) -> UIResult<Size> {
        self.backend.size()
    }

    pub fn try_role(&self) -> UIResult<Role> {
        self.backend.role()
    }

    pub fn try_title(&self) -> UIResult<String> {
        self.backend.title()
    }

    #[must_use]
    pub fn try_url(&self) -> UIResult<String> {
        self.backend.url()
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct ElementId(pub usize);