File: ax_annotator.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (54 lines) | stat: -rw-r--r-- 1,800 bytes parent folder | download | duplicates (9)
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
// 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.

#ifndef CONTENT_RENDERER_ACCESSIBILITY_ANNOTATIONS_AX_ANNOTATOR_H_
#define CONTENT_RENDERER_ACCESSIBILITY_ANNOTATIONS_AX_ANNOTATOR_H_

#include <vector>

#include "content/common/content_export.h"
#include "ui/accessibility/ax_mode.h"
#include "ui/accessibility/ax_node_data.h"
#include "ui/accessibility/ax_tree_update.h"

namespace blink {
class WebDocument;
}  // namespace blink

namespace content {

class CONTENT_EXPORT AXAnnotator {
 public:
  virtual ~AXAnnotator() = default;

  // Annotate the document with the given updates. |load_complete| is a boolean
  // denoting whether this annotate call was the result of a load complete.
  virtual void Annotate(const blink::WebDocument& document,
                        ui::AXTreeUpdate* update,
                        bool load_complete) = 0;

  // Enables the annotations feature. In many cases, sets up the mojo pipe
  // to the service which will perform the annotations.
  virtual void EnableAnnotations() = 0;

  // Cancel any in-progress annotations.
  virtual void CancelAnnotations() = 0;

  // Returns the AXMode which enables this AXAnnotator.
  virtual uint32_t GetAXModeToEnableAnnotations() = 0;

  // Returns whether this AXAnnotator has an action which enables it.
  virtual bool HasAXActionToEnableAnnotations() = 0;

  // Returns the action which enables this AXAnnotator.
  virtual ax::mojom::Action GetAXActionToEnableAnnotations() = 0;

  // Add any additional debugging attributes.
  virtual void AddDebuggingAttributes(
      const std::vector<ui::AXTreeUpdate>& updates) = 0;
};

}  // namespace content

#endif  // CONTENT_RENDERER_ACCESSIBILITY_ANNOTATIONS_AX_ANNOTATOR_H_