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 "platform/Theme.h"
28#else
29#include "platform/ThemeTypes.h"
30#endif
31#include "core/rendering/RenderObject.h"
32#include "core/rendering/style/CachedUAStyle.h"
33#include "platform/scroll/ScrollTypes.h"
34#include "wtf/PassRefPtr.h"
35#include "wtf/RefCounted.h"
36#include "wtf/text/WTFString.h"
37
38namespace blink {
39
40class Element;
41class FileList;
42class HTMLInputElement;
43class RenderMeter;
44class RenderProgress;
45
46
47class RenderTheme : public RefCounted<RenderTheme> {
48protected:
49    RenderTheme();
50
51public:
52    virtual ~RenderTheme() { }
53
54    // This function is to be implemented in your platform-specific theme implementation to hand back the
55    // appropriate platform theme.
56    static RenderTheme& theme();
57
58    static void setSizeIfAuto(RenderStyle*, const IntSize&);
59
60    // This method is called whenever style has been computed for an element and the appearance
61    // property has been set to a value other than "none".  The theme should map in all of the appropriate
62    // metrics and defaults given the contents of the style.  This includes sophisticated operations like
63    // selection of control size based off the font, the disabling of appearance when certain other properties like
64    // "border" are set, or if the appearance is not supported by the theme.
65    void adjustStyle(RenderStyle*, Element*, const CachedUAStyle*);
66
67    // This method is called to paint the widget as a background of the RenderObject.  A widget's foreground, e.g., the
68    // text of a button, is always rendered by the engine itself.  The boolean return value indicates
69    // whether the CSS border/background should also be painted.
70    bool paint(RenderObject*, const PaintInfo&, const IntRect&);
71    bool paintBorderOnly(RenderObject*, const PaintInfo&, const IntRect&);
72    bool paintDecorations(RenderObject*, const PaintInfo&, const IntRect&);
73
74    // The remaining methods should be implemented by the platform-specific portion of the theme, e.g.,
75    // RenderThemeMac.cpp for Mac OS X.
76
77    // These methods return the theme's extra style sheets rules, to let each platform
78    // adjust the default CSS rules in html.css, quirks.css or mediaControls.css.
79    virtual String extraDefaultStyleSheet();
80    virtual String extraQuirksStyleSheet() { return String(); }
81    virtual String extraMediaControlsStyleSheet() { return String(); }
82    virtual String extraFullScreenStyleSheet() { return String(); }
83
84    // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
85    // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
86    // controls that need to do this.
87    virtual int baselinePosition(const RenderObject*) const;
88
89    // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
90    // the baseline position API above).
91    bool isControlContainer(ControlPart) const;
92
93    // Whether or not the control has been styled enough by the author to disable the native appearance.
94    virtual bool isControlStyled(const RenderStyle*, const CachedUAStyle*) const;
95
96    // Some controls may spill out of their containers (e.g., the check on an OS X checkbox). When these controls issues paint invalidations,
97    // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
98    virtual void adjustPaintInvalidationRect(const RenderObject*, IntRect&);
99
100    // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
101    // or a control becomes disabled.
102    virtual bool stateChanged(RenderObject*, ControlState) const;
103
104    bool shouldDrawDefaultFocusRing(RenderObject*) const;
105
106    // A method asking if the theme's controls actually care about redrawing when hovered.
107    virtual bool supportsHover(const RenderStyle*) const { return false; }
108
109#if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
110    // A method asking if the platform is able to show a calendar picker for a given input type.
111    virtual bool supportsCalendarPicker(const AtomicString&) const;
112#endif
113
114    // Text selection colors.
115    Color activeSelectionBackgroundColor() const;
116    Color inactiveSelectionBackgroundColor() const;
117    Color activeSelectionForegroundColor() const;
118    Color inactiveSelectionForegroundColor() const;
119
120    // List box selection colors
121    Color activeListBoxSelectionBackgroundColor() const;
122    Color activeListBoxSelectionForegroundColor() const;
123    Color inactiveListBoxSelectionBackgroundColor() const;
124    Color inactiveListBoxSelectionForegroundColor() const;
125
126    // Highlighting colors for TextMatches.
127    virtual Color platformActiveTextSearchHighlightColor() const;
128    virtual Color platformInactiveTextSearchHighlightColor() const;
129
130    Color focusRingColor() const;
131    virtual Color platformFocusRingColor() const { return Color(0, 0, 0); }
132    void setCustomFocusRingColor(const Color&);
133    static Color tapHighlightColor();
134    virtual Color platformTapHighlightColor() const { return RenderTheme::defaultTapHighlightColor; }
135    virtual Color platformDefaultCompositionBackgroundColor() const { return defaultCompositionBackgroundColor; }
136    virtual void platformColorsDidChange();
137
138    virtual double caretBlinkInterval() const { return 0.5; }
139
140    // System fonts and colors for CSS.
141    virtual void systemFont(CSSValueID, FontDescription&) const = 0;
142    virtual Color systemColor(CSSValueID) const;
143
144    virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
145
146    virtual void adjustSliderThumbSize(RenderStyle*, Element*) const;
147
148    virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
149    virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
150    virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
151    virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
152    virtual bool popupOptionSupportsTextIndent() const { return false; }
153
154    virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
155
156    // Method for painting the caps lock indicator
157    virtual bool paintCapsLockIndicator(RenderObject*, const PaintInfo&, const IntRect&) { return 0; };
158
159    // Returns the repeat interval of the animation for the progress bar.
160    virtual double animationRepeatIntervalForProgressBar(RenderProgress*) const;
161    // Returns the duration of the animation for the progress bar.
162    virtual double animationDurationForProgressBar(RenderProgress*) const;
163
164    // Media controls
165    virtual String formatMediaControlsTime(float time) const;
166    virtual String formatMediaControlsCurrentTime(float currentTime, float duration) const;
167
168    virtual IntSize meterSizeForBounds(const RenderMeter*, const IntRect&) const;
169    virtual bool supportsMeter(ControlPart) const;
170
171    // Returns size of one slider tick mark for a horizontal track.
172    // For vertical tracks we rotate it and use it. i.e. Width is always length along the track.
173    virtual IntSize sliderTickSize() const = 0;
174    // Returns the distance of slider tick origin from the slider track center.
175    virtual int sliderTickOffsetFromTrackCenter() const = 0;
176    void paintSliderTicks(RenderObject*, const PaintInfo&, const IntRect&);
177
178    virtual bool shouldShowPlaceholderWhenFocused() const { return false; }
179    virtual bool shouldHaveSpinButton(HTMLInputElement*) const;
180
181    // Functions for <select> elements.
182    virtual bool delegatesMenuListRendering() const { return false; }
183    virtual bool popsMenuByArrowKeys() const { return false; }
184    virtual bool popsMenuBySpaceKey() const { return false; }
185    virtual bool popsMenuByReturnKey() const { return false; }
186    virtual bool popsMenuByAltDownUpOrF4Key() const { return false; }
187
188    virtual String fileListNameForWidth(Locale&, const FileList*, const Font&, int width) const;
189
190    virtual bool shouldOpenPickerWithF4Key() const;
191
192    virtual bool supportsSelectionForegroundColors() const { return true; }
193
194    virtual bool isModalColorChooser() const { return true; }
195
196protected:
197    // The platform selection color.
198    virtual Color platformActiveSelectionBackgroundColor() const;
199    virtual Color platformInactiveSelectionBackgroundColor() const;
200    virtual Color platformActiveSelectionForegroundColor() const;
201    virtual Color platformInactiveSelectionForegroundColor() const;
202
203    virtual Color platformActiveListBoxSelectionBackgroundColor() const;
204    virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
205    virtual Color platformActiveListBoxSelectionForegroundColor() const;
206    virtual Color platformInactiveListBoxSelectionForegroundColor() const;
207
208    // A method asking if the theme is able to draw the focus ring.
209    virtual bool supportsFocusRing(const RenderStyle*) const;
210
211#if !USE(NEW_THEME)
212    // Methods for each appearance value.
213    virtual void adjustCheckboxStyle(RenderStyle*, Element*) const;
214    virtual bool paintCheckbox(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
215    virtual void setCheckboxSize(RenderStyle*) const { }
216
217    virtual void adjustRadioStyle(RenderStyle*, Element*) const;
218    virtual bool paintRadio(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
219    virtual void setRadioSize(RenderStyle*) const { }
220
221    virtual void adjustButtonStyle(RenderStyle*, Element*) const;
222    virtual bool paintButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
223
224    virtual void adjustInnerSpinButtonStyle(RenderStyle*, Element*) const;
225    virtual bool paintInnerSpinButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
226#endif
227
228    virtual bool paintTextField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
229
230    virtual bool paintTextArea(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
231
232    virtual void adjustMenuListStyle(RenderStyle*, Element*) const;
233    virtual bool paintMenuList(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
234
235    virtual void adjustMenuListButtonStyle(RenderStyle*, Element*) const;
236    virtual bool paintMenuListButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
237
238    virtual bool paintMeter(RenderObject*, const PaintInfo&, const IntRect&);
239
240    virtual bool paintProgressBar(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
241
242    virtual bool paintSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
243
244    virtual void adjustSliderThumbStyle(RenderStyle*, Element*) const;
245    virtual bool paintSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
246
247    virtual void adjustSearchFieldStyle(RenderStyle*, Element*) const;
248    virtual bool paintSearchField(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
249
250    virtual void adjustSearchFieldCancelButtonStyle(RenderStyle*, Element*) const;
251    virtual bool paintSearchFieldCancelButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
252
253    virtual void adjustSearchFieldDecorationStyle(RenderStyle*, Element*) const;
254    virtual bool paintSearchFieldDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
255
256    virtual void adjustSearchFieldResultsDecorationStyle(RenderStyle*, Element*) const;
257    virtual bool paintSearchFieldResultsDecoration(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
258
259    virtual bool paintMediaFullscreenButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
260    virtual bool paintMediaPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
261    virtual bool paintMediaOverlayPlayButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
262    virtual bool paintMediaMuteButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
263    virtual bool paintMediaSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
264    virtual bool paintMediaSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
265    virtual bool paintMediaVolumeSliderContainer(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
266    virtual bool paintMediaVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
267    virtual bool paintMediaVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
268    virtual bool paintMediaToggleClosedCaptionsButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
269    virtual bool paintMediaCastButton(RenderObject*, const PaintInfo&, const IntRect&) { return true; };
270    virtual bool paintMediaControlsBackground(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
271    virtual bool paintMediaCurrentTime(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
272    virtual bool paintMediaTimeRemaining(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
273    virtual bool paintMediaFullScreenVolumeSliderTrack(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
274    virtual bool paintMediaFullScreenVolumeSliderThumb(RenderObject*, const PaintInfo&, const IntRect&) { return true; }
275
276    virtual bool shouldUseFallbackTheme(RenderStyle*) const;
277    void adjustStyleUsingFallbackTheme(RenderStyle*, Element*);
278    bool paintUsingFallbackTheme(RenderObject*, const PaintInfo&, const IntRect&);
279    void adjustCheckboxStyleUsingFallbackTheme(RenderStyle*, Element*) const;
280    bool paintCheckboxUsingFallbackTheme(RenderObject*, const PaintInfo&, const IntRect&);
281    void adjustRadioStyleUsingFallbackTheme(RenderStyle*, Element*) const;
282    bool paintRadioUsingFallbackTheme(RenderObject*, const PaintInfo&, const IntRect&);
283
284public:
285    // Methods for state querying
286    ControlStates controlStatesForRenderer(const RenderObject* o) const;
287    bool isActive(const RenderObject*) const;
288    bool isChecked(const RenderObject*) const;
289    bool isIndeterminate(const RenderObject*) const;
290    bool isEnabled(const RenderObject*) const;
291    bool isFocused(const RenderObject*) const;
292    bool isPressed(const RenderObject*) const;
293    bool isSpinUpButtonPartPressed(const RenderObject*) const;
294    bool isHovered(const RenderObject*) const;
295    bool isSpinUpButtonPartHovered(const RenderObject*) const;
296    bool isReadOnlyControl(const RenderObject*) const;
297
298private:
299    Color m_customFocusRingColor;
300    bool m_hasCustomFocusRingColor;
301
302    // This color is expected to be drawn on a semi-transparent overlay,
303    // making it more transparent than its alpha value indicates.
304    static const RGBA32 defaultTapHighlightColor = 0x66000000;
305
306    static const RGBA32 defaultCompositionBackgroundColor = 0xFFFFDD55;
307
308#if USE(NEW_THEME)
309    Theme* m_platformTheme; // The platform-specific theme.
310#endif
311};
312
313} // namespace blink
314
315#endif // RenderTheme_h
316