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