Default mouse cursor behavior should be auto-hide for full screen video with custom...
[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 String formatMediaControlsTime(float time) const;
209     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
210     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
211     
212     // Returns the media volume slider container's offset from the mute button.
213     virtual IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) const;
214 #endif
215
216 #if ENABLE(METER_ELEMENT)
217     virtual IntSize meterSizeForBounds(const RenderMeter*, const IntRect&) const;
218     virtual bool supportsMeter(ControlPart) const;
219 #endif
220
221 #if ENABLE(DATALIST_ELEMENT)
222     // Returns the threshold distance for snapping to a slider tick mark.
223     virtual LayoutUnit sliderTickSnappingThreshold() const;
224     // Returns size of one slider tick mark for a horizontal track.
225     // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
226     virtual IntSize sliderTickSize() const = 0;
227     // Returns the distance of slider tick origin from the slider track center.
228     virtual int sliderTickOffsetFromTrackCenter() const = 0;
229     void paintSliderTicks(RenderObject*, const PaintInfo&, const IntRect&);
230 #endif
231
232     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
233     virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
234
235     // Functions for <select> elements.
236     virtual bool delegatesMenuListRendering() const { return false; }
237     virtual bool popsMenuByArrowKeys() const { return false; }
238     virtual bool popsMenuBySpaceOrReturn() const { return false; }
239
240     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
241     virtual String fileListNameForWidth(const FileList*, const Font&, int width, bool multipleFilesAllowed) const;
242
243     virtual bool shouldOpenPickerWithF4Key() const;
244
245 protected:
246     // The platform selection color.
247     virtual Color platformActiveSelectionBackgroundColor() const;
248     virtual Color platformInactiveSelectionBackgroundColor() const;
249     virtual Color platformActiveSelectionForegroundColor() const;
250     virtual Color platformInactiveSelectionForegroundColor() const;
251
252     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
253     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
254     virtual Color platformActiveListBoxSelectionForegroundColor() const;
255     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
256
257     virtual bool supportsSelectionForegroundColors() const { return true; }
258     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
259
260 #if !USE(NEW_THEME)
261     // Methods for each appearance value.
262     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
263     virtual bool paintCheckbox(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
264     virtual void setCheckboxSize(RenderStyle*) const { }
265
266     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
267     virtual bool paintRadio(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
268     virtual void setRadioSize(RenderStyle*) const { }
269
270     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
271     virtual bool paintButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
272     virtual void setButtonSize(RenderStyle*) const { }
273
274     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
275     virtual bool paintInnerSpinButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
276 #endif
277
278     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
279     virtual bool paintTextField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
280
281     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
282     virtual bool paintTextArea(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
283
284     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
285     virtual bool paintMenuList(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
286
287     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
288     virtual bool paintMenuListButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
289
290 #if ENABLE(METER_ELEMENT)
291     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
292     virtual bool paintMeter(RenderObject*, const PaintInfo&, const IntRect&);
293 #endif
294
295 #if ENABLE(PROGRESS_ELEMENT)
296     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
297     virtual bool paintProgressBar(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
298 #endif
299
300 #if ENABLE(INPUT_SPEECH)
301     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
302     virtual bool paintInputFieldSpeechButton(RenderObject*, const PaintInfo&, const IntRect&);
303 #endif
304
305     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
306     virtual bool paintSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
307
308     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
309     virtual bool paintSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
310
311     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
312     virtual bool paintSearchField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
313
314     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
315     virtual bool paintSearchFieldCancelButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
316
317     virtual void adjustSearchFieldDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
318     virtual bool paintSearchFieldDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
319
320     virtual void adjustSearchFieldResultsDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
321     virtual bool paintSearchFieldResultsDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
322
323     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
324     virtual bool paintSearchFieldResultsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
325
326     virtual void adjustMediaControlStyle(StyleResolver*, RenderStyle*, Element*) const;
327     virtual bool paintMediaFullscreenButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
328     virtual bool paintMediaPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
329     virtual bool paintMediaOverlayPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
330     virtual bool paintMediaMuteButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
331     virtual bool paintMediaSeekBackButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
332     virtual bool paintMediaSeekForwardButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
333     virtual bool paintMediaSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
334     virtual bool paintMediaSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
335     virtual bool paintMediaVolumeSliderContainer(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
336     virtual bool paintMediaVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
337     virtual bool paintMediaVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
338     virtual bool paintMediaRewindButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
339     virtual bool paintMediaReturnToRealtimeButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
340     virtual bool paintMediaToggleClosedCaptionsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
341     virtual bool paintMediaControlsBackground(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
342     virtual bool paintMediaCurrentTime(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
343     virtual bool paintMediaTimeRemaining(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
344     virtual bool paintMediaFullScreenVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
345     virtual bool paintMediaFullScreenVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
346
347 public:
348     // Methods for state querying
349     ControlStates controlStatesForRenderer(const RenderObject* o) const;
350     bool isActive(const RenderObject*) const;
351     bool isChecked(const RenderObject*) const;
352     bool isIndeterminate(const RenderObject*) const;
353     bool isEnabled(const RenderObject*) const;
354     bool isFocused(const RenderObject*) const;
355     bool isPressed(const RenderObject*) const;
356     bool isSpinUpButtonPartPressed(const RenderObject*) const;
357     bool isHovered(const RenderObject*) const;
358     bool isSpinUpButtonPartHovered(const RenderObject*) const;
359     bool isReadOnlyControl(const RenderObject*) const;
360     bool isDefault(const RenderObject*) const;
361
362 private:
363     mutable Color m_activeSelectionBackgroundColor;
364     mutable Color m_inactiveSelectionBackgroundColor;
365     mutable Color m_activeSelectionForegroundColor;
366     mutable Color m_inactiveSelectionForegroundColor;
367
368     mutable Color m_activeListBoxSelectionBackgroundColor;
369     mutable Color m_inactiveListBoxSelectionBackgroundColor;
370     mutable Color m_activeListBoxSelectionForegroundColor;
371     mutable Color m_inactiveListBoxSelectionForegroundColor;
372
373 #if ENABLE(TOUCH_EVENTS)
374     // This color is expected to be drawn on a semi-transparent overlay,
375     // making it more transparent than its alpha value indicates.
376     static const RGBA32 defaultTapHighlightColor = 0x66000000;
377 #endif
378
379 #if USE(NEW_THEME)
380     Theme* m_theme; // The platform-specific theme.
381 #endif
382 };
383
384 } // namespace WebCore
385
386 #endif // RenderTheme_h