File: WebInputElement.h

package info (click to toggle)
qtwebkit 2.3.4.dfsg-9.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 290,564 kB
  • ctags: 273,642
  • sloc: cpp: 1,417,509; python: 85,048; ansic: 39,357; perl: 38,862; ruby: 10,313; objc: 9,505; xml: 8,679; asm: 3,864; yacc: 2,458; sh: 1,237; lex: 813; makefile: 592; java: 228; php: 79
file content (130 lines) | stat: -rw-r--r-- 5,585 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebInputElement_h
#define WebInputElement_h

#include "WebFormControlElement.h"

#if WEBKIT_IMPLEMENTATION
namespace WebCore { class HTMLInputElement; }
#endif

namespace WebKit {

    class WebNodeCollection;
    class WebTextFieldDecoratorClient;

    // Provides readonly access to some properties of a DOM input element node.
    class WebInputElement : public WebFormControlElement {
    public:
        enum SpeechInputState {
            Idle,
            Recording,
            Recognizing,
        };

        WebInputElement() : WebFormControlElement() { }
        WebInputElement(const WebInputElement& element) : WebFormControlElement(element) { }

        WebInputElement& operator=(const WebInputElement& element)
        {
            WebFormControlElement::assign(element);
            return *this;
        }
        void assign(const WebInputElement& element) { WebFormControlElement::assign(element); }

        // This returns true for all of textfield-looking types such as text,
        // password, search, email, url, and number.
        WEBKIT_EXPORT bool isTextField() const;
        // This returns true only for type=text.
        WEBKIT_EXPORT bool isText() const;
        WEBKIT_EXPORT bool isPasswordField() const;
        WEBKIT_EXPORT bool isImageButton() const;
        WEBKIT_EXPORT bool autoComplete() const;
        WEBKIT_EXPORT int maxLength() const;
        WEBKIT_EXPORT bool isActivatedSubmit() const;
        WEBKIT_EXPORT void setActivatedSubmit(bool);
        WEBKIT_EXPORT int size() const;
        WEBKIT_EXPORT void setValue(const WebString&, bool sendChangeEvent = false);
        WEBKIT_EXPORT void setChecked(bool, bool sendChangeEvent = false);
        WEBKIT_EXPORT WebString value() const;
        // This returns the non-sanitized, exact value inside the text field.
        WEBKIT_EXPORT WebString editingValue() const;
        // Sets the value inside the text field without being sanitized.
        // Can't be used if a renderer doesn't exist or on a non text field type.
        // Caret will be moved to the end.
        WEBKIT_EXPORT void setEditingValue(const WebString&);
        WEBKIT_EXPORT void setSuggestedValue(const WebString&);
        WEBKIT_EXPORT WebString suggestedValue() const;
        WEBKIT_EXPORT void setPlaceholder(const WebString&);
        WEBKIT_EXPORT WebString placeholder() const;
        WEBKIT_EXPORT bool isAutofilled() const;
        WEBKIT_EXPORT void setAutofilled(bool);
        WEBKIT_EXPORT void setSelectionRange(int, int);
        WEBKIT_EXPORT int selectionStart() const;
        WEBKIT_EXPORT int selectionEnd() const;
        WEBKIT_EXPORT bool isValidValue(const WebString&) const;
        WEBKIT_EXPORT bool isChecked() const;
        WEBKIT_EXPORT bool isMultiple() const;

        WEBKIT_EXPORT WebNodeCollection dataListOptions() const;

        // Return the localized value for this input type.
        WEBKIT_EXPORT WebString localizeValue(const WebString&) const;

        WEBKIT_EXPORT bool isSpeechInputEnabled() const;
        WEBKIT_EXPORT SpeechInputState getSpeechInputState() const;
        WEBKIT_EXPORT void startSpeechInput();
        WEBKIT_EXPORT void stopSpeechInput();

        // Exposes the default value of the maxLength attribute.
        WEBKIT_EXPORT static int defaultMaxLength();

        // Return the decoration added by the specified decorator if one exists.
        WEBKIT_EXPORT WebElement decorationElementFor(WebTextFieldDecoratorClient*);

#if WEBKIT_IMPLEMENTATION
        WebInputElement(const WTF::PassRefPtr<WebCore::HTMLInputElement>&);
        WebInputElement& operator=(const WTF::PassRefPtr<WebCore::HTMLInputElement>&);
        operator WTF::PassRefPtr<WebCore::HTMLInputElement>() const;
#endif
    };

    WEBKIT_EXPORT WebInputElement* toWebInputElement(WebElement*);

    inline const WebInputElement* toWebInputElement(const WebElement* element)
    {
        return toWebInputElement(const_cast<WebElement*>(element));
    }

} // namespace WebKit

#endif