Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebCore / html / HTMLFormControlElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef HTMLFormControlElement_h
25 #define HTMLFormControlElement_h
26
27 #include "FormAssociatedElement.h"
28 #include "LabelableElement.h"
29
30 #if ENABLE(IOS_AUTOCORRECT_AND_AUTOCAPITALIZE)
31 #include "Autocapitalize.h"
32 #endif
33
34 namespace WebCore {
35
36 class FormDataList;
37 class HTMLFieldSetElement;
38 class HTMLFormElement;
39 class HTMLLegendElement;
40 class ValidationMessage;
41
42 // HTMLFormControlElement is the default implementation of FormAssociatedElement,
43 // and form-associated element implementations should use HTMLFormControlElement
44 // unless there is a special reason.
45 class HTMLFormControlElement : public LabelableElement, public FormAssociatedElement {
46 public:
47     virtual ~HTMLFormControlElement();
48
49     HTMLFormElement* form() const { return FormAssociatedElement::form(); }
50
51     String formEnctype() const;
52     void setFormEnctype(const String&);
53     String formMethod() const;
54     void setFormMethod(const String&);
55     bool formNoValidate() const;
56     String formAction() const;
57     void setFormAction(const AtomicString&);
58
59     void setAncestorDisabled(bool isDisabled);
60
61     virtual void reset() { }
62
63     bool formControlValueMatchesRenderer() const { return m_valueMatchesRenderer; }
64     void setFormControlValueMatchesRenderer(bool b) { m_valueMatchesRenderer = b; }
65
66     bool wasChangedSinceLastFormControlChangeEvent() const { return m_wasChangedSinceLastFormControlChangeEvent; }
67     void setChangedSinceLastFormControlChangeEvent(bool);
68
69     virtual void dispatchFormControlChangeEvent();
70     void dispatchChangeEvent();
71     void dispatchFormControlInputEvent();
72
73     bool isDisabledFormControl() const override;
74     bool isDefaultButtonForForm() const override;
75
76     bool isFocusable() const override;
77     bool isEnumeratable() const override { return false; }
78
79     bool isRequired() const;
80
81     const AtomicString& type() const { return formControlType(); }
82
83     virtual const AtomicString& formControlType() const = 0;
84
85     virtual bool canTriggerImplicitSubmission() const { return false; }
86
87     // Override in derived classes to get the encoded name=value pair for submitting.
88     // Return true for a successful control (see HTML4-17.13.2).
89     bool appendFormData(FormDataList&, bool) override { return false; }
90
91     virtual bool isSuccessfulSubmitButton() const { return false; }
92     virtual bool isActivatedSubmit() const { return false; }
93     virtual void setActivatedSubmit(bool) { }
94
95 #if ENABLE(IOS_AUTOCORRECT_AND_AUTOCAPITALIZE)
96     WEBCORE_EXPORT bool autocorrect() const;
97     void setAutocorrect(bool);
98
99     WEBCORE_EXPORT WebAutocapitalizeType autocapitalizeType() const;
100     const AtomicString& autocapitalize() const;
101     void setAutocapitalize(const AtomicString&);
102 #endif
103
104     bool willValidate() const override final;
105     void updateVisibleValidationMessage();
106     void hideVisibleValidationMessage();
107     bool checkValidity(Vector<RefPtr<FormAssociatedElement>>* unhandledInvalidControls = 0);
108     // This must be called when a validation constraint or control value is changed.
109     void updateValidity();
110     void setCustomValidity(const String&) override;
111
112     bool isReadOnly() const { return m_isReadOnly; }
113     bool isDisabledOrReadOnly() const { return isDisabledFormControl() || m_isReadOnly; }
114
115     bool hasAutofocused() { return m_hasAutofocused; }
116     void setAutofocused() { m_hasAutofocused = true; }
117
118     static HTMLFormControlElement* enclosingFormControlElement(Node*);
119
120     String autocomplete() const;
121     void setAutocomplete(const String&);
122
123     using Node::ref;
124     using Node::deref;
125
126 protected:
127     HTMLFormControlElement(const QualifiedName& tagName, Document&, HTMLFormElement*);
128
129     bool disabledByAncestorFieldset() const { return m_disabledByAncestorFieldset; }
130
131     void parseAttribute(const QualifiedName&, const AtomicString&) override;
132     virtual void disabledAttributeChanged();
133     virtual void disabledStateChanged();
134     virtual void readOnlyAttributeChanged();
135     virtual void requiredAttributeChanged();
136     void didAttachRenderers() override;
137     InsertionNotificationRequest insertedInto(ContainerNode&) override;
138     void finishedInsertingSubtree() override;
139     void removedFrom(ContainerNode&) override;
140     void didMoveToNewDocument(Document* oldDocument) override;
141
142     bool supportsFocus() const override;
143     bool isKeyboardFocusable(KeyboardEvent*) const override;
144     bool isMouseFocusable() const override;
145
146     void didRecalcStyle(Style::Change) override;
147
148     void dispatchBlurEvent(RefPtr<Element>&& newFocusedElement) override;
149
150     // This must be called any time the result of willValidate() has changed.
151     void setNeedsWillValidateCheck();
152     virtual bool computeWillValidate() const;
153
154     bool validationMessageShadowTreeContains(const Node&) const;
155
156     void willChangeForm() override;
157     void didChangeForm() override;
158
159 private:
160     void refFormAssociatedElement() override { ref(); }
161     void derefFormAssociatedElement() override { deref(); }
162
163     bool matchesValidPseudoClass() const override;
164     bool matchesInvalidPseudoClass() const override;
165
166     bool isFormControlElement() const override final { return true; }
167     bool alwaysCreateUserAgentShadowRoot() const override { return true; }
168
169     short tabIndex() const override final;
170
171     HTMLFormElement* virtualForm() const override;
172     bool isValidFormControlElement() const;
173
174     bool computeIsDisabledByFieldsetAncestor() const;
175
176     HTMLElement& asHTMLElement() override final { return *this; }
177     const HTMLFormControlElement& asHTMLElement() const override final { return *this; }
178     HTMLFormControlElement* asFormNamedItem() override final { return this; }
179
180     std::unique_ptr<ValidationMessage> m_validationMessage;
181     bool m_disabled : 1;
182     bool m_isReadOnly : 1;
183     bool m_isRequired : 1;
184     bool m_valueMatchesRenderer : 1;
185     bool m_disabledByAncestorFieldset : 1;
186
187     enum DataListAncestorState { Unknown, InsideDataList, NotInsideDataList };
188     mutable enum DataListAncestorState m_dataListAncestorState;
189
190     // The initial value of m_willValidate depends on the derived class. We can't
191     // initialize it with a virtual function in the constructor. m_willValidate
192     // is not deterministic as long as m_willValidateInitialized is false.
193     mutable bool m_willValidateInitialized: 1;
194     mutable bool m_willValidate : 1;
195
196     // Cache of validity()->valid().
197     // But "candidate for constraint validation" doesn't affect m_isValid.
198     bool m_isValid : 1;
199
200     bool m_wasChangedSinceLastFormControlChangeEvent : 1;
201
202     bool m_hasAutofocused : 1;
203 };
204
205 } // namespace WebCore
206
207 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLFormControlElement)
208     static bool isType(const WebCore::Element& element) { return element.isFormControlElement(); }
209     static bool isType(const WebCore::Node& node) { return is<WebCore::Element>(node) && isType(downcast<WebCore::Element>(node)); }
210     static bool isType(const WebCore::FormAssociatedElement& element) { return element.isFormControlElement(); }
211 SPECIALIZE_TYPE_TRAITS_END()
212
213 #endif