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