Remove monotonicallyIncreasingTime
[WebKit-https.git] / Source / WebCore / rendering / RenderTheme.h
1 /*
2  * Copyright (C) 2005-2017 Apple Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #pragma once
22
23 #include "ControlStates.h"
24 #include "PaintInfo.h"
25 #include "PopupMenuStyle.h"
26 #include "ScrollTypes.h"
27 #include "ThemeTypes.h"
28
29 namespace WebCore {
30
31 class BorderData;
32 class Element;
33 class FileList;
34 class FillLayer;
35 class HTMLInputElement;
36 class Icon;
37 class RenderAttachment;
38 class RenderBox;
39 class RenderMeter;
40 class RenderObject;
41 class RenderProgress;
42 class RenderStyle;
43 class StyleResolver;
44
45 class RenderTheme {
46 protected:
47     RenderTheme();
48
49     virtual ~RenderTheme() = default;
50
51 public:
52     // This function is to be implemented in platform-specific theme implementations to hand back the
53     // appropriate platform theme.
54     WEBCORE_EXPORT static RenderTheme& singleton();
55
56     virtual void purgeCaches() { }
57
58     // This method is called whenever style has been computed for an element and the appearance
59     // property has been set to a value other than "none".  The theme should map in all of the appropriate
60     // metrics and defaults given the contents of the style.  This includes sophisticated operations like
61     // selection of control size based off the font, the disabling of appearance when certain other properties like
62     // "border" are set, or if the appearance is not supported by the theme.
63     void adjustStyle(StyleResolver&, RenderStyle&, const Element*,  bool UAHasAppearance, const BorderData&, const FillLayer&, const Color& backgroundColor);
64
65     // This method is called to paint the widget as a background of the RenderObject.  A widget's foreground, e.g., the
66     // text of a button, is always rendered by the engine itself.  The boolean return value indicates
67     // whether the CSS border/background should also be painted.
68     bool paint(const RenderBox&, ControlStates&, const PaintInfo&, const LayoutRect&);
69     bool paintBorderOnly(const RenderBox&, const PaintInfo&, const LayoutRect&);
70     bool paintDecorations(const RenderBox&, const PaintInfo&, const LayoutRect&);
71
72     // The remaining methods should be implemented by the platform-specific portion of the theme, e.g.,
73     // RenderThemeMac.cpp for Mac OS X.
74
75     // These methods return the theme's extra style sheets rules, to let each platform
76     // adjust the default CSS rules in html.css, quirks.css, mediaControls.css, or plugIns.css
77     virtual String extraDefaultStyleSheet() { return String(); }
78     virtual String extraQuirksStyleSheet() { return String(); }
79     virtual String extraPlugInsStyleSheet() { return String(); }
80 #if ENABLE(VIDEO)
81     virtual String mediaControlsStyleSheet() { return String(); }
82     virtual String modernMediaControlsStyleSheet() { return String(); }
83     virtual String extraMediaControlsStyleSheet() { return String(); }
84     virtual String mediaControlsScript() { return String(); }
85     virtual String mediaControlsBase64StringForIconNameAndType(const String&, const String&) { return String(); }
86     virtual String mediaControlsFormattedStringForDuration(double) { return String(); }
87 #endif
88 #if ENABLE(FULLSCREEN_API)
89     virtual String extraFullScreenStyleSheet() { return String(); }
90 #endif
91 #if ENABLE(SERVICE_CONTROLS)
92     virtual String imageControlsStyleSheet() const { return String(); }
93 #endif
94
95     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
96     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
97     // controls that need to do this.
98     virtual int baselinePosition(const RenderBox&) const;
99
100     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
101     // the baseline position API above).
102     bool isControlContainer(ControlPart) const;
103
104     // A method asking if the control changes its tint when the window has focus or not.
105     virtual bool controlSupportsTints(const RenderObject&) const { return false; }
106
107     // Whether or not the control has been styled enough by the author to disable the native appearance.
108     virtual bool isControlStyled(const RenderStyle&, const BorderData&, const FillLayer&, const Color& backgroundColor) const;
109
110     // A general method asking if any control tinting is supported at all.
111     virtual bool supportsControlTints() const { return false; }
112
113     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
114     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
115     virtual void adjustRepaintRect(const RenderObject&, FloatRect&);
116
117     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
118     // or a control becomes disabled.
119     virtual bool stateChanged(const RenderObject&, ControlStates::States) const;
120
121     // This method is called whenever the theme changes on the system in order to flush cached resources from the
122     // old theme.
123     virtual void themeChanged() { }
124
125     // A method asking if the theme is able to draw the focus ring.
126     virtual bool supportsFocusRing(const RenderStyle&) const;
127
128     // A method asking if the theme's controls actually care about redrawing when hovered.
129     virtual bool supportsHover(const RenderStyle&) const { return false; }
130
131     // A method asking if the platform is able to show datalist suggestions for a given input type.
132     virtual bool supportsDataListUI(const AtomicString&) const { return false; }
133
134     // Text selection colors.
135     Color activeSelectionBackgroundColor() const;
136     Color inactiveSelectionBackgroundColor() const;
137     Color activeSelectionForegroundColor() const;
138     Color inactiveSelectionForegroundColor() const;
139
140     // List box selection colors
141     Color activeListBoxSelectionBackgroundColor() const;
142     Color activeListBoxSelectionForegroundColor() const;
143     Color inactiveListBoxSelectionBackgroundColor() const;
144     Color inactiveListBoxSelectionForegroundColor() const;
145
146     // Highlighting colors for TextMatches.
147     virtual Color platformActiveTextSearchHighlightColor() const;
148     virtual Color platformInactiveTextSearchHighlightColor() const;
149
150     virtual Color disabledTextColor(const Color& textColor, const Color& backgroundColor) const;
151
152     static Color focusRingColor();
153     virtual Color platformFocusRingColor() const { return Color(0, 0, 0); }
154     static void setCustomFocusRingColor(const Color&);
155     static float platformFocusRingWidth() { return 3; }
156     static float platformFocusRingOffset(float outlineWidth) { return std::max<float>(outlineWidth - platformFocusRingWidth(), 0); }
157 #if ENABLE(TOUCH_EVENTS)
158     static Color tapHighlightColor();
159     virtual Color platformTapHighlightColor() const;
160 #endif
161     virtual void platformColorsDidChange();
162
163     virtual Seconds caretBlinkInterval() const { return 500_ms; }
164
165     // System fonts and colors for CSS.
166     void systemFont(CSSValueID, FontCascadeDescription&) const;
167     virtual Color systemColor(CSSValueID) const;
168
169     virtual int minimumMenuListSize(const RenderStyle&) const { return 0; }
170
171     virtual void adjustSliderThumbSize(RenderStyle&, const Element*) const;
172
173     virtual LengthBox popupInternalPaddingBox(const RenderStyle&) const { return { 0, 0, 0, 0 }; }
174     virtual bool popupOptionSupportsTextIndent() const { return false; }
175     virtual PopupMenuStyle::PopupMenuSize popupMenuSize(const RenderStyle&, IntRect&) const { return PopupMenuStyle::PopupMenuSizeNormal; }
176
177     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
178
179     // Returns the repeat interval of the animation for the progress bar.
180     virtual Seconds animationRepeatIntervalForProgressBar(RenderProgress&) const;
181     // Returns the duration of the animation for the progress bar.
182     virtual Seconds animationDurationForProgressBar(RenderProgress&) const;
183     virtual IntRect progressBarRectForBounds(const RenderObject&, const IntRect&) const;
184
185 #if ENABLE(VIDEO)
186     // Media controls
187     virtual bool supportsClosedCaptioning() const { return false; }
188     virtual bool hasOwnDisabledStateHandlingFor(ControlPart) const { return false; }
189     virtual bool usesMediaControlStatusDisplay() { return false; }
190     virtual bool usesMediaControlVolumeSlider() const { return true; }
191     virtual bool usesVerticalVolumeSlider() const { return true; }
192     virtual double mediaControlsFadeInDuration() { return 0.1; }
193     virtual Seconds mediaControlsFadeOutDuration() { return 300_ms; }
194     virtual String formatMediaControlsTime(float time) const;
195     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
196     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
197     
198     // Returns the media volume slider container's offset from the mute button.
199     virtual LayoutPoint volumeSliderOffsetFromMuteButton(const RenderBox&, const LayoutSize&) const;
200 #endif
201
202 #if ENABLE(METER_ELEMENT)
203     virtual IntSize meterSizeForBounds(const RenderMeter&, const IntRect&) const;
204     virtual bool supportsMeter(ControlPart) const;
205 #endif
206
207 #if ENABLE(DATALIST_ELEMENT)
208     // Returns the threshold distance for snapping to a slider tick mark.
209     virtual LayoutUnit sliderTickSnappingThreshold() const;
210     // Returns size of one slider tick mark for a horizontal track.
211     // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
212     virtual IntSize sliderTickSize() const = 0;
213     // Returns the distance of slider tick origin from the slider track center.
214     virtual int sliderTickOffsetFromTrackCenter() const = 0;
215     void paintSliderTicks(const RenderObject&, const PaintInfo&, const IntRect&);
216 #endif
217
218     virtual bool shouldHaveSpinButton(const HTMLInputElement&) const;
219     virtual bool shouldHaveCapsLockIndicator(const HTMLInputElement&) const;
220
221     // Functions for <select> elements.
222     virtual bool delegatesMenuListRendering() const { return false; }
223     virtual bool popsMenuByArrowKeys() const { return false; }
224     virtual bool popsMenuBySpaceOrReturn() const { return false; }
225
226     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
227     virtual String fileListNameForWidth(const FileList*, const FontCascade&, int width, bool multipleFilesAllowed) const;
228
229     enum FileUploadDecorations { SingleFile, MultipleFiles };
230     virtual bool paintFileUploadIconDecorations(const RenderObject& /*inputRenderer*/, const RenderObject& /*buttonRenderer*/, const PaintInfo&, const IntRect&, Icon*, FileUploadDecorations) { return true; }
231
232 #if ENABLE(SERVICE_CONTROLS)
233     virtual IntSize imageControlsButtonSize(const RenderObject&) const { return IntSize(); }
234     virtual IntSize imageControlsButtonPositionOffset() const { return IntSize(); }
235 #endif
236
237 #if ENABLE(ATTACHMENT_ELEMENT)
238     virtual LayoutSize attachmentIntrinsicSize(const RenderAttachment&) const { return LayoutSize(); }
239     virtual int attachmentBaseline(const RenderAttachment&) const { return -1; }
240 #endif
241
242     enum class InnerSpinButtonLayout { Vertical, HorizontalUpLeft, HorizontalUpRight };
243     virtual InnerSpinButtonLayout innerSpinButtonLayout(const RenderObject&) const { return InnerSpinButtonLayout::Vertical; }
244
245     virtual bool shouldMockBoldSystemFontForAccessibility() const { return false; }
246     virtual void setShouldMockBoldSystemFontForAccessibility(bool) { }
247
248 protected:
249     virtual FontCascadeDescription& cachedSystemFontDescription(CSSValueID systemFontID) const;
250     virtual void updateCachedSystemFontDescription(CSSValueID systemFontID, FontCascadeDescription&) const = 0;
251
252     // The platform selection color.
253     virtual Color platformActiveSelectionBackgroundColor() const;
254     virtual Color platformInactiveSelectionBackgroundColor() const;
255     virtual Color platformActiveSelectionForegroundColor() const;
256     virtual Color platformInactiveSelectionForegroundColor() const;
257
258     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
259     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
260     virtual Color platformActiveListBoxSelectionForegroundColor() const;
261     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
262
263     virtual bool supportsSelectionForegroundColors() const { return true; }
264     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
265
266 #if !USE(NEW_THEME)
267     // Methods for each appearance value.
268     virtual void adjustCheckboxStyle(StyleResolver&, RenderStyle&, const Element*) const;
269     virtual bool paintCheckbox(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
270     virtual void setCheckboxSize(RenderStyle&) const { }
271
272     virtual void adjustRadioStyle(StyleResolver&, RenderStyle&, const Element*) const;
273     virtual bool paintRadio(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
274     virtual void setRadioSize(RenderStyle&) const { }
275
276     virtual void adjustButtonStyle(StyleResolver&, RenderStyle&, const Element*) const;
277     virtual bool paintButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
278     virtual void setButtonSize(RenderStyle&) const { }
279
280     virtual void adjustInnerSpinButtonStyle(StyleResolver&, RenderStyle&, const Element*) const;
281     virtual bool paintInnerSpinButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
282 #endif
283
284     virtual bool paintCheckboxDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
285     virtual bool paintRadioDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
286     virtual bool paintButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
287
288     virtual void adjustTextFieldStyle(StyleResolver&, RenderStyle&, const Element*) const;
289     virtual bool paintTextField(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
290     virtual bool paintTextFieldDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
291
292     virtual void adjustTextAreaStyle(StyleResolver&, RenderStyle&, const Element*) const;
293     virtual bool paintTextArea(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
294     virtual bool paintTextAreaDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
295
296     virtual void adjustMenuListStyle(StyleResolver&, RenderStyle&, const Element*) const;
297     virtual bool paintMenuList(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
298     virtual bool paintMenuListDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
299
300     virtual void adjustMenuListButtonStyle(StyleResolver&, RenderStyle&, const Element*) const;
301     virtual bool paintMenuListButtonDecorations(const RenderBox&, const PaintInfo&, const FloatRect&) { return true; }
302
303     virtual bool paintPushButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
304     virtual bool paintSquareButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
305
306 #if ENABLE(METER_ELEMENT)
307     virtual void adjustMeterStyle(StyleResolver&, RenderStyle&, const Element*) const;
308     virtual bool paintMeter(const RenderObject&, const PaintInfo&, const IntRect&);
309 #endif
310
311     virtual void adjustCapsLockIndicatorStyle(StyleResolver&, RenderStyle&, const Element*) const;
312     virtual bool paintCapsLockIndicator(const RenderObject&, const PaintInfo&, const IntRect&);
313
314 #if ENABLE(APPLE_PAY)
315     virtual void adjustApplePayButtonStyle(StyleResolver&, RenderStyle&, const Element*) const { }
316     virtual bool paintApplePayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
317 #endif
318
319 #if ENABLE(ATTACHMENT_ELEMENT)
320     virtual void adjustAttachmentStyle(StyleResolver&, RenderStyle&, const Element*) const;
321     virtual bool paintAttachment(const RenderObject&, const PaintInfo&, const IntRect&);
322 #endif
323
324     virtual void adjustProgressBarStyle(StyleResolver&, RenderStyle&, const Element*) const;
325     virtual bool paintProgressBar(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
326
327     virtual void adjustSliderTrackStyle(StyleResolver&, RenderStyle&, const Element*) const;
328     virtual bool paintSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
329
330     virtual void adjustSliderThumbStyle(StyleResolver&, RenderStyle&, const Element*) const;
331     virtual bool paintSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
332     virtual bool paintSliderThumbDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
333
334     virtual void adjustSearchFieldStyle(StyleResolver&, RenderStyle&, const Element*) const;
335     virtual bool paintSearchField(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
336     virtual bool paintSearchFieldDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
337
338     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver&, RenderStyle&, const Element*) const;
339     virtual bool paintSearchFieldCancelButton(const RenderBox&, const PaintInfo&, const IntRect&) { return true; }
340
341     virtual void adjustSearchFieldDecorationPartStyle(StyleResolver&, RenderStyle&, const Element*) const;
342     virtual bool paintSearchFieldDecorationPart(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
343
344     virtual void adjustSearchFieldResultsDecorationPartStyle(StyleResolver&, RenderStyle&, const Element*) const;
345     virtual bool paintSearchFieldResultsDecorationPart(const RenderBox&, const PaintInfo&, const IntRect&) { return true; }
346
347     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver&, RenderStyle&, const Element*) const;
348     virtual bool paintSearchFieldResultsButton(const RenderBox&, const PaintInfo&, const IntRect&) { return true; }
349
350     virtual void adjustMediaControlStyle(StyleResolver&, RenderStyle&, const Element*) const;
351     virtual bool paintMediaFullscreenButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
352     virtual bool paintMediaPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
353     virtual bool paintMediaOverlayPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
354     virtual bool paintMediaMuteButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
355     virtual bool paintMediaSeekBackButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
356     virtual bool paintMediaSeekForwardButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
357     virtual bool paintMediaSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
358     virtual bool paintMediaSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
359     virtual bool paintMediaVolumeSliderContainer(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
360     virtual bool paintMediaVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
361     virtual bool paintMediaVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
362     virtual bool paintMediaRewindButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
363     virtual bool paintMediaReturnToRealtimeButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
364     virtual bool paintMediaToggleClosedCaptionsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
365     virtual bool paintMediaControlsBackground(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
366     virtual bool paintMediaCurrentTime(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
367     virtual bool paintMediaTimeRemaining(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
368     virtual bool paintMediaFullScreenVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
369     virtual bool paintMediaFullScreenVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
370
371     virtual bool paintSnapshottedPluginOverlay(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
372
373 #if ENABLE(SERVICE_CONTROLS)
374     virtual bool paintImageControlsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
375 #endif
376
377 public:
378     void updateControlStatesForRenderer(const RenderBox&, ControlStates&) const;
379     ControlStates::States extractControlStatesForRenderer(const RenderObject&) const;
380     bool isActive(const RenderObject&) const;
381     bool isChecked(const RenderObject&) const;
382     bool isIndeterminate(const RenderObject&) const;
383     bool isEnabled(const RenderObject&) const;
384     bool isFocused(const RenderObject&) const;
385     bool isPressed(const RenderObject&) const;
386     bool isSpinUpButtonPartPressed(const RenderObject&) const;
387     bool isHovered(const RenderObject&) const;
388     bool isSpinUpButtonPartHovered(const RenderObject&) const;
389     bool isReadOnlyControl(const RenderObject&) const;
390     bool isDefault(const RenderObject&) const;
391
392 private:
393     mutable Color m_activeSelectionBackgroundColor;
394     mutable Color m_inactiveSelectionBackgroundColor;
395     mutable Color m_activeSelectionForegroundColor;
396     mutable Color m_inactiveSelectionForegroundColor;
397
398     mutable Color m_activeListBoxSelectionBackgroundColor;
399     mutable Color m_inactiveListBoxSelectionBackgroundColor;
400     mutable Color m_activeListBoxSelectionForegroundColor;
401     mutable Color m_inactiveListBoxSelectionForegroundColor;
402 };
403
404 } // namespace WebCore