Help Topics for screen

clip · copy

Sample CLI

gway clip copy

References

debug, screen, screen.notify, warning

Signature

(value=None, *, notify=True, when=None)

Docstring

Extracts or updates the clipboard contents. Args: value (str, optional): The value to copy to clipboard. If None, only reads the clipboard. notify (bool, optional): Whether to send a GUI notification. Default is True. when (str | Pattern, optional): If provided, must match clipboard contents. Acts as a gatekeeper: if there's no match, returns None and skips updating. Returns: str | None: The previous clipboard content, or None if `when` did not match.
clip · track_history

Sample CLI

gway clip track-history

References

debug, info, resource, screen, screen.notify, warning

Signature

(interval: int = 5, *, stop_after=None, notify=True)

Docstring

Tracks clipboard history by polling at regular intervals. Args: interval (int): Seconds to wait between checks. Default is 5 seconds. stop_after (int | None): Optional maximum duration (in seconds) before stopping. notify (bool): Whether to show GUI notifications for new entries. Writes: Appends new clipboard entries to 'work/clip/history.txt', separated by ' ... '.
screen · instruct

Sample CLI

gway screen instruct

Signature

(steps, *, title='GWAY Next Steps', timeout: int = 300, **kwargs)

Docstring

Display a series of steps using a notify box.
screen · lookup_font

Sample CLI

gway screen lookup-font

Signature

(*prefix)

Docstring

Look up fonts installed on a Windows system by partial name (prefix). >> gway font lookup Ari
screen · notify

Sample CLI

gway screen notify

References

critical, info

Signature

(message, *, title='GWAY Notice', timeout: int = 10)

Docstring

Show a user interface notification with the specified title and message. Falls back to a visible console printout if GUI notification fails.
screen · reminder

Sample CLI

gway screen reminder

References

resource

Signature

(message, *, interval: float = 20.0, daemon=False, lines: int = 2)

Docstring

Starts a thread that periodically takes screenshots. If the screen hasn't changed between intervals, overlays a reminder message and waits for user interaction before resuming.
screen · render_text

Sample CLI

gway screen render-text

Signature

(text, *, size=(800, 600), bg=None, fg=(255, 255, 255), font_name=None, lines=2) -> PIL.Image.Image
screen · shot

Sample CLI

gway screen shot

References

resource

Signature

(*, name: str = None, mode: str = 'full') -> str

Docstring

Take a screenshot in the specified mode and save it under: gw.resource("work", "screenshots") The filename will be: <active_window_name>_<YYYYMMDD_HHMMSS>.png Returns: The full path to the saved screenshot file. Modes: - "full": entire screen - "active"/"window": active window only (Windows only; falls back to full)