Naboo's Podracing Misadventure

    winctl

    1.0.2 • Public • Published

    Windows window manipulation for node.js

    Build status

    winctl wraps a few functions of the windows api to allow iterating over currently opened windows and performing a few limited operations on them. This is not a production ready module! There is no real documentation either yet. Sorry for that.

    The example has to suffice for now.

    Contents

    Requirements

    This module is currently only compatible with Windows. Please ensure you have the required dependencies as well as Visual Studio installed.

    Building

    node-gyp is required to build xinput.js.

    Install node-gyp using npm:

    npm install -g node-gyp
    

    Then configure and build:

    node-gyp configure
    node-gyp build
    

    Example

    var winctl = require('../');
     
    var win = winctl.GetActiveWindow();
     
    // Output some information about the currently active window
    console.log("Active Window Hwnd:", win.getHwnd());
    console.log("Active Window Title:", win.getTitle());
    console.log("Dimensions:", win.dimensions());
    /* ->
    Active Window Hwnd: 26282110
    Active Window Title: Bash cpp-modules/winctl
    Dimensions: { left: 708, top: 112, right: 2025, bottom: 1132 }
    */
     
    // Manipulate the currently active window a bit
    // Move active window to 0,0 and resize it to 800x600
    win.move(0, 0, 800, 600);
     
    // Move active window to the right by 30px and increase its width by 60px
    win.moveRelative(30, 0, 60, 0);
     
    // Minimize the active window
    win.showWindow(winctl.WindowStates.MINIMIZE);
     
    console.log();
     
    // Find a windows "File Explorer" window by ClassName
    console.log("Title of window with class 'CabinetWClass':", winctl.GetWindowByClassName("CabinetWClass").getTitle());
     
    // Find a window by exact title
    console.log("HWND of window with exact title 'File Explorer':", winctl.GetWindowByTitleExact("File Explorer").getHwnd());
     
    // Find first window containing the string 'alc' and bring it to the foreground
    winctl.FindByTitle("alc").then(window => {
        console.log("Title of window with title 'alc':", window.getTitle());
        // --> Title of window with title 'alc': Calculator
     
        // Activate the window
        window.setForegroundWindow();
    });
     
    // Iterate over all windows with a custom filter -> show all visible windows
    winctl.FindWindows(win => win.isVisible() && win.getTitle()).then(windows => {
        console.log("Visible windows:");
        windows.sort((a,b) => a.getTitle().localeCompare(b.getTitle())).forEach(window => console.log(" - %s [pid=%d, hwnd=%d, parent=%d]", window.getTitle(), window.getPid(), window.getHwnd(), window.getParent()));
    });
    /* -->
    Visible windows:
     - Bash cpp-modules/winctl [pid=27196, hwnd=26282110, parent=NaN]
     - Bash cpp-modules/winctl [pid=30696, hwnd=10357510, parent=NaN]
     - Calculator [pid=6948, hwnd=5311194, parent=NaN]
     - File Explorer [pid=4860, hwnd=5115324, parent=NaN]
     - src [pid=4860, hwnd=219155192, parent=NaN]
    */
     
     
    // Log when a new window opens or the active window changes
    winctl.Events.addListener("active-window", function(now, prev) {
        console.log("Changed active window to: %s [prev=%s]", now.getTitle(), prev.getTitle());
    });
     
    winctl.Events.addListener("open-window", function(win) {
        console.log("Opened new window: %s [%d]", win.getTitle(), win.getHwnd());
    });
     
    // Stop listening after 5s
    setTimeout(() => {
        winctl.Events.removeAllListeners("active-window");
        winctl.Events.removeAllListeners("open-window");
        console.log("---done---");
    }, 5000);

    License

    MIT

    Install

    npm i winctl

    DownloadsWeekly Downloads

    7

    Version

    1.0.2

    License

    ISC

    Last publish

    Collaborators

    • davenonymous