[mac] <progress> has rendering artifacts along the bottom
[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 Computer, 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 #if USE(NEW_THEME)
27 #include "Theme.h"
28 #else
29 #include "ThemeTypes.h"
30 #endif
31 #include "RenderObject.h"
32 #include "ScrollTypes.h"
33 #include <wtf/PassRefPtr.h>
34 #include <wtf/RefCounted.h>
35
36 namespace WebCore {
37
38 class CSSStyleSheet;
39 class Element;
40 class FileList;
41 class HTMLInputElement;
42 class PopupMenu;
43 class RenderMenuList;
44 #if ENABLE(METER_ELEMENT)
45 class RenderMeter;
46 #endif
47 #if ENABLE(PROGRESS_ELEMENT)
48 class RenderProgress;
49 #endif
50 class RenderSnapshottedPlugIn;
51
52 class RenderTheme : public RefCounted<RenderTheme> {
53 protected:
54     RenderTheme();
55
56 public:
57     virtual ~RenderTheme() { }
58
59     // This function is to be implemented in your platform-specific theme implementation to hand back the
60     // appropriate platform theme. When the theme is needed in non-page dependent code, a default theme is
61     // used as fallback, which is returned for a nulled page, so the platform code needs to account for this.
62     static PassRefPtr<RenderTheme> themeForPage(Page* page);
63
64     // When the theme is needed in non-page dependent code, the defaultTheme() is used as fallback.
65     static inline PassRefPtr<RenderTheme> defaultTheme()
66     {
67         return themeForPage(0);
68     };
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*, Element*,  bool UAHasAppearance,
76                      const BorderData&, const FillLayer&, const Color& backgroundColor);
77
78     // This method is called to paint the widget as a background of the RenderObject.  A widget's foreground, e.g., the
79     // text of a button, is always rendered by the engine itself.  The boolean return value indicates
80     // whether the CSS border/background should also be painted.
81     bool paint(RenderObject*, const PaintInfo&, const IntRect&);
82     bool paintBorderOnly(RenderObject*, const PaintInfo&, const IntRect&);
83     bool paintDecorations(RenderObject*, const PaintInfo&, const IntRect&);
84
85     // The remaining methods should be implemented by the platform-specific portion of the theme, e.g.,
86     // RenderThemeMac.cpp for Mac OS X.
87
88     // These methods return the theme's extra style sheets rules, to let each platform
89     // adjust the default CSS rules in html.css, quirks.css, mediaControls.css, or plugIns.css
90     virtual String extraDefaultStyleSheet() { return String(); }
91     virtual String extraQuirksStyleSheet() { return String(); }
92     virtual String extraPlugInsStyleSheet() { return String(); }
93 #if ENABLE(VIDEO)
94     virtual String extraMediaControlsStyleSheet() { return String(); }
95 #endif
96 #if ENABLE(FULLSCREEN_API)
97     virtual String extraFullScreenStyleSheet() { 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 RenderObject*) 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*, IntRect&);
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(RenderObject*, ControlState) 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 #if ENABLE(TOUCH_EVENTS)
161     static Color tapHighlightColor();
162     virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
163 #endif
164     virtual void platformColorsDidChange();
165
166     virtual double caretBlinkInterval() const { return 0.5; }
167
168     // System fonts and colors for CSS.
169     virtual void systemFont(CSSValueID, FontDescription&) const = 0;
170     virtual Color systemColor(CSSValueID) const;
171
172     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
173
174     virtual void adjustSliderThumbSize(RenderStyle*, Element*) const;
175
176     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
177     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
178     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
179     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
180     virtual bool popupOptionSupportsTextIndent() const { return false; }
181
182     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
183
184     // Method for painting the caps lock indicator
185     virtual bool paintCapsLockIndicator(RenderObject*, const PaintInfo&, const IntRect&) { return 0; };
186
187 #if ENABLE(PROGRESS_ELEMENT)
188     // Returns the repeat interval of the animation for the progress bar.
189     virtual double animationRepeatIntervalForProgressBar(RenderProgress*) const;
190     // Returns the duration of the animation for the progress bar.
191     virtual double animationDurationForProgressBar(RenderProgress*) const;
192     virtual IntRect progressBarRectForBounds(const RenderObject*, const IntRect&) const;
193 #endif
194
195 #if ENABLE(VIDEO)
196     // Media controls
197     virtual bool supportsClosedCaptioning() const { return false; }
198     virtual bool hasOwnDisabledStateHandlingFor(ControlPart) const { return false; }
199     virtual bool usesMediaControlStatusDisplay() { return false; }
200     virtual bool usesMediaControlVolumeSlider() const { return true; }
201     virtual bool usesVerticalVolumeSlider() const { return true; }
202     virtual double mediaControlsFadeInDuration() { return 0.1; }
203     virtual double mediaControlsFadeOutDuration() { return 0.3; }
204     virtual String formatMediaControlsTime(float time) const;
205     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
206     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
207     
208     // Returns the media volume slider container's offset from the mute button.
209     virtual IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) const;
210 #endif
211
212 #if ENABLE(METER_ELEMENT)
213     virtual IntSize meterSizeForBounds(const RenderMeter*, const IntRect&) const;
214     virtual bool supportsMeter(ControlPart) const;
215 #endif
216
217 #if ENABLE(DATALIST_ELEMENT)
218     // Returns the threshold distance for snapping to a slider tick mark.
219     virtual LayoutUnit sliderTickSnappingThreshold() const;
220     // Returns size of one slider tick mark for a horizontal track.
221     // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
222     virtual IntSize sliderTickSize() const = 0;
223     // Returns the distance of slider tick origin from the slider track center.
224     virtual int sliderTickOffsetFromTrackCenter() const = 0;
225     void paintSliderTicks(RenderObject*, const PaintInfo&, const IntRect&);
226 #endif
227
228     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
229     virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
230
231     // Functions for <select> elements.
232     virtual bool delegatesMenuListRendering() const { return false; }
233     virtual bool popsMenuByArrowKeys() const { return false; }
234     virtual bool popsMenuBySpaceOrReturn() const { return false; }
235
236     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
237     virtual String fileListNameForWidth(const FileList*, const Font&, int width, bool multipleFilesAllowed) const;
238
239     virtual bool shouldOpenPickerWithF4Key() const;
240
241 protected:
242     // The platform selection color.
243     virtual Color platformActiveSelectionBackgroundColor() const;
244     virtual Color platformInactiveSelectionBackgroundColor() const;
245     virtual Color platformActiveSelectionForegroundColor() const;
246     virtual Color platformInactiveSelectionForegroundColor() const;
247
248     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
249     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
250     virtual Color platformActiveListBoxSelectionForegroundColor() const;
251     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
252
253     virtual bool supportsSelectionForegroundColors() const { return true; }
254     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
255
256 #if !USE(NEW_THEME)
257     // Methods for each appearance value.
258     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
259     virtual bool paintCheckbox(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
260     virtual void setCheckboxSize(RenderStyle*) const { }
261
262     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
263     virtual bool paintRadio(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
264     virtual void setRadioSize(RenderStyle*) const { }
265
266     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
267     virtual bool paintButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
268     virtual void setButtonSize(RenderStyle*) const { }
269
270     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
271     virtual bool paintInnerSpinButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
272 #endif
273
274     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
275     virtual bool paintTextField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
276
277     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
278     virtual bool paintTextArea(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
279
280     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
281     virtual bool paintMenuList(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
282
283     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
284     virtual bool paintMenuListButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
285
286 #if ENABLE(METER_ELEMENT)
287     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
288     virtual bool paintMeter(RenderObject*, const PaintInfo&, const IntRect&);
289 #endif
290
291 #if ENABLE(PROGRESS_ELEMENT)
292     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
293     virtual bool paintProgressBar(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
294 #endif
295
296 #if ENABLE(INPUT_SPEECH)
297     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
298     virtual bool paintInputFieldSpeechButton(RenderObject*, const PaintInfo&, const IntRect&);
299 #endif
300
301     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
302     virtual bool paintSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
303
304     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
305     virtual bool paintSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
306
307     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
308     virtual bool paintSearchField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
309
310     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
311     virtual bool paintSearchFieldCancelButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
312
313     virtual void adjustSearchFieldDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
314     virtual bool paintSearchFieldDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
315
316     virtual void adjustSearchFieldResultsDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
317     virtual bool paintSearchFieldResultsDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
318
319     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
320     virtual bool paintSearchFieldResultsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
321
322     virtual void adjustMediaControlStyle(StyleResolver*, RenderStyle*, Element*) const;
323     virtual bool paintMediaFullscreenButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
324     virtual bool paintMediaPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
325     virtual bool paintMediaOverlayPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
326     virtual bool paintMediaMuteButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
327     virtual bool paintMediaSeekBackButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
328     virtual bool paintMediaSeekForwardButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
329     virtual bool paintMediaSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
330     virtual bool paintMediaSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
331     virtual bool paintMediaVolumeSliderContainer(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
332     virtual bool paintMediaVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
333     virtual bool paintMediaVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
334     virtual bool paintMediaRewindButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
335     virtual bool paintMediaReturnToRealtimeButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
336     virtual bool paintMediaToggleClosedCaptionsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
337     virtual bool paintMediaControlsBackground(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
338     virtual bool paintMediaCurrentTime(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
339     virtual bool paintMediaTimeRemaining(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
340     virtual bool paintMediaFullScreenVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
341     virtual bool paintMediaFullScreenVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
342
343     virtual bool paintSnapshottedPluginOverlay(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
344
345 public:
346     // Methods for state querying
347     ControlStates controlStatesForRenderer(const RenderObject* o) const;
348     bool isActive(const RenderObject*) const;
349     bool isChecked(const RenderObject*) const;
350     bool isIndeterminate(const RenderObject*) const;
351     bool isEnabled(const RenderObject*) const;
352     bool isFocused(const RenderObject*) const;
353     bool isPressed(const RenderObject*) const;
354     bool isSpinUpButtonPartPressed(const RenderObject*) const;
355     bool isHovered(const RenderObject*) const;
356     bool isSpinUpButtonPartHovered(const RenderObject*) const;
357     bool isReadOnlyControl(const RenderObject*) const;
358     bool isDefault(const RenderObject*) const;
359
360 private:
361     mutable Color m_activeSelectionBackgroundColor;
362     mutable Color m_inactiveSelectionBackgroundColor;
363     mutable Color m_activeSelectionForegroundColor;
364     mutable Color m_inactiveSelectionForegroundColor;
365
366     mutable Color m_activeListBoxSelectionBackgroundColor;
367     mutable Color m_inactiveListBoxSelectionBackgroundColor;
368     mutable Color m_activeListBoxSelectionForegroundColor;
369     mutable Color m_inactiveListBoxSelectionForegroundColor;
370
371 #if ENABLE(TOUCH_EVENTS)
372     // This color is expected to be drawn on a semi-transparent overlay,
373     // making it more transparent than its alpha value indicates.
374     static const RGBA32 defaultTapHighlightColor = 0x66000000;
375 #endif
376
377 #if USE(NEW_THEME)
378     Theme* m_theme; // The platform-specific theme.
379 #endif
380 };
381
382 } // namespace WebCore
383
384 #endif // RenderTheme_h