[iOS] Upstream WebCore/rendering changes
[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 Icon;
43 class PopupMenu;
44 class RenderMenuList;
45 #if ENABLE(METER_ELEMENT)
46 class RenderMeter;
47 #endif
48 #if ENABLE(PROGRESS_ELEMENT)
49 class RenderProgress;
50 #endif
51 class RenderSnapshottedPlugIn;
52
53 class RenderTheme : public RefCounted<RenderTheme> {
54 protected:
55     RenderTheme();
56
57 public:
58     virtual ~RenderTheme() { }
59
60     // This function is to be implemented in your platform-specific theme implementation to hand back the
61     // appropriate platform theme. When the theme is needed in non-page dependent code, a default theme is
62     // used as fallback, which is returned for a nulled page, so the platform code needs to account for this.
63     static PassRefPtr<RenderTheme> themeForPage(Page* page);
64
65     // When the theme is needed in non-page dependent code, the defaultTheme() is used as fallback.
66     static inline PassRefPtr<RenderTheme> defaultTheme()
67     {
68         return themeForPage(0);
69     };
70
71     // This method is called whenever style has been computed for an element and the appearance
72     // property has been set to a value other than "none".  The theme should map in all of the appropriate
73     // metrics and defaults given the contents of the style.  This includes sophisticated operations like
74     // selection of control size based off the font, the disabling of appearance when certain other properties like
75     // "border" are set, or if the appearance is not supported by the theme.
76     void adjustStyle(StyleResolver*, RenderStyle*, Element*,  bool UAHasAppearance,
77                      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(RenderObject*, const PaintInfo&, const IntRect&);
83     bool paintBorderOnly(RenderObject*, const PaintInfo&, const IntRect&);
84     bool paintDecorations(RenderObject*, const PaintInfo&, const IntRect&);
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
103     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
104     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
105     // controls that need to do this.
106     virtual int baselinePosition(const RenderObject*) const;
107
108     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
109     // the baseline position API above).
110     bool isControlContainer(ControlPart) const;
111
112     // A method asking if the control changes its tint when the window has focus or not.
113     virtual bool controlSupportsTints(const RenderObject*) const { return false; }
114
115     // Whether or not the control has been styled enough by the author to disable the native appearance.
116     virtual bool isControlStyled(const RenderStyle*, const BorderData&, const FillLayer&, const Color& backgroundColor) const;
117
118     // A general method asking if any control tinting is supported at all.
119     virtual bool supportsControlTints() const { return false; }
120
121     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
122     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
123     virtual void adjustRepaintRect(const RenderObject*, IntRect&);
124
125     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
126     // or a control becomes disabled.
127     virtual bool stateChanged(RenderObject*, ControlState) const;
128
129     // This method is called whenever the theme changes on the system in order to flush cached resources from the
130     // old theme.
131     virtual void themeChanged() { }
132
133     // A method asking if the theme is able to draw the focus ring.
134     virtual bool supportsFocusRing(const RenderStyle*) const;
135
136     // A method asking if the theme's controls actually care about redrawing when hovered.
137     virtual bool supportsHover(const RenderStyle*) const { return false; }
138
139     // A method asking if the platform is able to show datalist suggestions for a given input type.
140     virtual bool supportsDataListUI(const AtomicString&) const { return false; }
141
142     // Text selection colors.
143     Color activeSelectionBackgroundColor() const;
144     Color inactiveSelectionBackgroundColor() const;
145     Color activeSelectionForegroundColor() const;
146     Color inactiveSelectionForegroundColor() const;
147
148     // List box selection colors
149     Color activeListBoxSelectionBackgroundColor() const;
150     Color activeListBoxSelectionForegroundColor() const;
151     Color inactiveListBoxSelectionBackgroundColor() const;
152     Color inactiveListBoxSelectionForegroundColor() const;
153
154     // Highlighting colors for TextMatches.
155     virtual Color platformActiveTextSearchHighlightColor() const;
156     virtual Color platformInactiveTextSearchHighlightColor() const;
157
158     virtual Color disabledTextColor(const Color& textColor, const Color& backgroundColor) const;
159
160     static Color focusRingColor();
161     virtual Color platformFocusRingColor() const { return Color(0, 0, 0); }
162     static void setCustomFocusRingColor(const Color&);
163 #if ENABLE(TOUCH_EVENTS)
164     static Color tapHighlightColor();
165     virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
166 #endif
167     virtual void platformColorsDidChange();
168
169     virtual double caretBlinkInterval() const { return 0.5; }
170
171     // System fonts and colors for CSS.
172     virtual void systemFont(CSSValueID, FontDescription&) const = 0;
173     virtual Color systemColor(CSSValueID) const;
174
175     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
176
177     virtual void adjustSliderThumbSize(RenderStyle*, Element*) const;
178
179     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
180     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
181     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
182     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
183     virtual bool popupOptionSupportsTextIndent() const { return false; }
184
185     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
186
187     // Method for painting the caps lock indicator
188     virtual bool paintCapsLockIndicator(RenderObject*, const PaintInfo&, const IntRect&) { return 0; };
189
190 #if ENABLE(PROGRESS_ELEMENT)
191     // Returns the repeat interval of the animation for the progress bar.
192     virtual double animationRepeatIntervalForProgressBar(RenderProgress*) const;
193     // Returns the duration of the animation for the progress bar.
194     virtual double animationDurationForProgressBar(RenderProgress*) const;
195     virtual IntRect progressBarRectForBounds(const RenderObject*, const IntRect&) const;
196 #endif
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(RenderObject*, const PaintInfo&, const IntRect&);
229 #endif
230
231     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
232     virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
233
234     // Functions for <select> elements.
235     virtual bool delegatesMenuListRendering() const { return false; }
236     virtual bool popsMenuByArrowKeys() const { return false; }
237     virtual bool popsMenuBySpaceOrReturn() const { return false; }
238
239     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
240     virtual String fileListNameForWidth(const FileList*, const Font&, int width, bool multipleFilesAllowed) const;
241
242 protected:
243     // The platform selection color.
244     virtual Color platformActiveSelectionBackgroundColor() const;
245     virtual Color platformInactiveSelectionBackgroundColor() const;
246     virtual Color platformActiveSelectionForegroundColor() const;
247     virtual Color platformInactiveSelectionForegroundColor() const;
248
249     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
250     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
251     virtual Color platformActiveListBoxSelectionForegroundColor() const;
252     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
253
254     virtual bool supportsSelectionForegroundColors() const { return true; }
255     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
256
257 #if !USE(NEW_THEME)
258     // Methods for each appearance value.
259     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
260     virtual bool paintCheckbox(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
261     virtual void setCheckboxSize(RenderStyle*) const { }
262
263     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
264     virtual bool paintRadio(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
265     virtual void setRadioSize(RenderStyle*) const { }
266
267     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
268     virtual bool paintButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
269     virtual void setButtonSize(RenderStyle*) const { }
270
271     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
272     virtual bool paintInnerSpinButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
273 #endif
274
275     virtual bool paintCheckboxDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
276     virtual bool paintRadioDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
277     virtual bool paintButtonDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
278
279     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
280     virtual bool paintTextField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
281     virtual bool paintTextFieldDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
282
283     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
284     virtual bool paintTextArea(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
285     virtual bool paintTextAreaDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
286
287     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
288     virtual bool paintMenuList(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
289     virtual bool paintMenuListDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
290
291     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
292     virtual bool paintMenuListButtonDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
293
294     virtual bool paintPushButtonDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
295     virtual bool paintSquareButtonDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
296
297     enum FileUploadDecorations { SingleFile, MultipleFiles };
298     virtual bool paintFileUploadIconDecorations(RenderObject* /*inputRenderer*/, RenderObject* /*buttonRenderer*/, const PaintInfo&, const IntRect&, Icon*, FileUploadDecorations) { return true; }
299     
300 #if ENABLE(METER_ELEMENT)
301     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
302     virtual bool paintMeter(RenderObject*, const PaintInfo&, const IntRect&);
303 #endif
304
305 #if ENABLE(PROGRESS_ELEMENT)
306     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
307     virtual bool paintProgressBar(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
308 #endif
309
310 #if ENABLE(INPUT_SPEECH)
311     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
312     virtual bool paintInputFieldSpeechButton(RenderObject*, const PaintInfo&, const IntRect&);
313 #endif
314
315     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
316     virtual bool paintSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
317
318     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
319     virtual bool paintSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
320     virtual bool paintSliderThumbDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
321
322     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
323     virtual bool paintSearchField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
324     virtual bool paintSearchFieldDecorations(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
325
326     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
327     virtual bool paintSearchFieldCancelButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
328
329     virtual void adjustSearchFieldDecorationPartStyle(StyleResolver*, RenderStyle*, Element*) const;
330     virtual bool paintSearchFieldDecorationPart(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
331
332     virtual void adjustSearchFieldResultsDecorationPartStyle(StyleResolver*, RenderStyle*, Element*) const;
333     virtual bool paintSearchFieldResultsDecorationPart(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
334
335     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
336     virtual bool paintSearchFieldResultsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
337
338     virtual void adjustMediaControlStyle(StyleResolver*, RenderStyle*, Element*) const;
339     virtual bool paintMediaFullscreenButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
340     virtual bool paintMediaPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
341     virtual bool paintMediaOverlayPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
342     virtual bool paintMediaMuteButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
343     virtual bool paintMediaSeekBackButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
344     virtual bool paintMediaSeekForwardButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
345     virtual bool paintMediaSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
346     virtual bool paintMediaSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
347     virtual bool paintMediaVolumeSliderContainer(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
348     virtual bool paintMediaVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
349     virtual bool paintMediaVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
350     virtual bool paintMediaRewindButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
351     virtual bool paintMediaReturnToRealtimeButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
352     virtual bool paintMediaToggleClosedCaptionsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
353     virtual bool paintMediaControlsBackground(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
354     virtual bool paintMediaCurrentTime(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
355     virtual bool paintMediaTimeRemaining(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
356     virtual bool paintMediaFullScreenVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
357     virtual bool paintMediaFullScreenVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
358
359     virtual bool paintSnapshottedPluginOverlay(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
360
361 public:
362     // Methods for state querying
363     ControlStates controlStatesForRenderer(const RenderObject* o) const;
364     bool isActive(const RenderObject*) const;
365     bool isChecked(const RenderObject*) const;
366     bool isIndeterminate(const RenderObject*) const;
367     bool isEnabled(const RenderObject*) const;
368     bool isFocused(const RenderObject*) const;
369     bool isPressed(const RenderObject*) const;
370     bool isSpinUpButtonPartPressed(const RenderObject*) const;
371     bool isHovered(const RenderObject*) const;
372     bool isSpinUpButtonPartHovered(const RenderObject*) const;
373     bool isReadOnlyControl(const RenderObject*) const;
374     bool isDefault(const RenderObject*) const;
375
376 private:
377     mutable Color m_activeSelectionBackgroundColor;
378     mutable Color m_inactiveSelectionBackgroundColor;
379     mutable Color m_activeSelectionForegroundColor;
380     mutable Color m_inactiveSelectionForegroundColor;
381
382     mutable Color m_activeListBoxSelectionBackgroundColor;
383     mutable Color m_inactiveListBoxSelectionBackgroundColor;
384     mutable Color m_activeListBoxSelectionForegroundColor;
385     mutable Color m_inactiveListBoxSelectionForegroundColor;
386
387 #if ENABLE(TOUCH_EVENTS)
388     // This color is expected to be drawn on a semi-transparent overlay,
389     // making it more transparent than its alpha value indicates.
390     static const RGBA32 defaultTapHighlightColor = 0x66000000;
391 #endif
392
393 #if USE(NEW_THEME)
394     Theme* m_theme; // The platform-specific theme.
395 #endif
396 };
397
398 } // namespace WebCore
399
400 #endif // RenderTheme_h