Home | History | Annotate | Download | only in web
      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 "../platform/WebVector.h"
     35 #include "WebElement.h"
     36 
     37 #if BLINK_IMPLEMENTATION
     38 namespace WebCore { class HTMLFormElement; }
     39 #endif
     40 
     41 namespace blink {
     42 
     43     class WebInputElement;
     44     class WebFormControlElement;
     45 
     46     // A container for passing around a reference to a form element.  Provides
     47     // some information about the form.
     48     class WebFormElement : public WebElement {
     49     public:
     50         ~WebFormElement() { reset(); }
     51 
     52         WebFormElement() : WebElement() { }
     53         WebFormElement(const WebFormElement& element) : WebElement(element) { }
     54 
     55         WebFormElement& operator=(const WebFormElement& element)
     56         {
     57             WebElement::assign(element);
     58             return *this;
     59         }
     60         void assign(const WebFormElement& element) { WebElement::assign(element); }
     61 
     62         BLINK_EXPORT bool autoComplete() const;
     63         BLINK_EXPORT WebString action() const;
     64         BLINK_EXPORT WebString name() const;
     65         BLINK_EXPORT WebString method() const;
     66         BLINK_EXPORT bool wasUserSubmitted() const;
     67         BLINK_EXPORT void submit();
     68         // FIXME: Deprecate and replace with WebVector<WebElement>.
     69         BLINK_EXPORT void getNamedElements(const WebString&, WebVector<WebNode>&);
     70         BLINK_EXPORT void getFormControlElements(WebVector<WebFormControlElement>&) const;
     71 
     72         // NOTE: This function dispatches "invalid" events. Only call this if required by a specification (e.g. requestAutocomplete()).
     73         BLINK_EXPORT bool checkValidity();
     74 
     75         enum AutocompleteResult {
     76             AutocompleteResultSuccess,
     77             AutocompleteResultErrorDisabled,
     78             AutocompleteResultErrorCancel,
     79             AutocompleteResultErrorInvalid,
     80         };
     81         BLINK_EXPORT void finishRequestAutocomplete(WebFormElement::AutocompleteResult);
     82 
     83 #if BLINK_IMPLEMENTATION
     84         WebFormElement(const PassRefPtrWillBeRawPtr<WebCore::HTMLFormElement>&);
     85         WebFormElement& operator=(const PassRefPtrWillBeRawPtr<WebCore::HTMLFormElement>&);
     86         operator PassRefPtrWillBeRawPtr<WebCore::HTMLFormElement>() const;
     87 #endif
     88     };
     89 
     90 } // namespace blink
     91 
     92 #endif
     93