desktop

type AmbiguousError struct {
	Selector Selector
	Count    int
}

type Backend interface {
	// Capture returns the primary display in physical pixels.
	Capture() (*image.RGBA, error)
	// MoveTo moves the pointer to a physical pixel position.
	MoveTo(x, y int) error
	// Position reports the pointer's physical pixel position.
	Position() (x, y int, err error)
	// Button presses or releases a button at the pointer. clicks counts
	// the clicks of a multi-click so far, starting at 1.
	Button(button Button, down bool, clicks int) error
	// Wheel scrolls by wheel notches; positive values scroll right and down.
	Wheel(dx, dy int) error
	// Key presses or releases a key.
	Key(key Key, down bool) error
	// Type types text at the keyboard focus.
	Type(text string) error
	// FocusedWindow reports the window that has the keyboard focus, or a
	// zero WindowID where the system does not say.
	FocusedWindow() WindowID
	// WindowAt reports the top-level window under a physical pixel
	// position, or a zero WindowID where the system does not say.
	WindowAt(x, y int) WindowID
	// Windows lists the visible top-level windows, the front of the
	// Z-order first. It is empty where the system does not enumerate them.
	Windows() []WindowID
	// Raise brings a window to the foreground. It is a best effort: the
	// system may refuse a foreground change asked by a background process.
	Raise(w WindowID) error
	// LastInput reports when the desktop last received pointer or keyboard
	// input from any source, the driver included, or the zero time when it
	// cannot tell.
	LastInput() time.Time
	// Close releases the backend.
	Close() error
}

type Button string

type Diagnostics struct {
	OS     string
	Width  int
	Height int
	// Problems are the reasons automation cannot work, such as a missing
	// permission; empty when the desktop is usable.
	Problems []Problem
}

type Driver struct {
	// contains filtered or unexported fields
}

type Element struct {
	Role string
	Name string
	// ID is the identifier the application gives the element, when it
	// sets one: the UI Automation AutomationId on Windows.
	ID string
	// Value is what the element holds, such as the text of a field. It is
	// blank for a password field.
	Value string
	// Label is the name of the element that labels this one, when the
	// application links them.
	Label string
	// App is the process image name without its extension. It is set on
	// window elements.
	App string
	// Bounds is where the element is, in display pixels.
	Bounds image.Rectangle
	// Window is the title of the window the element belongs to.
	Window string
	// Path leads from the window down to the element. A window's path is
	// empty.
	Path []PathStep
}

type Elements interface {
	// At returns the element under a point.
	At(x, y int) (Element, error)
	// Focused returns the element with the keyboard focus.
	Focused() (Element, error)
	// Find returns the elements a selector matches in the front window, in
	// reading order. It returns no error and no elements when nothing
	// matches.
	Find(Selector) ([]Element, error)
	// FrontWindow returns the window in front.
	FrontWindow() (Element, error)
	// Outline lists the visible elements of a window in tree order, at
	// most limit of them, or a bounded number when limit is 0.
	Outline(window Element, limit int) ([]Element, error)
	// Focus gives an element the keyboard focus.
	Focus(Element) error
	// Apply has an element perform a pattern itself, finding it again as
	// Focus does; value is the text PatternSetValue sets. ErrNoPattern says
	// the element cannot, so the action falls back to the pointer and keys;
	// ErrDisabled says it takes no input yet; a read-only field or an
	// element with nothing to expand is an error saying so.
	Apply(target Element, pattern Pattern, value string) error
	// Rows reads a grid, table, or list's rows as text, one []string per
	// row, each cell the text under the column that columns names by its
	// header, up to max rows. A container with no grid, a column with no
	// header, or an unreadable cell is an error. It may take longer than
	// one read, so it is bounded by ctx.
	Rows(ctx context.Context, container Selector, columns []string, max int) ([][]string, error)
	Close() error
}

type Fingerprint uint64

type Key string

type Near struct {
	Label string `json:"label"`
	Side  string `json:"side"`
}

type PathStep struct {
	Role string `json:"role"`
	Name string `json:"name"`
	// Index is the element's position among its parent's children of the
	// same role, from 0.
	Index int `json:"index"`
}

type Pattern string

type Problem struct {
	// Code identifies the kind of problem, such as screen_locked, for
	// programs that act on it.
	Code string `json:"code"`
	// Message explains the problem and how to fix it.
	Message string `json:"message"`
}

type Selector struct {
	// App is the process image name without its extension, compared
	// ignoring case.
	App string `json:"app,omitempty"`
	// Window is text the window title contains.
	Window string `json:"window,omitempty"`
	Role   string `json:"role"`
	// Name is the accessible name, exact.
	Name string `json:"name,omitempty"`
	// ID is the identifier the application gives the element.
	ID string `json:"id,omitempty"`
	// In narrows the search to the descendants of one container.
	In *Selector `json:"in,omitempty"`
	// Near keeps the element labelled by a label.
	Near *Near `json:"near,omitempty"`
	// Nth picks one of several equal matches, in reading order, from 0.
	Nth *int `json:"nth,omitempty"`
}

type WindowID struct {
	Handle uint64
	Title  string
	PID    uint32
	// App is the window's process image name without its extension, the
	// stable identity a replay raises a window by, since a title often
	// shows the document's contents. Empty where the system does not say.
	App string
}