1/*
2 * Copyright (C) 2010 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef WebThemeEngine_h
32#define WebThemeEngine_h
33
34#include "../WebCanvas.h"
35#include "../WebColor.h"
36#include "../WebSize.h"
37
38namespace WebKit {
39
40struct WebRect;
41
42class WebThemeEngine {
43public:
44    // The UI part which is being accessed.
45    enum Part {
46        // ScrollbarTheme parts
47        PartScrollbarDownArrow,
48        PartScrollbarLeftArrow,
49        PartScrollbarRightArrow,
50        PartScrollbarUpArrow,
51        PartScrollbarHorizontalThumb,
52        PartScrollbarVerticalThumb,
53        PartScrollbarHorizontalTrack,
54        PartScrollbarVerticalTrack,
55
56        // RenderTheme parts
57        PartCheckbox,
58        PartRadio,
59        PartButton,
60        PartTextField,
61        PartMenuList,
62        PartSliderTrack,
63        PartSliderThumb,
64        PartInnerSpinButton,
65        PartProgressBar
66    };
67
68    // The current state of the associated Part.
69    enum State {
70        StateDisabled,
71        StateHover,
72        StateNormal,
73        StatePressed,
74    };
75
76    // Extra parameters for drawing the PartScrollbarHorizontalTrack and
77    // PartScrollbarVerticalTrack.
78    struct ScrollbarTrackExtraParams {
79        // The bounds of the entire track, as opposed to the part being painted.
80        int trackX;
81        int trackY;
82        int trackWidth;
83        int trackHeight;
84    };
85
86    // Extra parameters for PartCheckbox, PartPushButton and PartRadio.
87    struct ButtonExtraParams {
88        bool checked;
89        bool indeterminate; // Whether the button state is indeterminate.
90        bool isDefault; // Whether the button is default button.
91        bool hasBorder;
92        WebColor backgroundColor;
93    };
94
95    // Extra parameters for PartTextField
96    struct TextFieldExtraParams {
97        bool isTextArea;
98        bool isListbox;
99        WebColor backgroundColor;
100    };
101
102    // Extra parameters for PartMenuList
103    struct MenuListExtraParams {
104        bool hasBorder;
105        bool hasBorderRadius;
106        int arrowX;
107        int arrowY;
108        WebColor backgroundColor;
109    };
110
111    // Extra parameters for PartSliderTrack and PartSliderThumb
112    struct SliderExtraParams {
113        bool vertical;
114        bool inDrag;
115    };
116
117    // Extra parameters for PartInnerSpinButton
118    struct InnerSpinButtonExtraParams {
119        bool spinUp;
120        bool readOnly;
121    };
122
123    // Extra parameters for PartProgressBar
124    struct ProgressBarExtraParams {
125        bool determinate;
126        int valueRectX;
127        int valueRectY;
128        int valueRectWidth;
129        int valueRectHeight;
130    };
131
132    union ExtraParams {
133        ScrollbarTrackExtraParams scrollbarTrack;
134        ButtonExtraParams button;
135        TextFieldExtraParams textField;
136        MenuListExtraParams menuList;
137        SliderExtraParams slider;
138        InnerSpinButtonExtraParams innerSpin;
139        ProgressBarExtraParams progressBar;
140    };
141
142    // Gets the size of the given theme part. For variable sized items
143    // like vertical scrollbar thumbs, the width will be the required width of
144    // the track while the height will be the minimum height.
145    virtual WebSize getSize(Part) { return WebSize(); }
146    // Paint the given the given theme part.
147    virtual void paint(
148        WebCanvas*, Part, State, const WebRect&, const ExtraParams*) {}
149};
150
151} // namespace WebKit
152
153#endif
154