cd82c508c0d71d8ef791a483074580e7111008cc
[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 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., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  *
21  */
22
23 #ifndef RENDER_THEME_H
24 #define RENDER_THEME_H
25
26 #include "RenderObject.h"
27
28 namespace WebCore {
29
30 class Element;
31 class RenderPopupMenu;
32 class RenderMenuList;
33
34 enum ControlState { HoverState, PressedState, FocusState, EnabledState, CheckedState, ReadOnlyState };
35
36 class RenderTheme {
37 public:
38     RenderTheme() {}
39     virtual ~RenderTheme() {}
40
41     // This method is called whenever style has been computed for an element and the appearance
42     // property has been set to a value other than "none".  The theme should map in all of the appropriate
43     // metrics and defaults given the contents of the style.  This includes sophisticated operations like
44     // selection of control size based off the font, the disabling of appearance when certain other properties like
45     // "border" are set, or if the appearance is not supported by the theme.
46     void adjustStyle(CSSStyleSelector*, RenderStyle*, Element*, 
47                     bool UAHasAppearance, const BorderData&, const BackgroundLayer&, const Color& backgroundColor);
48     
49     // This method is called to paint the widget as a background of the RenderObject.  A widget's foreground, e.g., the
50     // text of a button, is always rendered by the engine itself.  The boolean return value indicates
51     // whether the CSS border/background should also be painted.
52     bool paint(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r);
53     bool paintBorderOnly(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r);
54     bool paintDecorations(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r);
55
56     // The remaining methods should be implemented by the platform-specific portion of the theme, e.g.,
57     // RenderThemeMac.cpp for Mac OS X.
58     
59     // A method to obtain the baseline position for a "leaf" control.  This will only be used if a baseline
60     // position cannot be determined by examining child content. Checkboxes and radio buttons are examples of
61     // controls that need to do this.
62     virtual short baselinePosition(const RenderObject* o) const;
63
64     // A method for asking if a control is a container or not.  Leaf controls have to have some special behavior (like
65     // the baseline position API above).
66     virtual bool isControlContainer(EAppearance appearance) const;
67
68     // A method asking if the control changes its tint when the window has focus or not.
69     virtual bool controlSupportsTints(const RenderObject* o) const { return false; }
70
71     // Whether or not the control has been styled enough by the author to disable the native appearance.
72     virtual bool isControlStyled(const RenderStyle* style, const BorderData& border, 
73                                  const BackgroundLayer& background, const Color& backgroundColor) const;
74
75     // A general method asking if any control tinting is supported at all.
76     virtual bool supportsControlTints() const { return false; }
77
78     // Some controls may spill out of their containers (e.g., the check on an OS X checkbox).  When these controls repaint,
79     // the theme needs to communicate this inflated rect to the engine so that it can invalidate the whole control.
80     virtual void adjustRepaintRect(const RenderObject* o, IntRect& r) { }
81     
82     // This method is called whenever a relevant state changes on a particular themed object, e.g., the mouse becomes pressed
83     // or a control becomes disabled.
84     virtual bool stateChanged(RenderObject* o, ControlState state) const;
85
86     // This method is called whenever the theme changes on the system in order to flush cached resources from the
87     // old theme.
88     virtual void themeChanged() {};
89
90     // A method asking if the theme is able to draw the focus ring.
91     virtual bool supportsFocusRing(const RenderStyle* style) const;
92     
93     // A method asking if the theme's controls actually care about redrawing when hovered.
94     virtual bool supportsHover(const RenderStyle* style) const { return false; }
95
96     // The selection color.
97     Color activeSelectionBackgroundColor() const;
98     Color inactiveSelectionBackgroundColor() const;
99
100     // The platform selection color.
101     virtual Color platformActiveSelectionBackgroundColor() const;
102     virtual Color platformInactiveSelectionBackgroundColor() const;
103     virtual Color platformActiveSelectionForegroundColor() const;
104     virtual Color platformInactiveSelectionForegroundColor() const;
105     
106     // List Box selection color
107     virtual Color activeListBoxSelectionBackgroundColor() const;
108     virtual Color activeListBoxSelectionForegroundColor() const;
109     virtual Color inactiveListBoxSelectionBackgroundColor() const;
110     virtual Color inactiveListBoxSelectionForegroundColor() const;
111
112
113     // System fonts.
114     virtual void systemFont(int propId, FontDescription&) const = 0;
115
116     virtual int minimumMenuListSize(RenderStyle*) const { return 0; }
117
118 protected:
119     // Methods for state querying
120     bool isChecked(const RenderObject* o) const;
121     bool isIndeterminate(const RenderObject* o) const;
122     bool isEnabled(const RenderObject* o) const;
123     bool isFocused(const RenderObject* o) const;
124     bool isPressed(const RenderObject* o) const;
125     bool isHovered(const RenderObject* o) const;
126     bool isReadOnlyControl(const RenderObject* o) const;
127
128     // Methods for each appearance value.
129     virtual void adjustCheckboxStyle(CSSStyleSelector* selector, RenderStyle* style, Element* e) const;
130     virtual bool paintCheckbox(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r) { return true; }
131     virtual void setCheckboxSize(RenderStyle* style) const {};
132     
133     virtual void adjustRadioStyle(CSSStyleSelector* selector, RenderStyle* style, Element* e) const;
134     virtual bool paintRadio(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r) { return true; }
135     virtual void setRadioSize(RenderStyle* style) const {};
136     
137     virtual void adjustButtonStyle(CSSStyleSelector* selector, RenderStyle* style, Element* e) const;
138     virtual bool paintButton(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r) { return true; }
139     virtual void setButtonSize(RenderStyle* style) const {};
140
141     virtual void adjustTextFieldStyle(CSSStyleSelector* selector, RenderStyle* style, Element* e) const;
142     virtual bool paintTextField(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r) { return true; }
143
144     virtual void adjustTextAreaStyle(CSSStyleSelector* selector, RenderStyle* style, Element* e) const;
145     virtual bool paintTextArea(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r) { return true; }
146
147     virtual void adjustMenuListStyle(CSSStyleSelector* selector, RenderStyle* style, Element* e) const;
148     virtual bool paintMenuList(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r) { return true; }
149
150     virtual void adjustMenuListButtonStyle(CSSStyleSelector* selector, RenderStyle* style, Element* e) const;
151     virtual bool paintMenuListButton(RenderObject* o, const RenderObject::PaintInfo& i, const IntRect& r) { return true; }
152 };
153
154 // Function to obtain the theme.  This is implemented in your platform-specific theme implementation to hand
155 // back the appropriate platform theme.
156 RenderTheme* theme();
157
158 }
159
160 #endif