[Mac] Allow focus rings to redraw themselves if necessary
[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 RenderMenuList;
47 #if ENABLE(METER_ELEMENT)
48 class RenderMeter;
49 #endif
50 #if ENABLE(PROGRESS_ELEMENT)
51 class RenderProgress;
52 #endif
53 class RenderSnapshottedPlugIn;
54
55 class RenderTheme : public RefCounted<RenderTheme> {
56 protected:
57     RenderTheme();
58
59 public:
60     virtual ~RenderTheme() { }
61
62     // This function is to be implemented in your platform-specific theme implementation to hand back the
63     // appropriate platform theme. When the theme is needed in non-page dependent code, a default theme is
64     // used as fallback, which is returned for a nulled page, so the platform code needs to account for this.
65     static PassRefPtr<RenderTheme> themeForPage(Page* page);
66
67     // When the theme is needed in non-page dependent code, the defaultTheme() is used as fallback.
68     static inline PassRefPtr<RenderTheme> defaultTheme()
69     {
70         return themeForPage(0);
71     };
72
73     // This method is called whenever style has been computed for an element and the appearance
74     // property has been set to a value other than "none".  The theme should map in all of the appropriate
75     // metrics and defaults given the contents of the style.  This includes sophisticated operations like
76     // selection of control size based off the font, the disabling of appearance when certain other properties like
77     // "border" are set, or if the appearance is not supported by the theme.
78     void adjustStyle(StyleResolver&, RenderStyle&, Element*,  bool UAHasAppearance, 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(const RenderObject&, ControlStates*, const PaintInfo&, const LayoutRect&);
84     bool paintBorderOnly(const RenderObject&, const PaintInfo&, const LayoutRect&);
85     bool paintDecorations(const RenderObject&, const PaintInfo&, const LayoutRect&);
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, mediaControls.css, or plugIns.css
92     virtual String extraDefaultStyleSheet() { return String(); }
93     virtual String extraQuirksStyleSheet() { return String(); }
94     virtual String extraPlugInsStyleSheet() { return String(); }
95 #if ENABLE(VIDEO)
96     virtual String mediaControlsStyleSheet() { return String(); }
97     virtual String extraMediaControlsStyleSheet() { return String(); }
98     virtual String mediaControlsScript() { return String(); }
99 #endif
100 #if ENABLE(FULLSCREEN_API)
101     virtual String extraFullScreenStyleSheet() { return String(); }
102 #endif
103 #if ENABLE(SERVICE_CONTROLS)
104     virtual String imageControlsStyleSheet() const { return String(); }
105 #endif
106
107     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
108     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
109     // controls that need to do this.
110     virtual int baselinePosition(const RenderObject&) const;
111
112     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
113     // the baseline position API above).
114     bool isControlContainer(ControlPart) const;
115
116     // A method asking if the control changes its tint when the window has focus or not.
117     virtual bool controlSupportsTints(const RenderObject&) const { return false; }
118
119     // Whether or not the control has been styled enough by the author to disable the native appearance.
120     virtual bool isControlStyled(const RenderStyle*, const BorderData&, const FillLayer&, const Color& backgroundColor) const;
121
122     // A general method asking if any control tinting is supported at all.
123     virtual bool supportsControlTints() const { return false; }
124
125     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
126     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
127     virtual void adjustRepaintRect(const RenderObject&, IntRect&);
128
129     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
130     // or a control becomes disabled.
131     virtual bool stateChanged(const RenderObject&, ControlStates::States) const;
132
133     // This method is called whenever the theme changes on the system in order to flush cached resources from the
134     // old theme.
135     virtual void themeChanged() { }
136
137     // A method asking if the theme is able to draw the focus ring.
138     virtual bool supportsFocusRing(const RenderStyle*) const;
139
140     // A method asking if the theme's controls actually care about redrawing when hovered.
141     virtual bool supportsHover(const RenderStyle*) const { return false; }
142
143     // A method asking if the platform is able to show datalist suggestions for a given input type.
144     virtual bool supportsDataListUI(const AtomicString&) const { return false; }
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     virtual int platformFocusRingMaxWidth() const { return 3; }
168 #if ENABLE(TOUCH_EVENTS)
169     static Color tapHighlightColor();
170     virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
171 #endif
172     virtual void platformColorsDidChange();
173
174     virtual double caretBlinkInterval() const { return 0.5; }
175
176     // System fonts and colors for CSS.
177     virtual void systemFont(CSSValueID, FontDescription&) const = 0;
178     virtual Color systemColor(CSSValueID) const;
179
180     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
181
182     virtual void adjustSliderThumbSize(RenderStyle*, Element*) const;
183
184     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
185     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
186     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
187     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
188     virtual bool popupOptionSupportsTextIndent() const { return false; }
189     virtual PopupMenuStyle::PopupMenuSize popupMenuSize(const RenderStyle*, IntRect&) const { return PopupMenuStyle::PopupMenuSizeNormal; }
190
191     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
192
193     // Method for painting the caps lock indicator
194     virtual bool paintCapsLockIndicator(const 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     virtual IntRect progressBarRectForBounds(const RenderObject&, const IntRect&) const;
202 #endif
203
204 #if ENABLE(VIDEO)
205     // Media controls
206     virtual bool supportsClosedCaptioning() const { return false; }
207     virtual bool hasOwnDisabledStateHandlingFor(ControlPart) const { return false; }
208     virtual bool usesMediaControlStatusDisplay() { return false; }
209     virtual bool usesMediaControlVolumeSlider() const { return true; }
210     virtual bool usesVerticalVolumeSlider() const { return true; }
211     virtual double mediaControlsFadeInDuration() { return 0.1; }
212     virtual double mediaControlsFadeOutDuration() { return 0.3; }
213     virtual String formatMediaControlsTime(float time) const;
214     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
215     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
216     
217     // Returns the media volume slider container's offset from the mute button.
218     virtual IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) const;
219 #endif
220
221 #if ENABLE(METER_ELEMENT)
222     virtual IntSize meterSizeForBounds(const RenderMeter*, const IntRect&) const;
223     virtual bool supportsMeter(ControlPart) const;
224 #endif
225
226 #if ENABLE(DATALIST_ELEMENT)
227     // Returns the threshold distance for snapping to a slider tick mark.
228     virtual LayoutUnit sliderTickSnappingThreshold() const;
229     // Returns size of one slider tick mark for a horizontal track.
230     // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
231     virtual IntSize sliderTickSize() const = 0;
232     // Returns the distance of slider tick origin from the slider track center.
233     virtual int sliderTickOffsetFromTrackCenter() const = 0;
234     void paintSliderTicks(const RenderObject&, const PaintInfo&, const IntRect&);
235 #endif
236
237     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
238     virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
239
240     // Functions for <select> elements.
241     virtual bool delegatesMenuListRendering() const { return false; }
242     virtual bool popsMenuByArrowKeys() const { return false; }
243     virtual bool popsMenuBySpaceOrReturn() const { return false; }
244
245     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
246     virtual String fileListNameForWidth(const FileList*, const Font&, int width, bool multipleFilesAllowed) const;
247
248     enum FileUploadDecorations { SingleFile, MultipleFiles };
249     virtual bool paintFileUploadIconDecorations(const RenderObject& /*inputRenderer*/, const RenderObject& /*buttonRenderer*/, const PaintInfo&, const IntRect&, Icon*, FileUploadDecorations) { return true; }
250
251 #if ENABLE(SERVICE_CONTROLS)
252     virtual IntSize imageControlsButtonSize(const RenderObject&) const { return IntSize(); }
253 #endif
254
255 protected:
256     // The platform selection color.
257     virtual Color platformActiveSelectionBackgroundColor() const;
258     virtual Color platformInactiveSelectionBackgroundColor() const;
259     virtual Color platformActiveSelectionForegroundColor() const;
260     virtual Color platformInactiveSelectionForegroundColor() const;
261
262     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
263     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
264     virtual Color platformActiveListBoxSelectionForegroundColor() const;
265     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
266
267     virtual bool supportsSelectionForegroundColors() const { return true; }
268     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
269
270 #if !USE(NEW_THEME)
271     // Methods for each appearance value.
272     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
273     virtual bool paintCheckbox(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
274     virtual void setCheckboxSize(RenderStyle*) const { }
275
276     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
277     virtual bool paintRadio(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
278     virtual void setRadioSize(RenderStyle*) const { }
279
280     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
281     virtual bool paintButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
282     virtual void setButtonSize(RenderStyle*) const { }
283
284     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
285     virtual bool paintInnerSpinButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
286 #endif
287
288     virtual bool paintCheckboxDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
289     virtual bool paintRadioDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
290     virtual bool paintButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
291
292     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
293     virtual bool paintTextField(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
294     virtual bool paintTextFieldDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
295
296     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
297     virtual bool paintTextArea(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
298     virtual bool paintTextAreaDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
299
300     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
301     virtual bool paintMenuList(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
302     virtual bool paintMenuListDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
303
304     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
305     virtual bool paintMenuListButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
306
307     virtual bool paintPushButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
308     virtual bool paintSquareButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
309
310 #if ENABLE(METER_ELEMENT)
311     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
312     virtual bool paintMeter(const RenderObject&, const PaintInfo&, const IntRect&);
313 #endif
314
315 #if ENABLE(PROGRESS_ELEMENT)
316     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
317     virtual bool paintProgressBar(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
318 #endif
319
320 #if ENABLE(INPUT_SPEECH)
321     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
322     virtual bool paintInputFieldSpeechButton(const RenderObject&, const PaintInfo&, const IntRect&);
323 #endif
324
325     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
326     virtual bool paintSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
327
328     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
329     virtual bool paintSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
330     virtual bool paintSliderThumbDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
331
332     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
333     virtual bool paintSearchField(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
334     virtual bool paintSearchFieldDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
335
336     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
337     virtual bool paintSearchFieldCancelButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
338
339     virtual void adjustSearchFieldDecorationPartStyle(StyleResolver*, RenderStyle*, Element*) const;
340     virtual bool paintSearchFieldDecorationPart(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
341
342     virtual void adjustSearchFieldResultsDecorationPartStyle(StyleResolver*, RenderStyle*, Element*) const;
343     virtual bool paintSearchFieldResultsDecorationPart(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
344
345     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
346     virtual bool paintSearchFieldResultsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
347
348     virtual void adjustMediaControlStyle(StyleResolver*, RenderStyle*, Element*) const;
349     virtual bool paintMediaFullscreenButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
350     virtual bool paintMediaPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
351     virtual bool paintMediaOverlayPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
352     virtual bool paintMediaMuteButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
353     virtual bool paintMediaSeekBackButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
354     virtual bool paintMediaSeekForwardButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
355     virtual bool paintMediaSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
356     virtual bool paintMediaSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
357     virtual bool paintMediaVolumeSliderContainer(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
358     virtual bool paintMediaVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
359     virtual bool paintMediaVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
360     virtual bool paintMediaRewindButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
361     virtual bool paintMediaReturnToRealtimeButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
362     virtual bool paintMediaToggleClosedCaptionsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
363     virtual bool paintMediaControlsBackground(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
364     virtual bool paintMediaCurrentTime(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
365     virtual bool paintMediaTimeRemaining(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
366     virtual bool paintMediaFullScreenVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
367     virtual bool paintMediaFullScreenVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
368
369     virtual bool paintSnapshottedPluginOverlay(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
370
371 #if ENABLE(SERVICE_CONTROLS)
372     virtual bool paintImageControlsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
373 #endif
374
375 public:
376     void updateControlStatesForRenderer(const RenderObject&, ControlStates*) const;
377     ControlStates::States extractControlStatesForRenderer(const RenderObject&) const;
378     bool isActive(const RenderObject&) const;
379     bool isChecked(const RenderObject&) const;
380     bool isIndeterminate(const RenderObject&) const;
381     bool isEnabled(const RenderObject&) const;
382     bool isFocused(const RenderObject&) const;
383     bool isPressed(const RenderObject&) const;
384     bool isSpinUpButtonPartPressed(const RenderObject&) const;
385     bool isHovered(const RenderObject&) const;
386     bool isSpinUpButtonPartHovered(const RenderObject&) const;
387     bool isReadOnlyControl(const RenderObject&) const;
388     bool isDefault(const RenderObject&) const;
389
390 private:
391     mutable Color m_activeSelectionBackgroundColor;
392     mutable Color m_inactiveSelectionBackgroundColor;
393     mutable Color m_activeSelectionForegroundColor;
394     mutable Color m_inactiveSelectionForegroundColor;
395
396     mutable Color m_activeListBoxSelectionBackgroundColor;
397     mutable Color m_inactiveListBoxSelectionBackgroundColor;
398     mutable Color m_activeListBoxSelectionForegroundColor;
399     mutable Color m_inactiveListBoxSelectionForegroundColor;
400
401 #if ENABLE(TOUCH_EVENTS)
402     // This color is expected to be drawn on a semi-transparent overlay,
403     // making it more transparent than its alpha value indicates.
404     static const RGBA32 defaultTapHighlightColor = 0x66000000;
405 #endif
406
407 #if USE(NEW_THEME)
408     Theme* m_theme; // The platform-specific theme.
409 #endif
410 };
411
412 } // namespace WebCore
413
414 #endif // RenderTheme_h