third_party/WebKit/public/web/WebFormControlElement.h

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