Struct TextSelection 

pub struct TextSelection {
    pub text: String,
    pub prefix: Option<String>,
    pub suffix: Option<String>,
    pub mode: SelectionMode,
}

A request to select (or place the caret around) some text inside an element.

Fields

text: String

The text to find, exactly as it appears in the element’s value.

prefix: Option<String>

Text that must appear immediately before the match, to disambiguate repeats.

suffix: Option<String>

Text that must appear immediately after the match, to disambiguate repeats.

mode: SelectionMode

What to do with the match.

Implementations

impl TextSelection

pub fn new(text: impl Into<String>) -> Self

Selects text.

Examples found in repository

examples/textedit.rs (line 48)

fn main() -> computer_use::Result<()> {
    use std::time::Duration;

    use computer_use::{
        CaptureOptions, ClickMethod, ClickOptions, ClickTarget, Computer, ElementQuery, Error, TextSelection,
    };

    const APP: &str = "TextEdit";
    let mut computer = Computer::new()?.settle_delay(Duration::from_millis(300));
    let tree_only = CaptureOptions::default().include_screenshot(false);

    let state = computer.get_app_state(APP, &tree_only)?;
    let new_doc = state.find(&ElementQuery::text("New Document").with_role("button").exact(true)).next();
    if let Some(button) = new_doc.map(|e| e.index) {
        println!(
            "click New Document: {:?}",
            computer.click(APP, ClickTarget::Element(button), ClickOptions::default())?
        );
    }

    let state = computer.get_app_state(APP, &tree_only)?;
    let text_area = state
        .find(&ElementQuery::role("AXTextArea"))
        .next()
        .map(|e| e.index)
        .ok_or_else(|| Error::StateUnavailable("no text area".into()))?;
    println!(
        "click text area {text_area}: {:?}",
        computer.click(APP, ClickTarget::Element(text_area), ClickOptions::default())?
    );
    computer.set_value(APP, text_area, "")?;
    computer.type_text(APP, "Hello from computer-use-rs!\nSecond line.")?;

    let state = computer.get_app_state(APP, &tree_only)?;
    let value = state.find(&ElementQuery::role("AXTextArea")).next().and_then(|e| e.value.clone());
    println!("text area now contains: {value:?}");

    computer.select_text(APP, text_area, &TextSelection::new("computer-use-rs"))?;
    let state = computer.get_app_state(APP, &tree_only)?;
    println!("selected text: {:?}", state.selected_text);

    computer.press_key(APP, "BackSpace")?;
    let state = computer.get_app_state(APP, &tree_only)?;
    let value = state.find(&ElementQuery::role("AXTextArea")).next().and_then(|e| e.value.clone());
    println!("after BackSpace: {value:?}");

    computer.press_key(APP, "super+a")?;
    let state = computer.get_app_state(APP, &tree_only)?;
    println!("after super+a, selected: {:?}", state.selected_text);

    let focused = ClickOptions::default().method(ClickMethod::FocusedBackground);
    println!("focused click: {:?}", computer.click(APP, ClickTarget::Element(text_area), focused)?);
    computer.type_text(APP, " The end.")?;
    let state = computer.get_app_state(APP, &tree_only)?;
    let value = state.find(&ElementQuery::role("AXTextArea")).next().and_then(|e| e.value.clone());
    println!("final text: {value:?}");

    Ok(())
}

pub fn prefix(self, prefix: impl Into<String>) -> Self

Requires prefix immediately before the match.

pub fn suffix(self, suffix: impl Into<String>) -> Self

Requires suffix immediately after the match.

pub const fn mode(self, mode: SelectionMode) -> Self

Sets the selection mode.

pub fn resolve(&self, value: &str) -> Result<Range<usize>>

Resolves the request against value, returning a byte range to select.

A collapsed range (start == end) places the caret.

Errors

Fails when the text is empty, absent, or occurs more than once after applying the prefix and suffix constraints.

Trait Implementations

impl Clone for TextSelection

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextSelection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TextSelection

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TextSelection

impl PartialEq for TextSelection

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TextSelection