File: input_controller.ts

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (83 lines) | stat: -rw-r--r-- 2,762 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

type AutomationNode = chrome.automation.AutomationNode;

export interface EditableNodeData {
  node: AutomationNode;
  value: string;
  selStart: number;
  selEnd: number;
}

/**
 * InputController handles interaction with input fields for Accessibility
 * features.
 */
export abstract class InputController {
  constructor() {}

  /** Whether this is an active InputController with a focused input */
  abstract isActive(): boolean;

  /**
   * Commits the given text to the active IME context.
   */
  abstract commitText(text: string): void;


  /**
   * Deletes the sentence to the left of the text caret. If the caret is in the
   * middle of a sentence, it will delete a portion of the sentence it
   * intersects.
   */
  abstract deletePrevSentence(): void;

  /**
   * Deletes a phrase to the left of the text caret. If multiple instances of
   * `phrase` are present, it deletes the one closest to the text caret.
   * @param phrase The phrase to be deleted.
   */
  abstract deletePhrase(phrase: string): void;

  /**
   * Replaces a phrase to the left of the text caret with another phrase. If
   * multiple instances of `deletePhrase` are present, this function will
   * replace the one closest to the text caret.
   * @param deletePhrase The phrase to be deleted.
   * @param insertPhrase The phrase to be inserted.
   */
  abstract replacePhrase(deletePhrase: string, insertPhrase: string):
      Promise<void>;

  /**
   * Inserts `insertPhrase` directly before `beforePhrase` (and separates them
   * with a space). This function operates on the text to the left of the caret.
   * If multiple instances of `beforePhrase` are present, this function will
   * use the one closest to the text caret.
   */
  abstract insertBefore(insertPhrase: string, beforePhrase: string):
      Promise<void>;

  /**
   * Sets selection starting at `startPhrase` and ending at `endPhrase`
   * (inclusive). The function operates on the text to the left of the text
   * caret. If multiple instances of `startPhrase` or `endPhrase` are present,
   * the function will use the ones closest to the text caret.
   */
  abstract selectBetween(startPhrase: string, endPhrase: string): void;

  /** Moves the text caret to the next sentence. */
  abstract navNextSent(): Promise<void>;

  /** Moves the text caret to the previous sentence. */
  abstract navPrevSent(): Promise<void>;

  /**
   * Returns the editable node, its value, the selection start, and the
   * selection end.
   * TODO(crbug.com/1353871): Only return text that is visible on-screen.
   */
  abstract getEditableNodeData(): EditableNodeData|null;
}