win_wrap/uia/pattern/
toggle.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
/*
 * Copyright (c) 2024. The RigelA open source project team and
 * its contributors reserve all rights.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and limitations under the License.
 */

use crate::uia::pattern::{PatternCreator, PatternError};
use std::fmt::{Debug, Formatter};
use windows::Win32::UI::Accessibility::{
    IUIAutomationTogglePattern, ToggleState_Indeterminate, ToggleState_Off, ToggleState_On,
    UIA_TogglePatternId, UIA_PATTERN_ID,
};

/**
提供对控件的访问，该控件可以在一组状态之间循环，并在设置状态后保持状态。
*/
pub struct UiAutomationTogglePattern(IUIAutomationTogglePattern);

impl TryFrom<IUIAutomationTogglePattern> for UiAutomationTogglePattern {
    type Error = PatternError;

    fn try_from(value: IUIAutomationTogglePattern) -> Result<Self, Self::Error> {
        Ok(Self(value))
    }
}

impl PatternCreator<IUIAutomationTogglePattern> for UiAutomationTogglePattern {
    const PATTERN: UIA_PATTERN_ID = UIA_TogglePatternId;
}

/// <https://learn.microsoft.com/en-us/windows/win32/api/uiautomationclient/nn-uiautomationclient-iuiautomationtogglepattern>
impl UiAutomationTogglePattern {
    /**
    检索控件的状态。
    */
    #[allow(non_upper_case_globals)]
    pub fn get_toggle_state(&self) -> ToggleState {
        let state = unsafe { self.0.CurrentToggleState() };
        if state.is_err() {
            return ToggleState::Indeterminate;
        }
        match state.unwrap() {
            ToggleState_On => ToggleState::On,
            ToggleState_Off => ToggleState::Off,
            ToggleState_Indeterminate => ToggleState::Indeterminate,
            _ => ToggleState::Indeterminate,
        }
    }

    /**
    在控件的切换状态之间循环。
    控件按以下顺序循环其状态：ToggleState::On、ToggleState::Off，以及（如果支持）ToggleState::Indeterminate。
    */
    pub fn toggle(&self) {
        unsafe { self.0.Toggle().unwrap_or(()) }
    }
}

impl Debug for UiAutomationTogglePattern {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "UiAutomationTogglePattern()")
    }
}

pub enum ToggleState {
    On,
    Off,
    Indeterminate,
}