Clean up the inheritance tree under the MediaControls Class.
[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, or mediaControls.css
90     virtual String extraDefaultStyleSheet() { return String(); }
91     virtual String extraQuirksStyleSheet() { return String(); }
92 #if ENABLE(VIDEO)
93     virtual String extraMediaControlsStyleSheet() { return String(); };
94 #endif
95 #if ENABLE(FULLSCREEN_API)
96     virtual String extraFullScreenStyleSheet() { return String(); };
97 #endif
98 #if ENABLE(CALENDAR_PICKER)
99     virtual CString extraCalendarPickerStyleSheet();
100 #endif
101
102     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
103     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
104     // controls that need to do this.
105     virtual int baselinePosition(const RenderObject*) const;
106
107     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
108     // the baseline position API above).
109     bool isControlContainer(ControlPart) const;
110
111     // A method asking if the control changes its tint when the window has focus or not.
112     virtual bool controlSupportsTints(const RenderObject*) const { return false; }
113
114     // Whether or not the control has been styled enough by the author to disable the native appearance.
115     virtual bool isControlStyled(const RenderStyle*, const BorderData&, const FillLayer&, const Color& backgroundColor) const;
116
117     // A general method asking if any control tinting is supported at all.
118     virtual bool supportsControlTints() const { return false; }
119
120     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
121     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
122     virtual void adjustRepaintRect(const RenderObject*, IntRect&);
123
124     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
125     // or a control becomes disabled.
126     virtual bool stateChanged(RenderObject*, ControlState) const;
127
128     // This method is called whenever the theme changes on the system in order to flush cached resources from the
129     // old theme.
130     virtual void themeChanged() { }
131
132     // A method asking if the theme is able to draw the focus ring.
133     virtual bool supportsFocusRing(const RenderStyle*) const;
134
135     // A method asking if the theme's controls actually care about redrawing when hovered.
136     virtual bool supportsHover(const RenderStyle*) const { return false; }
137
138     // A method asking if the platform is able to show datalist suggestions for a given input type.
139     virtual bool supportsDataListUI(const AtomicString&) const { return false; }
140
141 #if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
142     // A method asking if the platform is able to show a calendar picker for a given input type.
143     virtual bool supportsCalendarPicker(const AtomicString&) const { return false; }
144 #endif
145
146     // Text selection colors.
147     Color activeSelectionBackgroundColor() const;
148     Color inactiveSelectionBackgroundColor() const;
149     Color activeSelectionForegroundColor() const;
150     Color inactiveSelectionForegroundColor() const;
151
152     // List box selection colors
153     Color activeListBoxSelectionBackgroundColor() const;
154     Color activeListBoxSelectionForegroundColor() const;
155     Color inactiveListBoxSelectionBackgroundColor() const;
156     Color inactiveListBoxSelectionForegroundColor() const;
157
158     // Highlighting colors for TextMatches.
159     virtual Color platformActiveTextSearchHighlightColor() const;
160     virtual Color platformInactiveTextSearchHighlightColor() const;
161
162     virtual Color disabledTextColor(const Color& textColor, const Color& backgroundColor) const;
163
164     static Color focusRingColor();
165     virtual Color platformFocusRingColor() const { return Color(0, 0, 0); }
166     static void setCustomFocusRingColor(const Color&);
167 #if ENABLE(TOUCH_EVENTS)
168     static Color tapHighlightColor();
169     virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
170 #endif
171     virtual void platformColorsDidChange();
172
173     virtual double caretBlinkInterval() const { return 0.5; }
174
175     // System fonts and colors for CSS.
176     virtual void systemFont(int cssValueId, FontDescription&) const = 0;
177     virtual Color systemColor(int cssValueId) const;
178
179     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
180
181     virtual void adjustSliderThumbSize(RenderStyle*, Element*) const;
182
183     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
184     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
185     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
186     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
187     virtual bool popupOptionSupportsTextIndent() const { return false; }
188
189     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
190
191     // Method for painting the caps lock indicator
192     virtual bool paintCapsLockIndicator(RenderObject*, const PaintInfo&, const IntRect&) { return 0; };
193
194 #if ENABLE(PROGRESS_ELEMENT)
195     // Returns the repeat interval of the animation for the progress bar.
196     virtual double animationRepeatIntervalForProgressBar(RenderProgress*) const;
197     // Returns the duration of the animation for the progress bar.
198     virtual double animationDurationForProgressBar(RenderProgress*) const;
199 #endif
200
201 #if ENABLE(VIDEO)
202     // Media controls
203     virtual bool supportsClosedCaptioning() const { return false; }
204     virtual bool hasOwnDisabledStateHandlingFor(ControlPart) const { return false; }
205     virtual bool usesMediaControlStatusDisplay() { return false; }
206     virtual bool usesMediaControlVolumeSlider() const { return true; }
207     virtual bool usesVerticalVolumeSlider() const { return true; }
208     virtual double mediaControlsFadeInDuration() { return 0.1; }
209     virtual double mediaControlsFadeOutDuration() { return 0.3; }
210     virtual double timeWithoutMouseMovementBeforeHidingControls() { return 3.0; }
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 IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) 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(RenderObject*, const PaintInfo&, const IntRect&);
233 #endif
234
235     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
236     virtual bool shouldHaveSpinButton(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 Font&, int width, bool multipleFilesAllowed) const;
245
246     virtual void paintPlugInSnapshotOverlay(RenderSnapshottedPlugIn*, const PaintInfo&, const LayoutPoint&) const { }
247
248     virtual bool shouldOpenPickerWithF4Key() const;
249
250 protected:
251     // The platform selection color.
252     virtual Color platformActiveSelectionBackgroundColor() const;
253     virtual Color platformInactiveSelectionBackgroundColor() const;
254     virtual Color platformActiveSelectionForegroundColor() const;
255     virtual Color platformInactiveSelectionForegroundColor() const;
256
257     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
258     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
259     virtual Color platformActiveListBoxSelectionForegroundColor() const;
260     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
261
262     virtual bool supportsSelectionForegroundColors() const { return true; }
263     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
264
265 #if !USE(NEW_THEME)
266     // Methods for each appearance value.
267     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
268     virtual bool paintCheckbox(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
269     virtual void setCheckboxSize(RenderStyle*) const { }
270
271     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
272     virtual bool paintRadio(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
273     virtual void setRadioSize(RenderStyle*) const { }
274
275     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
276     virtual bool paintButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
277     virtual void setButtonSize(RenderStyle*) const { }
278
279     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
280     virtual bool paintInnerSpinButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
281 #endif
282
283     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
284     virtual bool paintTextField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
285
286     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
287     virtual bool paintTextArea(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
288
289     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
290     virtual bool paintMenuList(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
291
292     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
293     virtual bool paintMenuListButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
294
295 #if ENABLE(METER_ELEMENT)
296     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
297     virtual bool paintMeter(RenderObject*, const PaintInfo&, const IntRect&);
298 #endif
299
300 #if ENABLE(PROGRESS_ELEMENT)
301     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
302     virtual bool paintProgressBar(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
303 #endif
304
305 #if ENABLE(INPUT_SPEECH)
306     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
307     virtual bool paintInputFieldSpeechButton(RenderObject*, const PaintInfo&, const IntRect&);
308 #endif
309
310     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
311     virtual bool paintSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
312
313     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
314     virtual bool paintSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
315
316     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
317     virtual bool paintSearchField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
318
319     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
320     virtual bool paintSearchFieldCancelButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
321
322     virtual void adjustSearchFieldDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
323     virtual bool paintSearchFieldDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
324
325     virtual void adjustSearchFieldResultsDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
326     virtual bool paintSearchFieldResultsDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
327
328     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
329     virtual bool paintSearchFieldResultsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
330
331     virtual void adjustMediaControlStyle(StyleResolver*, RenderStyle*, Element*) const;
332     virtual bool paintMediaFullscreenButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
333     virtual bool paintMediaPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
334     virtual bool paintMediaOverlayPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
335     virtual bool paintMediaMuteButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
336     virtual bool paintMediaSeekBackButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
337     virtual bool paintMediaSeekForwardButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
338     virtual bool paintMediaSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
339     virtual bool paintMediaSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
340     virtual bool paintMediaVolumeSliderContainer(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
341     virtual bool paintMediaVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
342     virtual bool paintMediaVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
343     virtual bool paintMediaRewindButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
344     virtual bool paintMediaReturnToRealtimeButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
345     virtual bool paintMediaToggleClosedCaptionsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
346     virtual bool paintMediaControlsBackground(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
347     virtual bool paintMediaCurrentTime(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
348     virtual bool paintMediaTimeRemaining(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
349     virtual bool paintMediaFullScreenVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
350     virtual bool paintMediaFullScreenVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
351
352 public:
353     // Methods for state querying
354     ControlStates controlStatesForRenderer(const RenderObject* o) const;
355     bool isActive(const RenderObject*) const;
356     bool isChecked(const RenderObject*) const;
357     bool isIndeterminate(const RenderObject*) const;
358     bool isEnabled(const RenderObject*) const;
359     bool isFocused(const RenderObject*) const;
360     bool isPressed(const RenderObject*) const;
361     bool isSpinUpButtonPartPressed(const RenderObject*) const;
362     bool isHovered(const RenderObject*) const;
363     bool isSpinUpButtonPartHovered(const RenderObject*) const;
364     bool isReadOnlyControl(const RenderObject*) const;
365     bool isDefault(const RenderObject*) const;
366
367 private:
368     mutable Color m_activeSelectionBackgroundColor;
369     mutable Color m_inactiveSelectionBackgroundColor;
370     mutable Color m_activeSelectionForegroundColor;
371     mutable Color m_inactiveSelectionForegroundColor;
372
373     mutable Color m_activeListBoxSelectionBackgroundColor;
374     mutable Color m_inactiveListBoxSelectionBackgroundColor;
375     mutable Color m_activeListBoxSelectionForegroundColor;
376     mutable Color m_inactiveListBoxSelectionForegroundColor;
377
378 #if ENABLE(TOUCH_EVENTS)
379     // This color is expected to be drawn on a semi-transparent overlay,
380     // making it more transparent than its alpha value indicates.
381     static const RGBA32 defaultTapHighlightColor = 0x66000000;
382 #endif
383
384 #if USE(NEW_THEME)
385     Theme* m_theme; // The platform-specific theme.
386 #endif
387 };
388
389 } // namespace WebCore
390
391 #endif // RenderTheme_h