WebCore:
[WebKit-https.git] / WebCore / html / HTMLInputElement.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 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 HTMLInputElement_h
25 #define HTMLInputElement_h
26
27 #include "HTMLFormControlElement.h"
28 #include <wtf/OwnPtr.h>
29
30 namespace WebCore {
31
32 class FileList;
33 class HTMLImageLoader;
34 class KURL;
35 class Selection;
36
37 class HTMLInputElement : public HTMLFormControlElementWithState {
38 public:
39     enum InputType {
40         TEXT,
41         PASSWORD,
42         ISINDEX,
43         CHECKBOX,
44         RADIO,
45         SUBMIT,
46         RESET,
47         FILE,
48         HIDDEN,
49         IMAGE,
50         BUTTON,
51         SEARCH,
52         RANGE
53     };
54     
55     enum AutoCompleteSetting {
56         Uninitialized,
57         On,
58         Off
59     };
60
61     HTMLInputElement(Document*, HTMLFormElement* = 0);
62     HTMLInputElement(const QualifiedName& tagName, Document*, HTMLFormElement* = 0);
63     virtual ~HTMLInputElement();
64
65     virtual HTMLTagStatus endTagRequirement() const { return TagStatusForbidden; }
66     virtual int tagPriority() const { return 0; }
67
68     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
69     virtual bool isMouseFocusable() const;
70     virtual bool isEnumeratable() const { return inputType() != IMAGE; }
71     virtual void dispatchFocusEvent();
72     virtual void dispatchBlurEvent();
73     virtual void updateFocusAppearance(bool restorePreviousSelection);
74     virtual void aboutToUnload();
75     virtual bool shouldUseInputMethod() const;
76
77     virtual const AtomicString& name() const;
78
79     bool autoComplete() const;
80
81     // isChecked is used by the rendering tree/CSS while checked() is used by JS to determine checked state
82     virtual bool isChecked() const { return checked() && (inputType() == CHECKBOX || inputType() == RADIO); }
83     virtual bool isIndeterminate() const { return indeterminate(); }
84     
85     bool readOnly() const { return isReadOnlyControl(); }
86
87     virtual bool isTextControl() const { return isTextField(); }
88
89     bool isTextButton() const { return m_type == SUBMIT || m_type == RESET || m_type == BUTTON; }
90     virtual bool isRadioButton() const { return m_type == RADIO; }
91     bool isTextField() const { return m_type == TEXT || m_type == PASSWORD || m_type == SEARCH || m_type == ISINDEX; }
92     bool isSearchField() const { return m_type == SEARCH; }
93     virtual bool isInputTypeHidden() const { return m_type == HIDDEN; }
94     virtual bool isPasswordField() const { return m_type == PASSWORD; }
95
96     bool checked() const { return m_checked; }
97     void setChecked(bool, bool sendChangeEvent = false);
98     bool indeterminate() const { return m_indeterminate; }
99     void setIndeterminate(bool);
100     int maxLength() const { return m_maxLen; }
101     int size() const { return m_size; }
102     virtual const AtomicString& type() const;
103     void setType(const String&);
104
105     String value() const;
106     void setValue(const String&);
107
108     String valueWithDefault() const;
109
110     void setValueFromRenderer(const String&);
111
112     virtual bool saveState(String& value) const;
113     virtual void restoreState(const String&);
114
115     virtual bool canStartSelection() const;
116     
117     bool canHaveSelection() const;
118     int selectionStart() const;
119     int selectionEnd() const;
120     void setSelectionStart(int);
121     void setSelectionEnd(int);
122     void select();
123     void setSelectionRange(int start, int end);
124
125     virtual void accessKeyAction(bool sendToAnyElement);
126
127     virtual bool mapToEntry(const QualifiedName& attrName, MappedAttributeEntry& result) const;
128     virtual void parseMappedAttribute(MappedAttribute*);
129
130     virtual void copyNonAttributeProperties(const Element* source);
131
132     virtual void attach();
133     virtual bool rendererIsNeeded(RenderStyle*);
134     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
135     virtual void detach();
136     virtual bool appendFormData(FormDataList&, bool);
137
138     virtual bool isSuccessfulSubmitButton() const;
139     virtual bool isActivatedSubmit() const;
140     virtual void setActivatedSubmit(bool flag);
141
142     InputType inputType() const { return static_cast<InputType>(m_type); }
143     void setInputType(const String&);
144     
145     // Report if this input type uses height & width attributes
146     bool respectHeightAndWidthAttrs() const { return inputType() == IMAGE || inputType() == HIDDEN; }
147
148     virtual void reset();
149
150     virtual void* preDispatchEventHandler(Event*);
151     virtual void postDispatchEventHandler(Event*, void* dataFromPreDispatch);
152     virtual void defaultEventHandler(Event*);
153
154     String altText() const;
155     
156     virtual bool isURLAttribute(Attribute*) const;
157
158     int maxResults() const { return m_maxResults; }
159
160     String defaultValue() const;
161     void setDefaultValue(const String&);
162     
163     bool defaultChecked() const;
164     void setDefaultChecked(bool);
165
166     String accept() const;
167     void setAccept(const String&);
168
169     String accessKey() const;
170     void setAccessKey(const String&);
171
172     String align() const;
173     void setAlign(const String&);
174
175     String alt() const;
176     void setAlt(const String&);
177
178     void setSize(unsigned);
179
180     KURL src() const;
181     void setSrc(const String&);
182
183     void setMaxLength(int);
184
185     String useMap() const;
186     void setUseMap(const String&);
187
188     bool autofilled() const { return m_autofilled; }
189     void setAutofilled(bool b = true) { m_autofilled = b; }
190
191     FileList* files();
192
193     void cacheSelection(int s, int e) { cachedSelStart = s; cachedSelEnd = e; };
194     void addSearchResult();
195     void onSearch();
196     
197     Selection selection() const;
198
199     String constrainValue(const String& proposedValue) const;
200
201     virtual void didRestoreFromCache();
202
203     virtual void getSubresourceAttributeStrings(Vector<String>&) const;
204     
205 protected:
206     virtual void willMoveToNewOwnerDocument();
207     virtual void didMoveToNewOwnerDocument();
208     
209     AtomicString m_name;
210
211 private:
212     void init();
213     bool storesValueSeparateFromAttribute() const;
214     String constrainValue(const String& proposedValue, int maxLen) const;
215     void recheckValue();
216
217     String m_value;
218     String m_originalValue;
219     int xPos;
220     int m_maxLen;
221     short m_size;
222     short yPos;
223
224     short m_maxResults;
225
226     OwnPtr<HTMLImageLoader> m_imageLoader;
227
228     RefPtr<FileList> m_fileList;
229
230     unsigned m_type : 4; // InputType 
231     bool m_checked : 1;
232     bool m_defaultChecked : 1;
233     bool m_useDefaultChecked : 1;
234     bool m_indeterminate : 1;
235     bool m_haveType : 1;
236     bool m_activeSubmit : 1;
237     AutoCompleteSetting m_autocomplete : 2;
238     bool m_autofilled : 1;
239     bool m_inited : 1;
240     
241     int cachedSelStart;
242     int cachedSelEnd;
243 };
244
245 } //namespace
246
247 #endif