Struct Window 

pub struct Window(/* private fields */);

A wrapper around a platform-specific window. This struct provides a cross-platform interface to interact with window properties.

Implementations

impl Window

pub fn new(inner: PlatformWindow) -> Self

Creates a new Window instance from a platform-specific window.

Notes

You can get a Window instance by using the get_window function or get_windows function so you don’t need to create it manually in most use cases.

pub fn platform_window(&self) -> &PlatformWindow

Retrieves the underlying platform-specific window.

pub fn into_platform_window(self) -> PlatformWindow

Consumes the Window and returns the underlying platform-specific window.

Examples found in repository

examples/windows_various_rect.rs (line 9)

fn main() {
    for window in window_getter::get_windows().unwrap() {
        let window = window.into_platform_window();

        println!("\n{:?} ({:?})", window.title(), window.hwnd());
        println!("\tGetWindowRect: {:?}", window.rect());
        println!(
            "\tDwmGetWindowAttribute with DWMWA_EXTENDED_FRAME_BOUNDS: {:?}",
            window.extended_frame_bounds()
        );
    }
}

pub fn id(&self) -> WindowId

Returns the unique identifier of the window.

Examples found in repository

examples/print_windows.rs (line 6)

fn main() {
    let windows = window_getter::get_windows().unwrap();
    println!("Found {} windows:", windows.len());

    for window in windows {
        println!("\n{:?} ({})", window.title(), window.id().as_u32());
        println!("\tBounds: {:?}", window.bounds());
        println!("\tProcess id: {}", window.owner_pid().unwrap());
        println!("\tProcess name: {:?}", window.owner_name());
    }
}

pub fn title(&self) -> Result<Option<String>, Error>

Returns the title of the window.

Platform-specific

• Windows: If you don’t have permission to access the title, it will return Error::PermissionDenied.
• macOS: It will always return Ok. Apple’s documentation does not explicitly state this, but it returns None when the permission is not granted.

Examples found in repository

examples/print_windows.rs (line 6)

fn main() {
    let windows = window_getter::get_windows().unwrap();
    println!("Found {} windows:", windows.len());

    for window in windows {
        println!("\n{:?} ({})", window.title(), window.id().as_u32());
        println!("\tBounds: {:?}", window.bounds());
        println!("\tProcess id: {}", window.owner_pid().unwrap());
        println!("\tProcess name: {:?}", window.owner_name());
    }
}

examples/get_window.rs (line 11)

fn main() {
    let raw = std::env::var("WINDOW_ID")
        .expect("`WINDOW_ID` environment variable not set")
        .parse::<u32>()
        .expect("`WINDOW_ID` must be a valid `u32`");
    let id = WindowId::from(raw);

    if let Some(window) = window_getter::get_window(id).unwrap() {
        println!("title: {:?}", window.title());
    } else {
        println!("No window found with the given ID.");
    };
}

pub fn bounds(&self) -> Result<Bounds, Error>

Returns the bounds of the window.

Examples found in repository

examples/print_windows.rs (line 7)

fn main() {
    let windows = window_getter::get_windows().unwrap();
    println!("Found {} windows:", windows.len());

    for window in windows {
        println!("\n{:?} ({})", window.title(), window.id().as_u32());
        println!("\tBounds: {:?}", window.bounds());
        println!("\tProcess id: {}", window.owner_pid().unwrap());
        println!("\tProcess name: {:?}", window.owner_name());
    }
}

pub fn owner_pid(&self) -> Result<i32, Error>

Returns the process ID of the window’s owner.

Platform-specific

• macOS: It will always return Ok.

Examples found in repository

examples/print_windows.rs (line 8)

fn main() {
    let windows = window_getter::get_windows().unwrap();
    println!("Found {} windows:", windows.len());

    for window in windows {
        println!("\n{:?} ({})", window.title(), window.id().as_u32());
        println!("\tBounds: {:?}", window.bounds());
        println!("\tProcess id: {}", window.owner_pid().unwrap());
        println!("\tProcess name: {:?}", window.owner_name());
    }
}

pub fn owner_name(&self) -> Result<Option<String>, Error>

Returns the name of the process that owns the window.

Platform-specific

• Windows: If you don’t have permission to access the owner name, it will return Error::PermissionDenied. Also, it will return the name of the executable file when owner name is available.
• macOS: It will always return Ok.

Examples found in repository

examples/print_windows.rs (line 9)

fn main() {
    let windows = window_getter::get_windows().unwrap();
    println!("Found {} windows:", windows.len());

    for window in windows {
        println!("\n{:?} ({})", window.title(), window.id().as_u32());
        println!("\tBounds: {:?}", window.bounds());
        println!("\tProcess id: {}", window.owner_pid().unwrap());
        println!("\tProcess name: {:?}", window.owner_name());
    }
}

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Window

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

Formats the value using the given formatter.