File: keyboard_code_util.h

package info (click to toggle)
chromium 145.0.7632.159-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,976,224 kB
  • sloc: cpp: 36,198,469; ansic: 7,634,080; javascript: 3,564,060; python: 1,649,622; xml: 838,470; asm: 717,087; pascal: 185,708; sh: 88,786; perl: 88,718; objc: 79,984; sql: 59,811; cs: 42,452; fortran: 24,101; makefile: 21,144; tcl: 15,277; php: 14,022; yacc: 9,066; ruby: 7,553; awk: 3,720; lisp: 3,233; lex: 1,328; ada: 727; jsp: 228; sed: 36
file content (46 lines) | stat: -rw-r--r-- 1,804 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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef ASH_ACCELERATORS_KEYBOARD_CODE_UTIL_H_
#define ASH_ACCELERATORS_KEYBOARD_CODE_UTIL_H_

#include <string>

#include "ash/ash_export.h"
#include "ui/events/keycodes/keyboard_codes_posix.h"

namespace gfx {
struct VectorIcon;
}  // namespace gfx

namespace ash {

// Returns the string of a DomKey for a given VKEY. VKEY needs to be mapped to
// a physical key `dom_code` and then the `dom_code` needs to be mapped to a
// meaning or character of `dom_key` based on the corresponding keyboard layout.
//
// For shortcuts based on keys that use positional mapping, eg. plus, minus,
// left/right bracket, comma, period, or slash the VKEY is mapped to the
// glyph on the key with the same physical position as the US layout. This
// remapping can be disabled by passing false to `remap_positional_key`. This
// is currently used for the 2 browser shortcuts that use these keys but are
// not remapped (page zoom in/out).
//
// Returns empty string if the `dom_key` has no mapped meaning or character.
ASH_EXPORT std::u16string GetStringForKeyboardCode(
    ui::KeyboardCode key_code,
    bool remap_positional_key = true);

// Returns the VectorIcon if `key_code` needs to be represented as an icon.
// Returns nullptr if `key_code` should not be represented as an icon.
ASH_EXPORT const gfx::VectorIcon* GetVectorIconForKeyboardCode(
    ui::KeyboardCode key_code);

// Returns the corresponding vector icon for search or launcher key depending on
// the keyboard layout and whether the assistant is enabled or not.
ASH_EXPORT const gfx::VectorIcon* GetSearchOrLauncherVectorIcon();

}  // namespace ash

#endif  // ASH_ACCELERATORS_KEYBOARD_CODE_UTIL_H_