Struct winvd::VirtualDesktopService

pub struct VirtualDesktopService { /* fields omitted */ }

Provides the stateful helper to accessing the Windows 10 Virtual Desktop functions.

If you don't use other COM objects in your project, you have to use VirtualDesktopService::create_with_com() constructor.

Implementations

impl VirtualDesktopService

pub fn create_with_com() -> Result<VirtualDesktopService, Error>

Initialize service and COM apartment. If you don't use other COM API's, you have to use this initialization.

pub fn create() -> Result<VirtualDesktopService, Error>

Initialize only the service, must be-created on TaskbarCreated message

pub fn get_desktops(&self) -> Result<Vec<DesktopID>, Error>

Get desktops (GUID's)

pub fn get_desktop_count(&self) -> Result<u32, Error>

Get number of desktops

pub fn get_current_desktop(&self) -> Result<DesktopID, Error>

Get current desktop GUID

pub fn get_desktop_by_window(&self, hwnd: HWND) -> Result<DesktopID, Error>

Get window desktop ID

pub fn is_window_on_current_virtual_desktop(
    &self,
    hwnd: HWND
) -> Result<bool, Error>

Is window on current virtual desktop

pub fn is_window_on_desktop(
    &self,
    hwnd: HWND,
    desktop: &DesktopID
) -> Result<bool, Error>

Is window on desktop

pub fn move_window_to_desktop(
    &self,
    hwnd: HWND,
    desktop: &DesktopID
) -> Result<(), Error>

Move window to desktop

pub fn go_to_desktop(&self, desktop: &DesktopID) -> Result<(), Error>

Go to desktop

pub fn is_pinned_window(&self, hwnd: HWND) -> Result<bool, Error>

Is window pinned?

pub fn pin_window(&self, hwnd: HWND) -> Result<(), Error>

Pin window

pub fn unpin_window(&self, hwnd: HWND) -> Result<(), Error>

Unpin window

pub fn on_desktop_change(&self, callback: Box<dyn Fn(DesktopID, DesktopID)>)

Callback for desktop change event, callback gets old desktop id, and new desktop id

pub fn on_desktop_created(&self, callback: Box<dyn Fn(DesktopID)>)

Callback for desktop creation, callback recieves new desktop id

pub fn on_desktop_destroyed(&self, callback: Box<dyn Fn(DesktopID)>)

Callback for on desktop destroy event, callback recieves old desktop id

pub fn on_window_change(&self, callback: Box<dyn Fn(HWND)>)

Callback for window changes, e.g. if window changes to different desktop, or window gets destroyed. Callback recieves HWND of thumbnail window (most likely top level window HWND).

Note This can be a very chatty callback, and may have some false positives.

Trait Implementations

impl Drop for VirtualDesktopService

fn drop(&mut self)

Executes the destructor for this type.