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 WebInputElement_h
     32 #define WebInputElement_h
     33 
     34 #include "WebFormControlElement.h"
     35 
     36 #if BLINK_IMPLEMENTATION
     37 namespace WebCore { class HTMLInputElement; }
     38 #endif
     39 
     40 namespace blink {
     41 
     42     class WebElementCollection;
     43 
     44     // Provides readonly access to some properties of a DOM input element node.
     45     class WebInputElement : public WebFormControlElement {
     46     public:
     47         WebInputElement() : WebFormControlElement() { }
     48         WebInputElement(const WebInputElement& element) : WebFormControlElement(element) { }
     49 
     50         WebInputElement& operator=(const WebInputElement& element)
     51         {
     52             WebFormControlElement::assign(element);
     53             return *this;
     54         }
     55         void assign(const WebInputElement& element) { WebFormControlElement::assign(element); }
     56 
     57         // This returns true for all of textfield-looking types such as text,
     58         // password, search, email, url, and number.
     59         BLINK_EXPORT bool isTextField() const;
     60         // This returns true only for type=text.
     61         BLINK_EXPORT bool isText() const;
     62         BLINK_EXPORT bool isPasswordField() const;
     63         BLINK_EXPORT bool isImageButton() const;
     64         BLINK_EXPORT bool isRadioButton() const;
     65         BLINK_EXPORT bool isCheckbox() const;
     66         BLINK_EXPORT int maxLength() const;
     67         BLINK_EXPORT void setActivatedSubmit(bool);
     68         BLINK_EXPORT int size() const;
     69         BLINK_EXPORT void setChecked(bool, bool sendEvents = false);
     70         // Sets the value inside the text field without being sanitized.
     71         // Can't be used if a renderer doesn't exist or on a non text field type.
     72         // Caret will be moved to the end.
     73         BLINK_EXPORT void setEditingValue(const WebString&);
     74         BLINK_EXPORT bool isValidValue(const WebString&) const;
     75         BLINK_EXPORT bool isChecked() const;
     76         BLINK_EXPORT bool isMultiple() const;
     77 
     78         BLINK_EXPORT WebElementCollection dataListOptions() const;
     79 
     80         // Return the localized value for this input type.
     81         BLINK_EXPORT WebString localizeValue(const WebString&) const;
     82 
     83         // Exposes the default value of the maxLength attribute.
     84         BLINK_EXPORT static int defaultMaxLength();
     85 
     86         // If true, forces the text of the element to be visible.
     87         BLINK_EXPORT void setShouldRevealPassword(bool value);
     88 
     89 #if BLINK_IMPLEMENTATION
     90         WebInputElement(const PassRefPtrWillBeRawPtr<WebCore::HTMLInputElement>&);
     91         WebInputElement& operator=(const PassRefPtrWillBeRawPtr<WebCore::HTMLInputElement>&);
     92         operator PassRefPtrWillBeRawPtr<WebCore::HTMLInputElement>() const;
     93 #endif
     94     };
     95 
     96     BLINK_EXPORT WebInputElement* toWebInputElement(WebElement*);
     97 
     98     inline const WebInputElement* toWebInputElement(const WebElement* element)
     99     {
    100         return toWebInputElement(const_cast<WebElement*>(element));
    101     }
    102 
    103 } // namespace blink
    104 
    105 #endif
    106