Add an appearance keyword for wireless playback / airplay icon
[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 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 #include "ControlStates.h"
27 #if USE(NEW_THEME)
28 #include "Theme.h"
29 #else
30 #include "ThemeTypes.h"
31 #endif
32 #include "PopupMenuStyle.h"
33 #include "RenderObject.h"
34 #include "ScrollTypes.h"
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37
38 namespace WebCore {
39
40 class CSSStyleSheet;
41 class Element;
42 class FileList;
43 class HTMLInputElement;
44 class Icon;
45 class PopupMenu;
46 class RenderAttachment;
47 class RenderMenuList;
48 #if ENABLE(METER_ELEMENT)
49 class RenderMeter;
50 #endif
51 class RenderProgress;
52 class RenderSnapshottedPlugIn;
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, const BorderData&, const FillLayer&, const Color& backgroundColor);
78
79     // This method is called to paint the widget as a background of the RenderObject.  A widget's foreground, e.g., the
80     // text of a button, is always rendered by the engine itself.  The boolean return value indicates
81     // whether the CSS border/background should also be painted.
82     bool paint(const RenderObject&, ControlStates*, const PaintInfo&, const LayoutRect&);
83     bool paintBorderOnly(const RenderObject&, const PaintInfo&, const LayoutRect&);
84     bool paintDecorations(const RenderObject&, const PaintInfo&, const LayoutRect&);
85
86     // The remaining methods should be implemented by the platform-specific portion of the theme, e.g.,
87     // RenderThemeMac.cpp for Mac OS X.
88
89     // These methods return the theme's extra style sheets rules, to let each platform
90     // adjust the default CSS rules in html.css, quirks.css, mediaControls.css, or plugIns.css
91     virtual String extraDefaultStyleSheet() { return String(); }
92     virtual String extraQuirksStyleSheet() { return String(); }
93     virtual String extraPlugInsStyleSheet() { return String(); }
94 #if ENABLE(VIDEO)
95     virtual String mediaControlsStyleSheet() { return String(); }
96     virtual String extraMediaControlsStyleSheet() { return String(); }
97     virtual String mediaControlsScript() { return String(); }
98 #endif
99 #if ENABLE(FULLSCREEN_API)
100     virtual String extraFullScreenStyleSheet() { return String(); }
101 #endif
102 #if ENABLE(SERVICE_CONTROLS)
103     virtual String imageControlsStyleSheet() const { return String(); }
104 #endif
105
106     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
107     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
108     // controls that need to do this.
109     virtual int baselinePosition(const RenderObject&) const;
110
111     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
112     // the baseline position API above).
113     bool isControlContainer(ControlPart) const;
114
115     // A method asking if the control changes its tint when the window has focus or not.
116     virtual bool controlSupportsTints(const RenderObject&) const { return false; }
117
118     // Whether or not the control has been styled enough by the author to disable the native appearance.
119     virtual bool isControlStyled(const RenderStyle&, const BorderData&, const FillLayer&, const Color& backgroundColor) const;
120
121     // A general method asking if any control tinting is supported at all.
122     virtual bool supportsControlTints() const { return false; }
123
124     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
125     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
126     virtual void adjustRepaintRect(const RenderObject&, FloatRect&);
127
128     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
129     // or a control becomes disabled.
130     virtual bool stateChanged(const RenderObject&, ControlStates::States) const;
131
132     // This method is called whenever the theme changes on the system in order to flush cached resources from the
133     // old theme.
134     virtual void themeChanged() { }
135
136     // A method asking if the theme is able to draw the focus ring.
137     virtual bool supportsFocusRing(const RenderStyle&) const;
138
139     // A method asking if the theme's controls actually care about redrawing when hovered.
140     virtual bool supportsHover(const RenderStyle&) const { return false; }
141
142     // A method asking if the platform is able to show datalist suggestions for a given input type.
143     virtual bool supportsDataListUI(const AtomicString&) const { return false; }
144
145     // Text selection colors.
146     Color activeSelectionBackgroundColor() const;
147     Color inactiveSelectionBackgroundColor() const;
148     Color activeSelectionForegroundColor() const;
149     Color inactiveSelectionForegroundColor() const;
150
151     // List box selection colors
152     Color activeListBoxSelectionBackgroundColor() const;
153     Color activeListBoxSelectionForegroundColor() const;
154     Color inactiveListBoxSelectionBackgroundColor() const;
155     Color inactiveListBoxSelectionForegroundColor() const;
156
157     // Highlighting colors for TextMatches.
158     virtual Color platformActiveTextSearchHighlightColor() const;
159     virtual Color platformInactiveTextSearchHighlightColor() const;
160
161     virtual Color disabledTextColor(const Color& textColor, const Color& backgroundColor) const;
162
163     static Color focusRingColor();
164     virtual Color platformFocusRingColor() const { return Color(0, 0, 0); }
165     static void setCustomFocusRingColor(const Color&);
166     virtual int platformFocusRingMaxWidth() const { return 3; }
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     void systemFont(CSSValueID, FontDescription&) const;
177     virtual Color systemColor(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     virtual PopupMenuStyle::PopupMenuSize popupMenuSize(const RenderStyle&, IntRect&) const { return PopupMenuStyle::PopupMenuSizeNormal; }
189
190     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
191
192     // Returns the repeat interval of the animation for the progress bar.
193     virtual double animationRepeatIntervalForProgressBar(RenderProgress&) const;
194     // Returns the duration of the animation for the progress bar.
195     virtual double animationDurationForProgressBar(RenderProgress&) const;
196     virtual IntRect progressBarRectForBounds(const RenderObject&, const IntRect&) const;
197
198 #if ENABLE(VIDEO)
199     // Media controls
200     virtual bool supportsClosedCaptioning() const { return false; }
201     virtual bool hasOwnDisabledStateHandlingFor(ControlPart) const { return false; }
202     virtual bool usesMediaControlStatusDisplay() { return false; }
203     virtual bool usesMediaControlVolumeSlider() const { return true; }
204     virtual bool usesVerticalVolumeSlider() const { return true; }
205     virtual double mediaControlsFadeInDuration() { return 0.1; }
206     virtual double mediaControlsFadeOutDuration() { return 0.3; }
207     virtual String formatMediaControlsTime(float time) const;
208     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
209     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
210     
211     // Returns the media volume slider container's offset from the mute button.
212     virtual IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) const;
213 #endif
214
215 #if ENABLE(METER_ELEMENT)
216     virtual IntSize meterSizeForBounds(const RenderMeter&, const IntRect&) const;
217     virtual bool supportsMeter(ControlPart) const;
218 #endif
219
220 #if ENABLE(DATALIST_ELEMENT)
221     // Returns the threshold distance for snapping to a slider tick mark.
222     virtual LayoutUnit sliderTickSnappingThreshold() const;
223     // Returns size of one slider tick mark for a horizontal track.
224     // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
225     virtual IntSize sliderTickSize() const = 0;
226     // Returns the distance of slider tick origin from the slider track center.
227     virtual int sliderTickOffsetFromTrackCenter() const = 0;
228     void paintSliderTicks(const RenderObject&, const PaintInfo&, const IntRect&);
229 #endif
230
231     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
232     virtual bool shouldHaveSpinButton(HTMLInputElement&) const;
233     virtual bool shouldHaveCapsLockIndicator(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 FontCascade&, int width, bool multipleFilesAllowed) const;
242
243     enum FileUploadDecorations { SingleFile, MultipleFiles };
244     virtual bool paintFileUploadIconDecorations(const RenderObject& /*inputRenderer*/, const RenderObject& /*buttonRenderer*/, const PaintInfo&, const IntRect&, Icon*, FileUploadDecorations) { return true; }
245
246 #if ENABLE(SERVICE_CONTROLS)
247     virtual IntSize imageControlsButtonSize(const RenderObject&) const { return IntSize(); }
248     virtual IntSize imageControlsButtonPositionOffset() const { return IntSize(); }
249 #endif
250
251     virtual bool defaultButtonHasAnimation() const { return false; }
252
253 #if ENABLE(ATTACHMENT_ELEMENT)
254     virtual LayoutSize attachmentIntrinsicSize(const RenderAttachment&) const { return LayoutSize(); }
255     virtual int attachmentBaseline(const RenderAttachment&) const { return -1; }
256 #endif
257
258 protected:
259     virtual FontDescription& cachedSystemFontDescription(CSSValueID systemFontID) const;
260     virtual void updateCachedSystemFontDescription(CSSValueID systemFontID, FontDescription&) const = 0;
261
262     // The platform selection color.
263     virtual Color platformActiveSelectionBackgroundColor() const;
264     virtual Color platformInactiveSelectionBackgroundColor() const;
265     virtual Color platformActiveSelectionForegroundColor() const;
266     virtual Color platformInactiveSelectionForegroundColor() const;
267
268     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
269     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
270     virtual Color platformActiveListBoxSelectionForegroundColor() const;
271     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
272
273     virtual bool supportsSelectionForegroundColors() const { return true; }
274     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
275
276 #if !USE(NEW_THEME)
277     // Methods for each appearance value.
278     virtual void adjustCheckboxStyle(StyleResolver&, RenderStyle&, Element*) const;
279     virtual bool paintCheckbox(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
280     virtual void setCheckboxSize(RenderStyle&) const { }
281
282     virtual void adjustRadioStyle(StyleResolver&, RenderStyle&, Element*) const;
283     virtual bool paintRadio(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
284     virtual void setRadioSize(RenderStyle&) const { }
285
286     virtual void adjustButtonStyle(StyleResolver&, RenderStyle&, Element*) const;
287     virtual bool paintButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
288     virtual void setButtonSize(RenderStyle&) const { }
289
290     virtual void adjustInnerSpinButtonStyle(StyleResolver&, RenderStyle&, Element*) const;
291     virtual bool paintInnerSpinButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
292 #endif
293
294     virtual bool paintCheckboxDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
295     virtual bool paintRadioDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
296     virtual bool paintButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
297
298     virtual void adjustTextFieldStyle(StyleResolver&, RenderStyle&, Element*) const;
299     virtual bool paintTextField(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
300     virtual bool paintTextFieldDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
301
302     virtual void adjustTextAreaStyle(StyleResolver&, RenderStyle&, Element*) const;
303     virtual bool paintTextArea(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
304     virtual bool paintTextAreaDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
305
306     virtual void adjustMenuListStyle(StyleResolver&, RenderStyle&, Element*) const;
307     virtual bool paintMenuList(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
308     virtual bool paintMenuListDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
309
310     virtual void adjustMenuListButtonStyle(StyleResolver&, RenderStyle&, Element*) const;
311     virtual bool paintMenuListButtonDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
312
313     virtual bool paintPushButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
314     virtual bool paintSquareButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
315
316 #if ENABLE(METER_ELEMENT)
317     virtual void adjustMeterStyle(StyleResolver&, RenderStyle&, Element*) const;
318     virtual bool paintMeter(const RenderObject&, const PaintInfo&, const IntRect&);
319 #endif
320
321     virtual void adjustCapsLockIndicatorStyle(StyleResolver&, RenderStyle&, Element*) const;
322     virtual bool paintCapsLockIndicator(const RenderObject&, const PaintInfo&, const IntRect&);
323
324 #if ENABLE(ATTACHMENT_ELEMENT)
325     virtual void adjustAttachmentStyle(StyleResolver&, RenderStyle&, Element*) const;
326     virtual bool paintAttachment(const RenderObject&, const PaintInfo&, const IntRect&);
327 #endif
328
329     virtual void adjustWirelessPlaybackIconStyle(StyleResolver&, RenderStyle&, Element*) const;
330     virtual bool paintWirelessPlaybackIcon(const RenderObject&, const PaintInfo&, const IntRect&);
331
332     virtual void adjustProgressBarStyle(StyleResolver&, RenderStyle&, Element*) const;
333     virtual bool paintProgressBar(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
334
335     virtual void adjustSliderTrackStyle(StyleResolver&, RenderStyle&, Element*) const;
336     virtual bool paintSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
337
338     virtual void adjustSliderThumbStyle(StyleResolver&, RenderStyle&, Element*) const;
339     virtual bool paintSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
340     virtual bool paintSliderThumbDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
341
342     virtual void adjustSearchFieldStyle(StyleResolver&, RenderStyle&, Element*) const;
343     virtual bool paintSearchField(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
344     virtual bool paintSearchFieldDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
345
346     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver&, RenderStyle&, Element*) const;
347     virtual bool paintSearchFieldCancelButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
348
349     virtual void adjustSearchFieldDecorationPartStyle(StyleResolver&, RenderStyle&, Element*) const;
350     virtual bool paintSearchFieldDecorationPart(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
351
352     virtual void adjustSearchFieldResultsDecorationPartStyle(StyleResolver&, RenderStyle&, Element*) const;
353     virtual bool paintSearchFieldResultsDecorationPart(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
354
355     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver&, RenderStyle&, Element*) const;
356     virtual bool paintSearchFieldResultsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
357
358     virtual void adjustMediaControlStyle(StyleResolver&, RenderStyle&, Element*) const;
359     virtual bool paintMediaFullscreenButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
360     virtual bool paintMediaPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
361     virtual bool paintMediaOverlayPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
362     virtual bool paintMediaMuteButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
363     virtual bool paintMediaSeekBackButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
364     virtual bool paintMediaSeekForwardButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
365     virtual bool paintMediaSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
366     virtual bool paintMediaSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
367     virtual bool paintMediaVolumeSliderContainer(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
368     virtual bool paintMediaVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
369     virtual bool paintMediaVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
370     virtual bool paintMediaRewindButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
371     virtual bool paintMediaReturnToRealtimeButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
372     virtual bool paintMediaToggleClosedCaptionsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
373     virtual bool paintMediaControlsBackground(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
374     virtual bool paintMediaCurrentTime(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
375     virtual bool paintMediaTimeRemaining(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
376     virtual bool paintMediaFullScreenVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
377     virtual bool paintMediaFullScreenVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
378
379     virtual bool paintSnapshottedPluginOverlay(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
380
381 #if ENABLE(SERVICE_CONTROLS)
382     virtual bool paintImageControlsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
383 #endif
384
385 public:
386     void updateControlStatesForRenderer(const RenderObject&, ControlStates*) const;
387     ControlStates::States extractControlStatesForRenderer(const RenderObject&) const;
388     bool isActive(const RenderObject&) const;
389     bool isChecked(const RenderObject&) const;
390     bool isIndeterminate(const RenderObject&) const;
391     bool isEnabled(const RenderObject&) const;
392     bool isFocused(const RenderObject&) const;
393     bool isPressed(const RenderObject&) const;
394     bool isSpinUpButtonPartPressed(const RenderObject&) const;
395     bool isHovered(const RenderObject&) const;
396     bool isSpinUpButtonPartHovered(const RenderObject&) const;
397     bool isReadOnlyControl(const RenderObject&) const;
398     bool isDefault(const RenderObject&) const;
399
400 private:
401     mutable Color m_activeSelectionBackgroundColor;
402     mutable Color m_inactiveSelectionBackgroundColor;
403     mutable Color m_activeSelectionForegroundColor;
404     mutable Color m_inactiveSelectionForegroundColor;
405
406     mutable Color m_activeListBoxSelectionBackgroundColor;
407     mutable Color m_inactiveListBoxSelectionBackgroundColor;
408     mutable Color m_activeListBoxSelectionForegroundColor;
409     mutable Color m_inactiveListBoxSelectionForegroundColor;
410
411 #if ENABLE(TOUCH_EVENTS)
412     // This color is expected to be drawn on a semi-transparent overlay,
413     // making it more transparent than its alpha value indicates.
414     static const RGBA32 defaultTapHighlightColor = 0x66000000;
415 #endif
416
417 #if USE(NEW_THEME)
418     Theme* m_theme; // The platform-specific theme.
419 #endif
420 };
421
422 } // namespace WebCore
423
424 #endif // RenderTheme_h