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