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