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