2009-11-19 Yaar Schnitman <yaar@chromium.org>
[WebKit-https.git] / WebKit / chromium / public / WebFormElement.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 WebFormElement_h
32 #define WebFormElement_h
33
34 #include "WebElement.h"
35 #include "WebInputElement.h"
36 #include "WebVector.h"
37
38 #if WEBKIT_IMPLEMENTATION
39 namespace WebCore { class HTMLFormElement; }
40 namespace WTF { template <typename T> class PassRefPtr; }
41 #endif
42
43 namespace WebKit {
44     // A container for passing around a reference to a form element.  Provides
45     // some information about the form.
46     class WebFormElement : public WebElement {
47     public:
48         ~WebFormElement() { reset(); }
49
50         WebFormElement() : WebElement() { }
51         WebFormElement(const WebFormElement& e) : WebElement(e) { }
52
53         WebElement& operator=(const WebFormElement& e) { WebElement::assign(e); return *this; }
54         WEBKIT_API void assign(const WebFormElement& e) { WebElement::assign(e); }
55
56 #if WEBKIT_IMPLEMENTATION
57         WebFormElement(const WTF::PassRefPtr<WebCore::HTMLFormElement>&);
58         WebFormElement& operator=(const WTF::PassRefPtr<WebCore::HTMLFormElement>&);
59         operator WTF::PassRefPtr<WebCore::HTMLFormElement>() const;
60 #endif
61
62         WEBKIT_API bool autoComplete() const;
63         WEBKIT_API WebString action() const;
64         WEBKIT_API WebString name() const;
65         WEBKIT_API WebString method() const;
66         WEBKIT_API void submit();
67         // FIXME: Deprecate and replace with WebVector<WebElement>.
68         WEBKIT_API void getNamedElements(const WebString&, WebVector<WebNode>&);
69         WEBKIT_API void getInputElements(WebVector<WebInputElement>&) const;
70     };
71
72 } // namespace WebKit
73
74 #endif