File: cursor_factory.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; 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,806; 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 (103 lines) | stat: -rw-r--r-- 3,158 bytes parent folder | download | duplicates (7)
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_BASE_CURSOR_CURSOR_FACTORY_H_
#define UI_BASE_CURSOR_CURSOR_FACTORY_H_

#include <optional>
#include <string>
#include <vector>

#include "base/component_export.h"
#include "base/observer_list.h"
#include "build/build_config.h"
#include "ui/base/cursor/mojom/cursor_type.mojom-forward.h"

class SkBitmap;

template <class T>
class scoped_refptr;

namespace base {
class TimeDelta;
}

namespace gfx {
class Point;
}

namespace ui {
class PlatformCursor;
struct CursorData;

class COMPONENT_EXPORT(UI_BASE_CURSOR) CursorFactoryObserver {
 public:
  // Called by the factory after it has loaded the cursor theme.
  virtual void OnThemeLoaded() = 0;

  virtual ~CursorFactoryObserver();
};

class COMPONENT_EXPORT(UI_BASE_CURSOR) CursorFactory {
 public:
  CursorFactory();
  virtual ~CursorFactory();

  // Returns the thread-local instance.
  static CursorFactory* GetInstance();

  void AddObserver(CursorFactoryObserver* observer);
  void RemoveObserver(CursorFactoryObserver* observer);
  void NotifyObserversOnThemeLoaded();

  // Return the default cursor of the specified type. When a default cursor is
  // not available, nullptr is returned.
  virtual scoped_refptr<PlatformCursor> GetDefaultCursor(
      mojom::CursorType type);

  // Return the default cursor of the specified type. When a default cursor is
  // not available, nullptr is returned. This is implemented by backends that
  // manages its own cursor images and therefore needs to know the appropriate
  // scale to load them at.
  virtual scoped_refptr<PlatformCursor> GetDefaultCursor(mojom::CursorType type,
                                                         float scale);

  // Return the {bitmaps, hotspot} for the default cursor of the specified
  // `type`. If that cursor is not available or the extraction of the data
  // fails, return `std::nullopt`.
  virtual std::optional<CursorData> GetCursorData(mojom::CursorType type);

  // Return an image cursor for the specified `type` with a `bitmap` and
  // `hotspot` and `scale`.
  virtual scoped_refptr<PlatformCursor> CreateImageCursor(
      mojom::CursorType type,
      const SkBitmap& bitmap,
      const gfx::Point& hotspot,
      float scale);

  // Return a animated cursor from the specified `bitmaps` and `hotspot`
  // and `scale`. `frame_delay` is the delay between frames.
  virtual scoped_refptr<PlatformCursor> CreateAnimatedCursor(
      mojom::CursorType type,
      const std::vector<SkBitmap>& bitmaps,
      const gfx::Point& hotspot,
      float scale,
      base::TimeDelta frame_delay);

  // Called after CursorThemeManager is initialized, to be able to track
  // cursor theme and size changes.
  virtual void ObserveThemeChanges();

 private:
  base::ObserverList<CursorFactoryObserver>::Unchecked observers_;
};

#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
COMPONENT_EXPORT(UI_BASE_CURSOR)
std::vector<std::string> CursorNamesFromType(mojom::CursorType type);
#endif

}  // namespace ui

#endif  // UI_BASE_CURSOR_CURSOR_FACTORY_H_