REGRESSION(r142191): Fix closed caption buttons for ports still using the painting...
[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 #if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
140     // A method asking if the platform is able to show a calendar picker for a given input type.
141     virtual bool supportsCalendarPicker(const AtomicString&) const { return false; }
142 #endif
143
144     // Text selection colors.
145     Color activeSelectionBackgroundColor() const;
146     Color inactiveSelectionBackgroundColor() const;
147     Color activeSelectionForegroundColor() const;
148     Color inactiveSelectionForegroundColor() const;
149
150     // List box selection colors
151     Color activeListBoxSelectionBackgroundColor() const;
152     Color activeListBoxSelectionForegroundColor() const;
153     Color inactiveListBoxSelectionBackgroundColor() const;
154     Color inactiveListBoxSelectionForegroundColor() const;
155
156     // Highlighting colors for TextMatches.
157     virtual Color platformActiveTextSearchHighlightColor() const;
158     virtual Color platformInactiveTextSearchHighlightColor() const;
159
160     virtual Color disabledTextColor(const Color& textColor, const Color& backgroundColor) const;
161
162     static Color focusRingColor();
163     virtual Color platformFocusRingColor() const { return Color(0, 0, 0); }
164     static void setCustomFocusRingColor(const Color&);
165 #if ENABLE(TOUCH_EVENTS)
166     static Color tapHighlightColor();
167     virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
168 #endif
169     virtual void platformColorsDidChange();
170
171     virtual double caretBlinkInterval() const { return 0.5; }
172
173     // System fonts and colors for CSS.
174     virtual void systemFont(int cssValueId, FontDescription&) const = 0;
175     virtual Color systemColor(int cssValueId) const;
176
177     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
178
179     virtual void adjustSliderThumbSize(RenderStyle*, Element*) const;
180
181     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
182     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
183     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
184     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
185     virtual bool popupOptionSupportsTextIndent() const { return false; }
186
187     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
188
189     // Method for painting the caps lock indicator
190     virtual bool paintCapsLockIndicator(RenderObject*, const PaintInfo&, const IntRect&) { return 0; };
191
192 #if ENABLE(PROGRESS_ELEMENT)
193     // Returns the repeat interval of the animation for the progress bar.
194     virtual double animationRepeatIntervalForProgressBar(RenderProgress*) const;
195     // Returns the duration of the animation for the progress bar.
196     virtual double animationDurationForProgressBar(RenderProgress*) const;
197 #endif
198
199 #if ENABLE(VIDEO)
200     // Media controls
201     virtual bool supportsClosedCaptioning() const { return false; }
202     virtual bool hasOwnDisabledStateHandlingFor(ControlPart) const { return false; }
203     virtual bool usesMediaControlStatusDisplay() { return false; }
204     virtual bool usesMediaControlVolumeSlider() const { return true; }
205     virtual bool usesVerticalVolumeSlider() const { return true; }
206     virtual double mediaControlsFadeInDuration() { return 0.1; }
207     virtual double mediaControlsFadeOutDuration() { return 0.3; }
208     virtual double timeWithoutMouseMovementBeforeHidingControls() { return 3.0; }
209     virtual String formatMediaControlsTime(float time) const;
210     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
211     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
212     
213     // Returns the media volume slider container's offset from the mute button.
214     virtual IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) const;
215 #endif
216
217 #if ENABLE(METER_ELEMENT)
218     virtual IntSize meterSizeForBounds(const RenderMeter*, const IntRect&) const;
219     virtual bool supportsMeter(ControlPart) const;
220 #endif
221
222 #if ENABLE(DATALIST_ELEMENT)
223     // Returns the threshold distance for snapping to a slider tick mark.
224     virtual LayoutUnit sliderTickSnappingThreshold() const;
225     // Returns size of one slider tick mark for a horizontal track.
226     // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
227     virtual IntSize sliderTickSize() const = 0;
228     // Returns the distance of slider tick origin from the slider track center.
229     virtual int sliderTickOffsetFromTrackCenter() const = 0;
230     void paintSliderTicks(RenderObject*, const PaintInfo&, const IntRect&);
231 #endif
232
233     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
234     virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
235
236     // Functions for <select> elements.
237     virtual bool delegatesMenuListRendering() const { return false; }
238     virtual bool popsMenuByArrowKeys() const { return false; }
239     virtual bool popsMenuBySpaceOrReturn() const { return false; }
240
241     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
242     virtual String fileListNameForWidth(const FileList*, const Font&, int width, bool multipleFilesAllowed) const;
243
244     virtual bool shouldOpenPickerWithF4Key() const;
245
246 protected:
247     // The platform selection color.
248     virtual Color platformActiveSelectionBackgroundColor() const;
249     virtual Color platformInactiveSelectionBackgroundColor() const;
250     virtual Color platformActiveSelectionForegroundColor() const;
251     virtual Color platformInactiveSelectionForegroundColor() const;
252
253     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
254     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
255     virtual Color platformActiveListBoxSelectionForegroundColor() const;
256     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
257
258     virtual bool supportsSelectionForegroundColors() const { return true; }
259     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
260
261 #if !USE(NEW_THEME)
262     // Methods for each appearance value.
263     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
264     virtual bool paintCheckbox(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
265     virtual void setCheckboxSize(RenderStyle*) const { }
266
267     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
268     virtual bool paintRadio(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
269     virtual void setRadioSize(RenderStyle*) const { }
270
271     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
272     virtual bool paintButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
273     virtual void setButtonSize(RenderStyle*) const { }
274
275     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
276     virtual bool paintInnerSpinButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
277 #endif
278
279     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
280     virtual bool paintTextField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
281
282     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
283     virtual bool paintTextArea(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
284
285     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
286     virtual bool paintMenuList(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
287
288     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
289     virtual bool paintMenuListButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
290
291 #if ENABLE(METER_ELEMENT)
292     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
293     virtual bool paintMeter(RenderObject*, const PaintInfo&, const IntRect&);
294 #endif
295
296 #if ENABLE(PROGRESS_ELEMENT)
297     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
298     virtual bool paintProgressBar(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
299 #endif
300
301 #if ENABLE(INPUT_SPEECH)
302     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
303     virtual bool paintInputFieldSpeechButton(RenderObject*, const PaintInfo&, const IntRect&);
304 #endif
305
306     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
307     virtual bool paintSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
308
309     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
310     virtual bool paintSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
311
312     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
313     virtual bool paintSearchField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
314
315     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
316     virtual bool paintSearchFieldCancelButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
317
318     virtual void adjustSearchFieldDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
319     virtual bool paintSearchFieldDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
320
321     virtual void adjustSearchFieldResultsDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
322     virtual bool paintSearchFieldResultsDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
323
324     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
325     virtual bool paintSearchFieldResultsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
326
327     virtual void adjustMediaControlStyle(StyleResolver*, RenderStyle*, Element*) const;
328     virtual bool paintMediaFullscreenButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
329     virtual bool paintMediaPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
330     virtual bool paintMediaOverlayPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
331     virtual bool paintMediaMuteButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
332     virtual bool paintMediaSeekBackButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
333     virtual bool paintMediaSeekForwardButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
334     virtual bool paintMediaSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
335     virtual bool paintMediaSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
336     virtual bool paintMediaVolumeSliderContainer(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
337     virtual bool paintMediaVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
338     virtual bool paintMediaVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
339     virtual bool paintMediaRewindButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
340     virtual bool paintMediaReturnToRealtimeButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
341     virtual bool paintMediaToggleClosedCaptionsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
342     virtual bool paintMediaControlsBackground(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
343     virtual bool paintMediaCurrentTime(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
344     virtual bool paintMediaTimeRemaining(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
345     virtual bool paintMediaFullScreenVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
346     virtual bool paintMediaFullScreenVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
347
348 public:
349     // Methods for state querying
350     ControlStates controlStatesForRenderer(const RenderObject* o) const;
351     bool isActive(const RenderObject*) const;
352     bool isChecked(const RenderObject*) const;
353     bool isIndeterminate(const RenderObject*) const;
354     bool isEnabled(const RenderObject*) const;
355     bool isFocused(const RenderObject*) const;
356     bool isPressed(const RenderObject*) const;
357     bool isSpinUpButtonPartPressed(const RenderObject*) const;
358     bool isHovered(const RenderObject*) const;
359     bool isSpinUpButtonPartHovered(const RenderObject*) const;
360     bool isReadOnlyControl(const RenderObject*) const;
361     bool isDefault(const RenderObject*) const;
362
363 private:
364     mutable Color m_activeSelectionBackgroundColor;
365     mutable Color m_inactiveSelectionBackgroundColor;
366     mutable Color m_activeSelectionForegroundColor;
367     mutable Color m_inactiveSelectionForegroundColor;
368
369     mutable Color m_activeListBoxSelectionBackgroundColor;
370     mutable Color m_inactiveListBoxSelectionBackgroundColor;
371     mutable Color m_activeListBoxSelectionForegroundColor;
372     mutable Color m_inactiveListBoxSelectionForegroundColor;
373
374 #if ENABLE(TOUCH_EVENTS)
375     // This color is expected to be drawn on a semi-transparent overlay,
376     // making it more transparent than its alpha value indicates.
377     static const RGBA32 defaultTapHighlightColor = 0x66000000;
378 #endif
379
380 #if USE(NEW_THEME)
381     Theme* m_theme; // The platform-specific theme.
382 #endif
383 };
384
385 } // namespace WebCore
386
387 #endif // RenderTheme_h