third_party/WebKit/public/platform/WebThemeEngine.h

   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
  38 namespace blink {
  39
  40 struct WebRect;
  41
  42 class WebThemeEngine {
  43 public:
  44     // The current state of the associated Part.
  45     enum State {
  46         StateDisabled,
  47         StateHover,
  48         StateNormal,
  49         StatePressed,
  50         StateFocused,
  51         StateReadonly,
  52     };
  53
  54     // The UI part which is being accessed.
  55     enum Part {
  56         // ScrollbarTheme parts
  57         PartScrollbarDownArrow,
  58         PartScrollbarLeftArrow,
  59         PartScrollbarRightArrow,
  60         PartScrollbarUpArrow,
  61         PartScrollbarHorizontalThumb,
  62         PartScrollbarVerticalThumb,
  63         PartScrollbarHorizontalTrack,
  64         PartScrollbarVerticalTrack,
  65         PartScrollbarCorner,
  66
  67         // LayoutTheme parts
  68         PartCheckbox,
  69         PartRadio,
  70         PartButton,
  71         PartTextField,
  72         PartMenuList,
  73         PartSliderTrack,
  74         PartSliderThumb,
  75         PartInnerSpinButton,
  76         PartProgressBar
  77     };
  78
  79     // Extra parameters for drawing the PartScrollbarHorizontalTrack and
  80     // PartScrollbarVerticalTrack.
  81     struct ScrollbarTrackExtraParams {
  82         bool isBack; // Whether this is the 'back' part or the 'forward' part.
  83
  84         // The bounds of the entire track, as opposed to the part being painted.
  85         int trackX;
  86         int trackY;
  87         int trackWidth;
  88         int trackHeight;
  89     };
  90
  91     // Extra parameters for PartCheckbox, PartPushButton and PartRadio.
  92     struct ButtonExtraParams {
  93         bool checked;
  94         bool indeterminate; // Whether the button state is indeterminate.
  95         bool isDefault; // Whether the button is default button.
  96         bool hasBorder;
  97         WebColor backgroundColor;
  98     };
  99
 100     // Extra parameters for PartTextField
 101     struct TextFieldExtraParams {
 102         bool isTextArea;
 103         bool isListbox;
 104         WebColor backgroundColor;
 105     };
 106
 107     // Extra parameters for PartMenuList
 108     struct MenuListExtraParams {
 109         bool hasBorder;
 110         bool hasBorderRadius;
 111         int arrowX;
 112         int arrowY;
 113         int arrowHeight;
 114         WebColor backgroundColor;
 115         bool fillContentArea;
 116     };
 117
 118     // Extra parameters for PartSliderTrack and PartSliderThumb
 119     struct SliderExtraParams {
 120         bool vertical;
 121         bool inDrag;
 122     };
 123
 124     // Extra parameters for PartInnerSpinButton
 125     struct InnerSpinButtonExtraParams {
 126         bool spinUp;
 127         bool readOnly;
 128     };
 129
 130     // Extra parameters for PartProgressBar
 131     struct ProgressBarExtraParams {
 132         bool determinate;
 133         int valueRectX;
 134         int valueRectY;
 135         int valueRectWidth;
 136         int valueRectHeight;
 137     };
 138
 139     union ExtraParams {
 140         ScrollbarTrackExtraParams scrollbarTrack;
 141         ButtonExtraParams button;
 142         TextFieldExtraParams textField;
 143         MenuListExtraParams menuList;
 144         SliderExtraParams slider;
 145         InnerSpinButtonExtraParams innerSpin;
 146         ProgressBarExtraParams progressBar;
 147     };
 148
 149     // Gets the size of the given theme part. For variable sized items
 150     // like vertical scrollbar thumbs, the width will be the required width of
 151     // the track while the height will be the minimum height.
 152     virtual WebSize getSize(Part) { return WebSize(); }
 153     // Paint the given the given theme part.
 154     virtual void paint(WebCanvas*, Part, State, const WebRect&, const ExtraParams*) { }
 155 };
 156
 157 } // namespace blink
 158
 159 #endif