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