7030b5553607050689f880da3626733c14587762
[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 Element;
39 class FileList;
40 class HTMLInputElement;
41 class PopupMenu;
42 class RenderMenuList;
43 #if ENABLE(METER_TAG)
44 class RenderMeter;
45 #endif
46 #if ENABLE(PROGRESS_TAG)
47 class RenderProgress;
48 #endif
49 class CSSStyleSheet;
50
51 class RenderTheme : public RefCounted<RenderTheme> {
52 protected:
53     RenderTheme();
54
55 public:
56     virtual ~RenderTheme() { }
57
58     // This function is to be implemented in your platform-specific theme implementation to hand back the
59     // appropriate platform theme. When the theme is needed in non-page dependent code, a default theme is
60     // used as fallback, which is returned for a nulled page, so the platform code needs to account for this.
61     static PassRefPtr<RenderTheme> themeForPage(Page* page);
62
63     // When the theme is needed in non-page dependent code, the defaultTheme() is used as fallback.
64     static inline PassRefPtr<RenderTheme> defaultTheme()
65     {
66         return themeForPage(0);
67     };
68
69     // This method is called whenever style has been computed for an element and the appearance
70     // property has been set to a value other than "none".  The theme should map in all of the appropriate
71     // metrics and defaults given the contents of the style.  This includes sophisticated operations like
72     // selection of control size based off the font, the disabling of appearance when certain other properties like
73     // "border" are set, or if the appearance is not supported by the theme.
74     void adjustStyle(StyleResolver*, RenderStyle*, Element*,  bool UAHasAppearance,
75                      const BorderData&, const FillLayer&, const Color& backgroundColor);
76
77     // This method is called to paint the widget as a background of the RenderObject.  A widget's foreground, e.g., the
78     // text of a button, is always rendered by the engine itself.  The boolean return value indicates
79     // whether the CSS border/background should also be painted.
80     bool paint(RenderObject*, const PaintInfo&, const IntRect&);
81     bool paintBorderOnly(RenderObject*, const PaintInfo&, const IntRect&);
82     bool paintDecorations(RenderObject*, const PaintInfo&, const IntRect&);
83
84     // The remaining methods should be implemented by the platform-specific portion of the theme, e.g.,
85     // RenderThemeMac.cpp for Mac OS X.
86
87     // These methods return the theme's extra style sheets rules, to let each platform
88     // adjust the default CSS rules in html.css, quirks.css, or mediaControls.css
89     virtual String extraDefaultStyleSheet() { return String(); }
90     virtual String extraQuirksStyleSheet() { return String(); }
91 #if ENABLE(VIDEO)
92     virtual String extraMediaControlsStyleSheet() { return String(); };
93 #endif
94 #if ENABLE(FULLSCREEN_API)
95     virtual String extraFullScreenStyleSheet() { return String(); };
96 #endif
97
98     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
99     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
100     // controls that need to do this.
101     virtual LayoutUnit baselinePosition(const RenderObject*) const;
102
103     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
104     // the baseline position API above).
105     bool isControlContainer(ControlPart) const;
106
107     // A method asking if the control changes its tint when the window has focus or not.
108     virtual bool controlSupportsTints(const RenderObject*) const { return false; }
109
110     // Whether or not the control has been styled enough by the author to disable the native appearance.
111     virtual bool isControlStyled(const RenderStyle*, const BorderData&, const FillLayer&, const Color& backgroundColor) const;
112
113     // A general method asking if any control tinting is supported at all.
114     virtual bool supportsControlTints() const { return false; }
115
116     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
117     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
118     virtual void adjustRepaintRect(const RenderObject*, IntRect&);
119
120     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
121     // or a control becomes disabled.
122     virtual bool stateChanged(RenderObject*, ControlState) const;
123
124     // This method is called whenever the theme changes on the system in order to flush cached resources from the
125     // old theme.
126     virtual void themeChanged() { }
127
128     // A method asking if the theme is able to draw the focus ring.
129     virtual bool supportsFocusRing(const RenderStyle*) const;
130
131     // A method asking if the theme's controls actually care about redrawing when hovered.
132     virtual bool supportsHover(const RenderStyle*) const { return false; }
133
134     // A method asking if the platform is able to show datalist suggestions for a given input type.
135     virtual bool supportsDataListUI(const AtomicString&) const { return false; }
136
137     // Text selection colors.
138     Color activeSelectionBackgroundColor() const;
139     Color inactiveSelectionBackgroundColor() const;
140     Color activeSelectionForegroundColor() const;
141     Color inactiveSelectionForegroundColor() const;
142
143     // List box selection colors
144     Color activeListBoxSelectionBackgroundColor() const;
145     Color activeListBoxSelectionForegroundColor() const;
146     Color inactiveListBoxSelectionBackgroundColor() const;
147     Color inactiveListBoxSelectionForegroundColor() const;
148
149     // Highlighting colors for TextMatches.
150     virtual Color platformActiveTextSearchHighlightColor() const;
151     virtual Color platformInactiveTextSearchHighlightColor() const;
152
153     virtual Color disabledTextColor(const Color& textColor, const Color& backgroundColor) const;
154
155     static Color focusRingColor();
156     virtual Color platformFocusRingColor() const { return Color(0, 0, 0); }
157     static void setCustomFocusRingColor(const Color&);
158 #if ENABLE(TOUCH_EVENTS)
159     static Color tapHighlightColor();
160     virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
161 #endif
162     virtual void platformColorsDidChange();
163
164     virtual double caretBlinkInterval() const { return 0.5; }
165
166     // System fonts and colors for CSS.
167     virtual void systemFont(int cssValueId, FontDescription&) const = 0;
168     virtual Color systemColor(int cssValueId) const;
169
170     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
171
172     virtual void adjustSliderThumbSize(RenderStyle*) const;
173
174     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
175     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
176     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
177     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
178     virtual bool popupOptionSupportsTextIndent() const { return false; }
179
180     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
181
182     // Method for painting the caps lock indicator
183     virtual bool paintCapsLockIndicator(RenderObject*, const PaintInfo&, const IntRect&) { return 0; };
184
185 #if ENABLE(PROGRESS_TAG)
186     // Returns the repeat interval of the animation for the progress bar.
187     virtual double animationRepeatIntervalForProgressBar(RenderProgress*) const;
188     // Returns the duration of the animation for the progress bar.
189     virtual double animationDurationForProgressBar(RenderProgress*) const;
190 #endif
191
192 #if ENABLE(VIDEO)
193     // Media controls
194     virtual bool supportsClosedCaptioning() const { return false; }
195     virtual bool hasOwnDisabledStateHandlingFor(ControlPart) const { return false; }
196     virtual bool usesMediaControlStatusDisplay() { return false; }
197     virtual bool usesMediaControlVolumeSlider() const { return true; }
198     virtual double mediaControlsFadeInDuration() { return 0.1; }
199     virtual double mediaControlsFadeOutDuration() { return 0.3; }
200     virtual String formatMediaControlsTime(float time) const;
201     virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
202     virtual String formatMediaControlsRemainingTime(float currentTime, float duration) const;
203     
204     // Returns the media volume slider container's offset from the mute button.
205     virtual IntPoint volumeSliderOffsetFromMuteButton(RenderBox*, const IntSize&) const;
206 #endif
207
208 #if ENABLE(METER_TAG)
209     virtual IntSize meterSizeForBounds(const RenderMeter*, const IntRect&) const;
210     virtual bool supportsMeter(ControlPart) const;
211 #endif
212     
213     virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
214     virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
215
216     // Functions for <select> elements.
217     virtual bool delegatesMenuListRendering() const { return false; }
218     virtual bool popsMenuByArrowKeys() const { return false; }
219     virtual bool popsMenuBySpaceOrReturn() const { return false; }
220
221     virtual String fileListDefaultLabel(bool multipleFilesAllowed) const;
222     virtual String fileListNameForWidth(const FileList*, const Font&, int width, bool multipleFilesAllowed) const;
223
224 protected:
225     // The platform selection color.
226     virtual Color platformActiveSelectionBackgroundColor() const;
227     virtual Color platformInactiveSelectionBackgroundColor() const;
228     virtual Color platformActiveSelectionForegroundColor() const;
229     virtual Color platformInactiveSelectionForegroundColor() const;
230
231     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
232     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
233     virtual Color platformActiveListBoxSelectionForegroundColor() const;
234     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
235
236     virtual bool supportsSelectionForegroundColors() const { return true; }
237     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
238
239 #if !USE(NEW_THEME)
240     // Methods for each appearance value.
241     virtual void adjustCheckboxStyle(StyleResolver*, RenderStyle*, Element*) const;
242     virtual bool paintCheckbox(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
243     virtual void setCheckboxSize(RenderStyle*) const { }
244
245     virtual void adjustRadioStyle(StyleResolver*, RenderStyle*, Element*) const;
246     virtual bool paintRadio(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
247     virtual void setRadioSize(RenderStyle*) const { }
248
249     virtual void adjustButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
250     virtual bool paintButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
251     virtual void setButtonSize(RenderStyle*) const { }
252
253     virtual void adjustInnerSpinButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
254     virtual bool paintInnerSpinButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
255 #endif
256
257     virtual void adjustTextFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
258     virtual bool paintTextField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
259
260     virtual void adjustTextAreaStyle(StyleResolver*, RenderStyle*, Element*) const;
261     virtual bool paintTextArea(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
262
263     virtual void adjustMenuListStyle(StyleResolver*, RenderStyle*, Element*) const;
264     virtual bool paintMenuList(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
265
266     virtual void adjustMenuListButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
267     virtual bool paintMenuListButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
268
269 #if ENABLE(METER_TAG)
270     virtual void adjustMeterStyle(StyleResolver*, RenderStyle*, Element*) const;
271     virtual bool paintMeter(RenderObject*, const PaintInfo&, const IntRect&);
272 #endif
273
274 #if ENABLE(PROGRESS_TAG)
275     virtual void adjustProgressBarStyle(StyleResolver*, RenderStyle*, Element*) const;
276     virtual bool paintProgressBar(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
277 #endif
278
279 #if ENABLE(INPUT_SPEECH)
280     virtual void adjustInputFieldSpeechButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
281     virtual bool paintInputFieldSpeechButton(RenderObject*, const PaintInfo&, const IntRect&);
282 #endif
283
284     virtual void adjustSliderTrackStyle(StyleResolver*, RenderStyle*, Element*) const;
285     virtual bool paintSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
286
287     virtual void adjustSliderThumbStyle(StyleResolver*, RenderStyle*, Element*) const;
288     virtual bool paintSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
289
290     virtual void adjustSearchFieldStyle(StyleResolver*, RenderStyle*, Element*) const;
291     virtual bool paintSearchField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
292
293     virtual void adjustSearchFieldCancelButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
294     virtual bool paintSearchFieldCancelButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
295
296     virtual void adjustSearchFieldDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
297     virtual bool paintSearchFieldDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
298
299     virtual void adjustSearchFieldResultsDecorationStyle(StyleResolver*, RenderStyle*, Element*) const;
300     virtual bool paintSearchFieldResultsDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
301
302     virtual void adjustSearchFieldResultsButtonStyle(StyleResolver*, RenderStyle*, Element*) const;
303     virtual bool paintSearchFieldResultsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
304
305     virtual bool paintMediaFullscreenButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
306     virtual bool paintMediaPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
307     virtual bool paintMediaMuteButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
308     virtual bool paintMediaSeekBackButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
309     virtual bool paintMediaSeekForwardButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
310     virtual bool paintMediaSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
311     virtual bool paintMediaSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
312     virtual bool paintMediaVolumeSliderContainer(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
313     virtual bool paintMediaVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
314     virtual bool paintMediaVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
315     virtual bool paintMediaRewindButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
316     virtual bool paintMediaReturnToRealtimeButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
317     virtual bool paintMediaToggleClosedCaptionsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
318     virtual bool paintMediaControlsBackground(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
319     virtual bool paintMediaCurrentTime(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
320     virtual bool paintMediaTimeRemaining(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
321     virtual bool paintMediaFullScreenVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
322     virtual bool paintMediaFullScreenVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
323
324 public:
325     // Methods for state querying
326     ControlStates controlStatesForRenderer(const RenderObject* o) const;
327     bool isActive(const RenderObject*) const;
328     bool isChecked(const RenderObject*) const;
329     bool isIndeterminate(const RenderObject*) const;
330     bool isEnabled(const RenderObject*) const;
331     bool isFocused(const RenderObject*) const;
332     bool isPressed(const RenderObject*) const;
333     bool isSpinUpButtonPartPressed(const RenderObject*) const;
334     bool isHovered(const RenderObject*) const;
335     bool isSpinUpButtonPartHovered(const RenderObject*) const;
336     bool isReadOnlyControl(const RenderObject*) const;
337     bool isDefault(const RenderObject*) const;
338
339 private:
340     mutable Color m_activeSelectionBackgroundColor;
341     mutable Color m_inactiveSelectionBackgroundColor;
342     mutable Color m_activeSelectionForegroundColor;
343     mutable Color m_inactiveSelectionForegroundColor;
344
345     mutable Color m_activeListBoxSelectionBackgroundColor;
346     mutable Color m_inactiveListBoxSelectionBackgroundColor;
347     mutable Color m_activeListBoxSelectionForegroundColor;
348     mutable Color m_inactiveListBoxSelectionForegroundColor;
349
350 #if ENABLE(TOUCH_EVENTS)
351     static const RGBA32 defaultTapHighlightColor = 0x33000000;
352 #endif
353
354 #if USE(NEW_THEME)
355     Theme* m_theme; // The platform-specific theme.
356 #endif
357 };
358
359 } // namespace WebCore
360
361 #endif // RenderTheme_h