Subpixel rendering: Clipping on text areas when shifted by one device pixel.
[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 "RenderObject.h"
33 #include "ScrollTypes.h"
34 #include <wtf/PassRefPtr.h>
35 #include <wtf/RefCounted.h>
36
37 namespace WebCore {
38
39 class CSSStyleSheet;
40 class Element;
41 class FileList;
42 class HTMLInputElement;
43 class Icon;
44 class PopupMenu;
45 class RenderMenuList;
46 #if ENABLE(METER_ELEMENT)
47 class RenderMeter;
48 #endif
49 #if ENABLE(PROGRESS_ELEMENT)
50 class RenderProgress;
51 #endif
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(IMAGE_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&, IntRect&);
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 #if ENABLE(TOUCH_EVENTS)
167     static Color tapHighlightColor();
168     virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
169 #endif
170     virtual void platformColorsDidChange();
171
172     virtual double caretBlinkInterval() const { return 0.5; }
173
174     // System fonts and colors for CSS.
175     virtual void systemFont(CSSValueID, FontDescription&) const = 0;
176     virtual Color systemColor(CSSValueID) const;
177
178     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
179
180     virtual void adjustSliderThumbSize(RenderStyle*, Element*) const;
181
182     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
183     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
184     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
185     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
186     virtual bool popupOptionSupportsTextIndent() const { return false; }
187
188     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
189
190     // Method for painting the caps lock indicator
191     virtual bool paintCapsLockIndicator(const RenderObject&, const PaintInfo&, const IntRect&) { return 0; };
192
193 #if ENABLE(PROGRESS_ELEMENT)
194     // Returns the repeat interval of the animation for the progress bar.
195     virtual double animationRepeatIntervalForProgressBar(RenderProgress*) const;
196     // Returns the duration of the animation for the progress bar.
197     virtual double animationDurationForProgressBar(RenderProgress*) const;
198     virtual IntRect progressBarRectForBounds(const RenderObject&, const IntRect&) 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 String formatMediaControlsTime(float time) const;
211     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
212     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
213     
214     // Returns the media volume slider container's offset from the mute button.
215     virtual IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) const;
216 #endif
217
218 #if ENABLE(METER_ELEMENT)
219     virtual IntSize meterSizeForBounds(const RenderMeter*, const IntRect&) const;
220     virtual bool supportsMeter(ControlPart) const;
221 #endif
222
223 #if ENABLE(DATALIST_ELEMENT)
224     // Returns the threshold distance for snapping to a slider tick mark.
225     virtual LayoutUnit sliderTickSnappingThreshold() const;
226     // Returns size of one slider tick mark for a horizontal track.
227     // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
228     virtual IntSize sliderTickSize() const = 0;
229     // Returns the distance of slider tick origin from the slider track center.
230     virtual int sliderTickOffsetFromTrackCenter() const = 0;
231     void paintSliderTicks(const RenderObject&, const PaintInfo&, const IntRect&);
232 #endif
233
234     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
235     virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
236
237     // Functions for <select> elements.
238     virtual bool delegatesMenuListRendering() const { return false; }
239     virtual bool popsMenuByArrowKeys() const { return false; }
240     virtual bool popsMenuBySpaceOrReturn() const { return false; }
241
242     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
243     virtual String fileListNameForWidth(const FileList*, const Font&, int width, bool multipleFilesAllowed) const;
244
245     enum FileUploadDecorations { SingleFile, MultipleFiles };
246     virtual bool paintFileUploadIconDecorations(const RenderObject& /*inputRenderer*/, const RenderObject& /*buttonRenderer*/, const PaintInfo&, const IntRect&, Icon*, FileUploadDecorations) { return true; }
247
248 #if ENABLE(IMAGE_CONTROLS)
249     virtual IntSize imageControlsButtonSize(const RenderObject&) const { return IntSize(); }
250 #endif
251
252 protected:
253     // The platform selection color.
254     virtual Color platformActiveSelectionBackgroundColor() const;
255     virtual Color platformInactiveSelectionBackgroundColor() const;
256     virtual Color platformActiveSelectionForegroundColor() const;
257     virtual Color platformInactiveSelectionForegroundColor() const;
258
259     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
260     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
261     virtual Color platformActiveListBoxSelectionForegroundColor() const;
262     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
263
264     virtual bool supportsSelectionForegroundColors() const { return true; }
265     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
266
267 #if !USE(NEW_THEME)
268     // Methods for each appearance value.
269     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
270     virtual bool paintCheckbox(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
271     virtual void setCheckboxSize(RenderStyle*) const { }
272
273     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
274     virtual bool paintRadio(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
275     virtual void setRadioSize(RenderStyle*) const { }
276
277     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
278     virtual bool paintButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
279     virtual void setButtonSize(RenderStyle*) const { }
280
281     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
282     virtual bool paintInnerSpinButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
283 #endif
284
285     virtual bool paintCheckboxDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
286     virtual bool paintRadioDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
287     virtual bool paintButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
288
289     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
290     virtual bool paintTextField(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
291     virtual bool paintTextFieldDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
292
293     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
294     virtual bool paintTextArea(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
295     virtual bool paintTextAreaDecorations(const RenderObject&, const PaintInfo&, const FloatRect&) { return true; }
296
297     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
298     virtual bool paintMenuList(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
299     virtual bool paintMenuListDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
300
301     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
302     virtual bool paintMenuListButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
303
304     virtual bool paintPushButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
305     virtual bool paintSquareButtonDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
306
307 #if ENABLE(METER_ELEMENT)
308     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
309     virtual bool paintMeter(const RenderObject&, const PaintInfo&, const IntRect&);
310 #endif
311
312 #if ENABLE(PROGRESS_ELEMENT)
313     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
314     virtual bool paintProgressBar(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
315 #endif
316
317 #if ENABLE(INPUT_SPEECH)
318     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
319     virtual bool paintInputFieldSpeechButton(const RenderObject&, const PaintInfo&, const IntRect&);
320 #endif
321
322     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
323     virtual bool paintSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
324
325     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
326     virtual bool paintSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
327     virtual bool paintSliderThumbDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
328
329     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
330     virtual bool paintSearchField(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
331     virtual bool paintSearchFieldDecorations(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
332
333     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
334     virtual bool paintSearchFieldCancelButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
335
336     virtual void adjustSearchFieldDecorationPartStyle(StyleResolver*, RenderStyle*, Element*) const;
337     virtual bool paintSearchFieldDecorationPart(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
338
339     virtual void adjustSearchFieldResultsDecorationPartStyle(StyleResolver*, RenderStyle*, Element*) const;
340     virtual bool paintSearchFieldResultsDecorationPart(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
341
342     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
343     virtual bool paintSearchFieldResultsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
344
345     virtual void adjustMediaControlStyle(StyleResolver*, RenderStyle*, Element*) const;
346     virtual bool paintMediaFullscreenButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
347     virtual bool paintMediaPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
348     virtual bool paintMediaOverlayPlayButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
349     virtual bool paintMediaMuteButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
350     virtual bool paintMediaSeekBackButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
351     virtual bool paintMediaSeekForwardButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
352     virtual bool paintMediaSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
353     virtual bool paintMediaSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
354     virtual bool paintMediaVolumeSliderContainer(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
355     virtual bool paintMediaVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
356     virtual bool paintMediaVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
357     virtual bool paintMediaRewindButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
358     virtual bool paintMediaReturnToRealtimeButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
359     virtual bool paintMediaToggleClosedCaptionsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
360     virtual bool paintMediaControlsBackground(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
361     virtual bool paintMediaCurrentTime(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
362     virtual bool paintMediaTimeRemaining(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
363     virtual bool paintMediaFullScreenVolumeSliderTrack(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
364     virtual bool paintMediaFullScreenVolumeSliderThumb(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
365
366     virtual bool paintSnapshottedPluginOverlay(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
367
368 #if ENABLE(IMAGE_CONTROLS)
369     virtual bool paintImageControlsButton(const RenderObject&, const PaintInfo&, const IntRect&) { return true; }
370 #endif
371
372 public:
373     void updateControlStatesForRenderer(const RenderObject&, ControlStates*) const;
374     ControlStates::States extractControlStatesForRenderer(const RenderObject&) const;
375     bool isActive(const RenderObject&) const;
376     bool isChecked(const RenderObject&) const;
377     bool isIndeterminate(const RenderObject&) const;
378     bool isEnabled(const RenderObject&) const;
379     bool isFocused(const RenderObject&) const;
380     bool isPressed(const RenderObject&) const;
381     bool isSpinUpButtonPartPressed(const RenderObject&) const;
382     bool isHovered(const RenderObject&) const;
383     bool isSpinUpButtonPartHovered(const RenderObject&) const;
384     bool isReadOnlyControl(const RenderObject&) const;
385     bool isDefault(const RenderObject&) const;
386
387 private:
388     mutable Color m_activeSelectionBackgroundColor;
389     mutable Color m_inactiveSelectionBackgroundColor;
390     mutable Color m_activeSelectionForegroundColor;
391     mutable Color m_inactiveSelectionForegroundColor;
392
393     mutable Color m_activeListBoxSelectionBackgroundColor;
394     mutable Color m_inactiveListBoxSelectionBackgroundColor;
395     mutable Color m_activeListBoxSelectionForegroundColor;
396     mutable Color m_inactiveListBoxSelectionForegroundColor;
397
398 #if ENABLE(TOUCH_EVENTS)
399     // This color is expected to be drawn on a semi-transparent overlay,
400     // making it more transparent than its alpha value indicates.
401     static const RGBA32 defaultTapHighlightColor = 0x66000000;
402 #endif
403
404 #if USE(NEW_THEME)
405     Theme* m_theme; // The platform-specific theme.
406 #endif
407 };
408
409 } // namespace WebCore
410
411 #endif // RenderTheme_h