blob: fc9a83d98d5fa6393eb7f00b20803555fa403746 [file] [log] [blame]
Avi Drissman3e1a26c2022-09-15 20:26:031// Copyright 2014 The Chromium Authors
[email protected]2a25d8022014-02-09 03:12:552// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef UI_GFX_FONT_LIST_IMPL_H_
6#define UI_GFX_FONT_LIST_IMPL_H_
7
8#include <string>
9#include <vector>
10
11#include "base/memory/ref_counted.h"
mboc998e8902016-06-02 11:40:3512#include "ui/gfx/font.h"
[email protected]2a25d8022014-02-09 03:12:5513
14namespace gfx {
15
[email protected]2a25d8022014-02-09 03:12:5516// FontListImpl is designed to provide the implementation of FontList and
17// intended to be used only from FontList. You must not use this class
18// directly.
19//
20// FontListImpl represents a list of fonts either in the form of Font vector or
21// in the form of a string representing font names, styles, and size.
22//
23// FontListImpl could be initialized either way without conversion to the other
24// form. The conversion to the other form is done only when asked to get the
25// other form.
26//
27// For the format of font description string, see font_list.h for details.
28class FontListImpl : public base::RefCounted<FontListImpl> {
29 public:
30 // Creates a font list from a string representing font names, styles, and
31 // size.
32 explicit FontListImpl(const std::string& font_description_string);
33
mboc998e8902016-06-02 11:40:3534 // Creates a font list from font names, styles, size and weight.
[email protected]2a25d8022014-02-09 03:12:5535 FontListImpl(const std::vector<std::string>& font_names,
36 int font_style,
mboc998e8902016-06-02 11:40:3537 int font_size,
38 Font::Weight font_weight);
[email protected]2a25d8022014-02-09 03:12:5539
40 // Creates a font list from a Font vector.
41 // All fonts in this vector should have the same style and size.
42 explicit FontListImpl(const std::vector<Font>& fonts);
43
44 // Creates a font list from a Font.
45 explicit FontListImpl(const Font& font);
46
47 // Returns a new FontListImpl with the same font names but resized and the
mboc998e8902016-06-02 11:40:3548 // given style and weight. |size_delta| is the size in pixels to add to the
49 // current font size. |font_style| specifies the new style, which is a
50 // bitmask of the values: Font::ITALIC and Font::UNDERLINE.
51 FontListImpl* Derive(int size_delta,
52 int font_style,
53 Font::Weight weight) const;
[email protected]2a25d8022014-02-09 03:12:5554
55 // Returns the height of this font list, which is max(ascent) + max(descent)
56 // for all the fonts in the font list.
57 int GetHeight() const;
58
59 // Returns the baseline of this font list, which is max(baseline) for all the
60 // fonts in the font list.
61 int GetBaseline() const;
62
63 // Returns the cap height of this font list.
64 // Currently returns the cap height of the primary font.
65 int GetCapHeight() const;
66
67 // Returns the expected number of horizontal pixels needed to display the
68 // specified length of characters. Call GetStringWidth() to retrieve the
69 // actual number.
70 int GetExpectedTextWidth(int length) const;
71
mboc998e8902016-06-02 11:40:3572 // Returns the |Font::FontStyle| style flags for this font list.
[email protected]2a25d8022014-02-09 03:12:5573 int GetFontStyle() const;
74
[email protected]2a25d8022014-02-09 03:12:5575 // Returns the font size in pixels.
76 int GetFontSize() const;
77
mboc998e8902016-06-02 11:40:3578 // Returns the font weight.
79 Font::Weight GetFontWeight() const;
80
[email protected]