2009-11-19 Yaar Schnitman <yaar@chromium.org>
[WebKit-https.git] / WebKit / chromium / public / WebInputElement.h
1 /*
2  * Copyright (C) 2009 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 WebInputElement_h
32 #define WebInputElement_h
33
34 #include "WebElement.h"
35
36 #if WEBKIT_IMPLEMENTATION
37 namespace WebCore { class HTMLInputElement; }
38 namespace WTF { template <typename T> class PassRefPtr; }
39 #endif
40
41 namespace WebKit {
42
43     // Provides readonly access to some properties of a DOM input element node.
44     class WebInputElement : public WebElement {
45     public:
46         WebInputElement() : WebElement() { }
47         WebInputElement(const WebInputElement& n) : WebElement(n) { }
48
49         WebInputElement& operator=(const WebInputElement& n) { WebElement::assign(n); return *this; }
50         WEBKIT_API void assign(const WebInputElement& n) { WebElement::assign(n); }
51
52 #if WEBKIT_IMPLEMENTATION
53         WebInputElement(const WTF::PassRefPtr<WebCore::HTMLInputElement>&);
54         WebInputElement& operator=(const WTF::PassRefPtr<WebCore::HTMLInputElement>&);
55         operator WTF::PassRefPtr<WebCore::HTMLInputElement>() const;
56 #endif
57
58         enum InputType {
59             Text = 0,
60             Password,
61             IsIndex,
62             CheckBox,
63             Radio,
64             Submit,
65             Reset,
66             File,
67             Hidden,
68             Image,
69             Button,
70             Search,
71             Range,
72             Email,
73             Number,
74             Telephone,
75             URL,
76             Color,
77             Date,
78             DateTime,
79             DateTimeLocal,
80             Month,
81             Time,
82             Week
83         };
84         
85         WEBKIT_API bool isEnabledFormControl() const;
86         WEBKIT_API InputType inputType() const;
87         WEBKIT_API WebString formControlType() const;
88         WEBKIT_API void setActivatedSubmit(bool);
89         WEBKIT_API void setValue(const WebString& value);
90         WEBKIT_API WebString value() const;
91         WEBKIT_API void setAutofilled(bool);
92         WEBKIT_API void dispatchFormControlChangeEvent();
93         WEBKIT_API void setSelectionRange(int, int);
94         WEBKIT_API WebString name() const;
95         // Returns the name that should be used for the specified |element| when
96         // storing autofill data.  This is either the field name or its id, an empty
97         // string if it has no name and no id.
98         WEBKIT_API WebString nameForAutofill() const;
99         
100     };
101
102 } // namespace WebKit
103
104 #endif