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