[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / platform / Theme.h
1 /*
2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef Theme_h
27 #define Theme_h
28
29 #include "Color.h"
30 #include "ControlStates.h"
31 #include "FontCascade.h"
32 #include "GraphicsTypes.h"
33 #include "IntRect.h"
34 #include "LengthBox.h"
35 #include "LengthSize.h"
36 #include "ThemeTypes.h"
37 #include <wtf/Forward.h>
38 #include <wtf/Optional.h>
39
40 namespace WebCore {
41
42 class GraphicsContext;
43 class ScrollView;
44
45 // Unlike other platform classes, Theme does extensively use virtual functions.  This design allows a platform to switch between multiple themes at runtime.
46 class Theme {
47 public:
48     Theme() { }
49     virtual ~Theme() { }
50
51     // A method to obtain the baseline position adjustment for a "leaf" control.  This will only be used if a baseline
52     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
53     // controls that need to do this.  The adjustment is an offset that adds to the baseline, e.g., marginTop() + height() + |offset|.
54     // The offset is not zoomed.
55     virtual int baselinePositionAdjustment(ControlPart) const { return 0; }
56
57     // A method asking if the control changes its appearance when the window is inactive.
58     virtual bool controlHasInactiveAppearance(ControlPart) const { return false; }
59     
60     // General methods for whether or not any of the controls in the theme change appearance when the window is inactive or
61     // when hovered over.
62     virtual bool controlsCanHaveInactiveAppearance() const { return false; }
63     virtual bool controlsCanHaveHoveredAppearance() const { return false; }
64
65     // Used by RenderTheme::isControlStyled to figure out if the native look and feel should be turned off.
66     virtual bool controlDrawsBorder(ControlPart) const { return true; }
67     virtual bool controlDrawsBackground(ControlPart) const { return true; }
68     virtual bool controlDrawsFocusOutline(ControlPart) const { return true; }
69
70     // Methods for obtaining platform-specific colors.
71     virtual Color selectionColor(ControlPart, const ControlStates&, SelectionPart) const { return Color(); }
72     virtual Color textSearchHighlightColor() const { return Color(); }
73     
74     // CSS system colors and fonts
75     virtual Color systemColor(ThemeColor) const { return Color(); }
76     virtual FontCascade systemFont(ThemeFont, FontDescription&) const { return FontCascade(); }
77     
78     // How fast the caret blinks in text fields.
79     virtual double caretBlinkInterval() const { return 0.5; }
80
81     // Notification when the theme has changed
82     virtual void themeChanged() { }
83
84     // Methods used to adjust the RenderStyles of controls.
85     
86     // The font description result should have a zoomed font size.
87     virtual std::optional<FontCascadeDescription> controlFont(ControlPart, const FontCascade&, float /*zoomFactor*/) const { return std::nullopt; }
88     
89     // The size here is in zoomed coordinates already. If a new size is returned, it also needs to be in zoomed coordinates.
90     virtual LengthSize controlSize(ControlPart, const FontCascade&, const LengthSize& zoomedSize, float /*zoomFactor*/) const { return zoomedSize; }
91     
92     // Returns the minimum size for a control in zoomed coordinates.  
93     virtual LengthSize minimumControlSize(ControlPart, const FontCascade&, float /*zoomFactor*/) const { return LengthSize(Length(0, Fixed), Length(0, Fixed)); }
94     
95     // Allows the theme to modify the existing padding/border.
96     virtual LengthBox controlPadding(ControlPart, const FontCascade&, const LengthBox& zoomedBox, float zoomFactor) const;
97     virtual LengthBox controlBorder(ControlPart, const FontCascade&, const LengthBox& zoomedBox, float zoomFactor) const;
98     
99     // Whether or not whitespace: pre should be forced on always.
100     virtual bool controlRequiresPreWhiteSpace(ControlPart) const { return false; }
101
102     // Method for painting a control. The rect is in zoomed coordinates.
103     virtual void paint(ControlPart, ControlStates&, GraphicsContext&, const FloatRect& /*zoomedRect*/, float /*zoomFactor*/, ScrollView*, float /*deviceScaleFactor*/, float /*pageScaleFactor*/) { }
104
105     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
106     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
107     // The rect passed in is in zoomed coordinates, so the inflation should take that into account and make sure the inflation
108     // amount is also scaled by the zoomFactor.
109     virtual void inflateControlPaintRect(ControlPart, const ControlStates&, FloatRect& /*zoomedRect*/, float /*zoomFactor*/) const { }
110
111     virtual void drawNamedImage(const String&, GraphicsContext&, const FloatRect&) const;
112
113     virtual bool userPrefersReducedMotion() const { return false; }
114
115     // This method is called once, from RenderTheme::adjustDefaultStyleSheet(), to let each platform adjust
116     // the default CSS rules in html.css.
117     static String defaultStyleSheet();
118
119 private:
120     mutable Color m_activeSelectionColor;
121     mutable Color m_inactiveSelectionColor;
122 };
123
124 // Function to obtain the theme.  This is implemented in the platform-specific subclasses.
125 Theme* platformTheme();
126
127 } // namespace WebCore
128
129 #endif // Theme_h