DOM event handling should pass Event around by reference.
[WebKit-https.git] / Source / WebCore / html / TextFieldInputType.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 TextFieldInputType_h
32 #define TextFieldInputType_h
33
34 #include "AutoFillButtonElement.h"
35 #include "InputType.h"
36 #include "SpinButtonElement.h"
37
38 namespace WebCore {
39
40 class FormDataList;
41 class TextControlInnerTextElement;
42
43 // The class represents types of which UI contain text fields.
44 // It supports not only the types for BaseTextInputType but also type=number.
45 class TextFieldInputType : public InputType, protected SpinButtonElement::SpinButtonOwner, protected AutoFillButtonElement::AutoFillButtonOwner {
46 protected:
47     explicit TextFieldInputType(HTMLInputElement&);
48     virtual ~TextFieldInputType();
49     void handleKeydownEvent(KeyboardEvent&) override;
50     void handleKeydownEventForSpinButton(KeyboardEvent&);
51
52     HTMLElement* containerElement() const final;
53     HTMLElement* innerBlockElement() const final;
54     TextControlInnerTextElement* innerTextElement() const final;
55     HTMLElement* innerSpinButtonElement() const final;
56     HTMLElement* capsLockIndicatorElement() const final;
57     HTMLElement* autoFillButtonElement() const final;
58
59 protected:
60     virtual bool needsContainer() const;
61     void createShadowSubtree() override;
62     void destroyShadowSubtree() override;
63     void attributeChanged() final;
64     void disabledAttributeChanged() final;
65     void readonlyAttributeChanged() final;
66     bool supportsReadOnly() const final;
67     void handleFocusEvent(Node* oldFocusedNode, FocusDirection) final;
68     void handleBlurEvent() final;
69     void setValue(const String&, bool valueChanged, TextFieldEventBehavior) override;
70     void updateInnerTextValue() final;
71     String sanitizeValue(const String&) const override;
72
73     virtual String convertFromVisibleValue(const String&) const;
74     virtual void didSetValueByUserEdit();
75
76 private:
77     bool isKeyboardFocusable(KeyboardEvent&) const final;
78     bool isMouseFocusable() const final;
79     bool isTextField() const final;
80     bool isEmptyValue() const final;
81     bool valueMissing(const String&) const final;
82     void handleBeforeTextInsertedEvent(BeforeTextInsertedEvent&) final;
83     void forwardEvent(Event&) final;
84     bool shouldSubmitImplicitly(Event&) final;
85     RenderPtr<RenderElement> createInputRenderer(RenderStyle&&) override;
86     bool shouldUseInputMethod() const override;
87     bool shouldRespectListAttribute() override;
88     HTMLElement* placeholderElement() const final;
89     void updatePlaceholderText() final;
90     bool appendFormData(FormDataList&, bool multipart) const final;
91     void subtreeHasChanged() final;
92     void capsLockStateMayHaveChanged() final;
93     void updateAutoFillButton() final;
94
95     // SpinButtonElement::SpinButtonOwner functions.
96     void focusAndSelectSpinButtonOwner() final;
97     bool shouldSpinButtonRespondToMouseEvents() final;
98     bool shouldSpinButtonRespondToWheelEvents() final;
99     void spinButtonStepDown() final;
100     void spinButtonStepUp() final;
101
102     // AutoFillButtonElement::AutoFillButtonOwner
103     void autoFillButtonElementWasClicked() final;
104
105     bool shouldHaveSpinButton() const;
106     bool shouldHaveCapsLockIndicator() const;
107     bool shouldDrawCapsLockIndicator() const;
108     bool shouldDrawAutoFillButton() const;
109
110     void createContainer();
111     void createAutoFillButton(AutoFillButtonType);
112
113     RefPtr<HTMLElement> m_container;
114     RefPtr<HTMLElement> m_innerBlock;
115     RefPtr<TextControlInnerTextElement> m_innerText;
116     RefPtr<HTMLElement> m_placeholder;
117     RefPtr<SpinButtonElement> m_innerSpinButton;
118     RefPtr<HTMLElement> m_capsLockIndicator;
119     RefPtr<HTMLElement> m_autoFillButton;
120 };
121
122 } // namespace WebCore
123
124 #endif // TextFieldInputType_h