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