2009-02-25 Scott Violet <sky@google.com>
[WebKit-https.git] / 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 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 #include "RenderObject.h"
27 #if USE(NEW_THEME)
28 #include "Theme.h"
29 #else
30 #include "ThemeTypes.h"
31 #endif
32 #include "ScrollTypes.h"
33
34 namespace WebCore {
35
36 class Element;
37 class PopupMenu;
38 class RenderMenuList;
39 class CSSStyleSheet;
40
41 class RenderTheme {
42 public:
43     RenderTheme();
44     virtual ~RenderTheme() { }
45
46     // This method is called whenever style has been computed for an element and the appearance
47     // property has been set to a value other than "none".  The theme should map in all of the appropriate
48     // metrics and defaults given the contents of the style.  This includes sophisticated operations like
49     // selection of control size based off the font, the disabling of appearance when certain other properties like
50     // "border" are set, or if the appearance is not supported by the theme.
51     void adjustStyle(CSSStyleSelector*, RenderStyle*, Element*,  bool UAHasAppearance,
52                      const BorderData&, const FillLayer&, const Color& backgroundColor);
53
54     // This method is called to paint the widget as a background of the RenderObject.  A widget's foreground, e.g., the
55     // text of a button, is always rendered by the engine itself.  The boolean return value indicates
56     // whether the CSS border/background should also be painted.
57     bool paint(RenderObject*, const RenderObject::PaintInfo&, const IntRect&);
58     bool paintBorderOnly(RenderObject*, const RenderObject::PaintInfo&, const IntRect&);
59     bool paintDecorations(RenderObject*, const RenderObject::PaintInfo&, const IntRect&);
60
61     // The remaining methods should be implemented by the platform-specific portion of the theme, e.g.,
62     // RenderThemeMac.cpp for Mac OS X.
63
64     // These methods return the theme's extra style sheets rules, to let each platform
65     // adjust the default CSS rules in html4.css, quirks.css, or mediaControls.css
66     virtual String extraDefaultStyleSheet() { return String(); }
67     virtual String extraQuirksStyleSheet() { return String(); }
68 #if ENABLE(VIDEO)
69     virtual String extraMediaControlsStyleSheet() { return String(); };
70 #endif
71
72     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
73     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
74     // controls that need to do this.
75     virtual int baselinePosition(const RenderObject*) const;
76
77     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
78     // the baseline position API above).
79     bool isControlContainer(ControlPart) const;
80
81     // A method asking if the control changes its tint when the window has focus or not.
82     virtual bool controlSupportsTints(const RenderObject*) const { return false; }
83
84     // Whether or not the control has been styled enough by the author to disable the native appearance.
85     virtual bool isControlStyled(const RenderStyle*, const BorderData&, const FillLayer&, const Color& backgroundColor) const;
86
87     // A general method asking if any control tinting is supported at all.
88     virtual bool supportsControlTints() const { return false; }
89
90     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
91     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
92     virtual void adjustRepaintRect(const RenderObject*, IntRect&);
93
94     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
95     // or a control becomes disabled.
96     virtual bool stateChanged(RenderObject*, ControlState) const;
97
98     // This method is called whenever the theme changes on the system in order to flush cached resources from the
99     // old theme.
100     virtual void themeChanged() { }
101
102     // A method asking if the theme is able to draw the focus ring.
103     virtual bool supportsFocusRing(const RenderStyle*) const;
104
105     // A method asking if the theme's controls actually care about redrawing when hovered.
106     virtual bool supportsHover(const RenderStyle*) const { return false; }
107
108     // Text selection colors.
109     Color activeSelectionBackgroundColor() const;
110     Color inactiveSelectionBackgroundColor() const;
111     Color activeSelectionForegroundColor() const;
112     Color inactiveSelectionForegroundColor() const;
113
114     // List box selection colors
115     Color activeListBoxSelectionBackgroundColor() const;
116     Color activeListBoxSelectionForegroundColor() const;
117     Color inactiveListBoxSelectionBackgroundColor() const;
118     Color inactiveListBoxSelectionForegroundColor() const;
119
120     virtual Color platformTextSearchHighlightColor() const;
121
122     virtual void platformColorsDidChange();
123
124     virtual double caretBlinkInterval() const { return 0.5; }
125
126     // System fonts and colors for CSS.
127     virtual void systemFont(int cssValueId, FontDescription&) const = 0;
128     virtual Color systemColor(int cssValueId) const;
129
130     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
131
132     virtual void adjustButtonInnerStyle(RenderStyle*) const;
133     virtual void adjustSliderThumbSize(RenderObject*) const;
134
135     virtual int popupInternalPaddingLeft(RenderStyle*) const { return 0; }
136     virtual int popupInternalPaddingRight(RenderStyle*) const { return 0; }
137     virtual int popupInternalPaddingTop(RenderStyle*) const { return 0; }
138     virtual int popupInternalPaddingBottom(RenderStyle*) const { return 0; }
139     
140     virtual ScrollbarControlSize scrollbarControlSizeForPart(ControlPart) { return RegularScrollbar; }
141
142     // Method for painting the caps lock indicator
143     virtual bool paintCapsLockIndicator(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return 0; };
144
145 #if ENABLE(VIDEO)
146     // Media controls
147     virtual bool hitTestMediaControlPart(RenderObject*, const IntPoint& absPoint);
148 #endif
149
150 protected:
151     // The platform selection color.
152     virtual Color platformActiveSelectionBackgroundColor() const;
153     virtual Color platformInactiveSelectionBackgroundColor() const;
154     virtual Color platformActiveSelectionForegroundColor() const;
155     virtual Color platformInactiveSelectionForegroundColor() const;
156
157     virtual Color platformActiveListBoxSelectionBackgroundColor() const;
158     virtual Color platformInactiveListBoxSelectionBackgroundColor() const;
159     virtual Color platformActiveListBoxSelectionForegroundColor() const;
160     virtual Color platformInactiveListBoxSelectionForegroundColor() const;
161
162     virtual bool supportsSelectionForegroundColors() const { return true; }
163     virtual bool supportsListBoxSelectionForegroundColors() const { return true; }
164
165 #if !USE(NEW_THEME)
166     // Methods for each appearance value.
167     virtual void adjustCheckboxStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
168     virtual bool paintCheckbox(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
169     virtual void setCheckboxSize(RenderStyle*) const { }
170
171     virtual void adjustRadioStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
172     virtual bool paintRadio(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
173     virtual void setRadioSize(RenderStyle*) const { }
174
175     virtual void adjustButtonStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
176     virtual bool paintButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
177     virtual void setButtonSize(RenderStyle*) const { }
178 #endif
179
180     virtual void adjustTextFieldStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
181     virtual bool paintTextField(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
182
183     virtual void adjustTextAreaStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
184     virtual bool paintTextArea(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
185
186     virtual void adjustMenuListStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
187     virtual bool paintMenuList(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
188
189     virtual void adjustMenuListButtonStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
190     virtual bool paintMenuListButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
191
192     virtual void adjustSliderTrackStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
193     virtual bool paintSliderTrack(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
194
195     virtual void adjustSliderThumbStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
196     virtual bool paintSliderThumb(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
197
198     virtual void adjustSearchFieldStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
199     virtual bool paintSearchField(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
200
201     virtual void adjustSearchFieldCancelButtonStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
202     virtual bool paintSearchFieldCancelButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
203
204     virtual void adjustSearchFieldDecorationStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
205     virtual bool paintSearchFieldDecoration(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
206
207     virtual void adjustSearchFieldResultsDecorationStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
208     virtual bool paintSearchFieldResultsDecoration(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
209
210     virtual void adjustSearchFieldResultsButtonStyle(CSSStyleSelector*, RenderStyle*, Element*) const;
211     virtual bool paintSearchFieldResultsButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
212
213     virtual bool paintMediaFullscreenButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
214     virtual bool paintMediaPlayButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
215     virtual bool paintMediaMuteButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
216     virtual bool paintMediaSeekBackButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
217     virtual bool paintMediaSeekForwardButton(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
218     virtual bool paintMediaSliderTrack(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
219     virtual bool paintMediaSliderThumb(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
220     virtual bool paintMediaTimelineContainer(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
221     virtual bool paintMediaCurrentTime(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
222     virtual bool paintMediaTimeRemaining(RenderObject*, const RenderObject::PaintInfo&, const IntRect&) { return true; }
223
224 public:
225     // Methods for state querying
226     ControlStates controlStatesForRenderer(const RenderObject* o) const;
227     bool isActive(const RenderObject*) const;
228     bool isChecked(const RenderObject*) const;
229     bool isIndeterminate(const RenderObject*) const;
230     bool isEnabled(const RenderObject*) const;
231     bool isFocused(const RenderObject*) const;
232     bool isPressed(const RenderObject*) const;
233     bool isHovered(const RenderObject*) const;
234     bool isReadOnlyControl(const RenderObject*) const;
235     bool isDefault(const RenderObject*) const;
236
237 private:
238     mutable Color m_activeSelectionBackgroundColor;
239     mutable Color m_inactiveSelectionBackgroundColor;
240     mutable Color m_activeSelectionForegroundColor;
241     mutable Color m_inactiveSelectionForegroundColor;
242
243     mutable Color m_activeListBoxSelectionBackgroundColor;
244     mutable Color m_inactiveListBoxSelectionBackgroundColor;
245     mutable Color m_activeListBoxSelectionForegroundColor;
246     mutable Color m_inactiveListBoxSelectionForegroundColor;
247
248 #if USE(NEW_THEME)
249     Theme* m_theme; // The platform-specific theme.
250 #endif
251 };
252
253 // Function to obtain the theme.  This is implemented in your platform-specific theme implementation to hand
254 // back the appropriate platform theme.
255 RenderTheme* theme();
256
257 } // namespace WebCore
258
259 #endif // RenderTheme_h