cfd471a63d5353bc6040e8e188c4d0851cb16dc5
[WebKit.git] / WebCore / html / HTMLTextAreaElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef HTMLTextAreaElement_h
25 #define HTMLTextAreaElement_h
26
27 #include "HTMLFormControlElement.h"
28
29 namespace WebCore {
30
31 class BeforeTextInsertedEvent;
32 class VisibleSelection;
33
34 class HTMLTextAreaElement : public HTMLTextFormControlElement {
35 public:
36     HTMLTextAreaElement(const QualifiedName&, Document*, HTMLFormElement* = 0);
37
38     virtual bool checkDTD(const Node* newChild) { return newChild->isTextNode(); }
39
40     int cols() const { return m_cols; }
41     int rows() const { return m_rows; }
42
43     bool shouldWrapText() const { return m_wrap != NoWrap; }
44
45     virtual bool isEnumeratable() const { return true; }
46
47     virtual const AtomicString& formControlType() const;
48
49     virtual bool saveFormControlState(String& value) const;
50     virtual void restoreFormControlState(const String&);
51
52     bool readOnly() const { return isReadOnlyFormControl(); }
53
54     virtual bool isTextFormControl() const { return true; }
55
56     virtual bool valueMissing() const { return isRequiredFormControl() && !disabled() && !readOnly() && value().isEmpty(); }
57
58     int selectionStart();
59     int selectionEnd();
60
61     void setSelectionStart(int);
62     void setSelectionEnd(int);
63
64     void select();
65     void setSelectionRange(int, int);
66
67     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
68     virtual void parseMappedAttribute(MappedAttribute*);
69     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
70     virtual bool appendFormData(FormDataList&, bool);
71     virtual void reset();
72     virtual void defaultEventHandler(Event*);
73     virtual bool isMouseFocusable() const;
74     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
75     virtual void updateFocusAppearance(bool restorePreviousSelection);
76
77     String value() const;
78     void setValue(const String&);
79     String defaultValue() const;
80     void setDefaultValue(const String&);
81     int textLength() const { return value().length(); }
82     int maxLength() const;
83     void setMaxLength(int, ExceptionCode&);
84     
85     void rendererWillBeDestroyed();
86     
87     virtual void accessKeyAction(bool sendToAnyElement);
88     
89     const AtomicString& accessKey() const;
90     void setAccessKey(const String&);
91
92     void setCols(int);
93     void setRows(int);
94     
95     void cacheSelection(int s, int e) { m_cachedSelectionStart = s; m_cachedSelectionEnd = e; };
96     VisibleSelection selection() const;
97
98     virtual bool shouldUseInputMethod() const;
99
100 private:
101     enum WrapMethod { NoWrap, SoftWrap, HardWrap };
102
103     void handleBeforeTextInsertedEvent(BeforeTextInsertedEvent*) const;
104     static String sanitizeUserInputValue(const String&, unsigned maxLength);
105     void updateValue() const;
106
107     virtual bool supportsPlaceholder() const { return true; }
108     virtual bool isEmptyValue() const { return value().isEmpty(); }
109
110     virtual bool isOptionalFormControl() const { return !isRequiredFormControl(); }
111     virtual bool isRequiredFormControl() const { return required(); }
112
113     int m_rows;
114     int m_cols;
115     WrapMethod m_wrap;
116     mutable String m_value;
117     int m_cachedSelectionStart;
118     int m_cachedSelectionEnd;
119 };
120
121 } //namespace
122
123 #endif