1 /* 2 * Copyright (C) 2010 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 WebFormControlElement_h 32 #define WebFormControlElement_h 33 34 #include "../platform/WebString.h" 35 #include "WebElement.h" 36 #include "WebFormElement.h" 37 38 #if BLINK_IMPLEMENTATION 39 namespace WebCore { class HTMLFormControlElement; } 40 #endif 41 42 namespace blink { 43 44 // Provides readonly access to some properties of a DOM form control element node. 45 class WebFormControlElement : public WebElement { 46 public: WebFormControlElement()47 WebFormControlElement() : WebElement() { } WebFormControlElement(const WebFormControlElement & e)48 WebFormControlElement(const WebFormControlElement& e) : WebElement(e) { } 49 50 WebFormControlElement& operator=(const WebFormControlElement& e) 51 { 52 WebElement::assign(e); 53 return *this; 54 } assign(const WebFormControlElement & e)55 void assign(const WebFormControlElement& e) { WebElement::assign(e); } 56 57 BLINK_EXPORT bool isEnabled() const; 58 BLINK_EXPORT bool isReadOnly() const; 59 BLINK_EXPORT WebString formControlName() const; 60 BLINK_EXPORT WebString formControlType() const; 61 62 // FIXME: remove this method when no longer used. 63 BLINK_EXPORT void dispatchFormControlChangeEvent(); 64 65 BLINK_EXPORT bool isAutofilled() const; 66 BLINK_EXPORT void setAutofilled(bool); 67 68 // Returns true if autocomplete attribute of the element is not set as "off". 69 BLINK_EXPORT bool autoComplete() const; 70 71 // Sets value for input element, textarea element and select element. For select 72 // element it finds the option with value matches the given parameter and make the 73 // option as the current selection. 74 BLINK_EXPORT void setValue(const WebString&, bool sendEvents = false); 75 // Returns value of element. For select element, it returns the value of 76 // the selected option if present. If no selected option, an empty string 77 // is returned. If element doesn't fall into input element, textarea element 78 // and select element categories, a null string is returned. 79 BLINK_EXPORT WebString value() const; 80 // Sets suggested value for element. For select element it finds the option 81 // with value matches the given parameter and make the option as the suggested 82 // selection. The goal of introducing suggested value is to not leak any information 83 // to JavaScript. 84 BLINK_EXPORT void setSuggestedValue(const WebString&); 85 // Returns suggested value of element. If element doesn't fall into input element, 86 // textarea element and select element categories, a null string is returned. 87 BLINK_EXPORT WebString suggestedValue() const; 88 89 // Returns the non-sanitized, exact value inside the text input field 90 // or insisde the textarea. If neither input element nor textarea element, 91 // a null string is returned. 92 BLINK_EXPORT WebString editingValue() const; 93 94 // Sets character selection range. 95 BLINK_EXPORT void setSelectionRange(int start, int end); 96 // Returned value represents a cursor/caret position at the current 97 // selection's start for text input field or textarea. If neither input 98 // element nor textarea element, 0 is returned. 99 BLINK_EXPORT int selectionStart() const; 100 // Returned value represents a cursor/caret position at the current 101 // selection's end for text input field or textarea. If neither input 102 // element nor textarea element, 0 is returned. 103 BLINK_EXPORT int selectionEnd() const; 104 105 // Returns direction of text of element. 106 BLINK_EXPORT WebString directionForFormData() const; 107 108 // Returns true if sumit is activated. 109 BLINK_EXPORT bool isActivatedSubmit() const; 110 111 // Returns the name that should be used for the specified |element| when 112 // storing autofill data. This is either the field name or its id, an empty 113 // string if it has no name and no id. 114 BLINK_EXPORT WebString nameForAutofill() const; 115 116 BLINK_EXPORT WebFormElement form() const; 117 118 #if BLINK_IMPLEMENTATION 119 WebFormControlElement(const PassRefPtrWillBeRawPtr<WebCore::HTMLFormControlElement>&); 120 WebFormControlElement& operator=(const PassRefPtrWillBeRawPtr<WebCore::HTMLFormControlElement>&); 121 operator PassRefPtrWillBeRawPtr<WebCore::HTMLFormControlElement>() const; 122 #endif 123 }; 124 125 } // namespace blink 126 127 #endif 128