WebCore:
[WebKit-https.git] / WebCore / html / HTMLSelectElement.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 HTMLSelectElement_h
25 #define HTMLSelectElement_h
26
27 #include "Event.h"
28 #include "HTMLCollection.h"
29 #include "HTMLGenericFormElement.h"
30 #include <wtf/Vector.h>
31
32 namespace WebCore {
33
34 class HTMLOptionElement;
35 class HTMLOptionsCollection;
36 class KeyboardEvent;
37
38 class HTMLSelectElement : public HTMLFormControlElementWithState {
39 public:
40     HTMLSelectElement(Document*, HTMLFormElement* = 0);
41     HTMLSelectElement(const QualifiedName& tagName, Document*, HTMLFormElement* = 0);
42
43     virtual int tagPriority() const { return 6; }
44     virtual bool checkDTD(const Node* newChild);
45
46     virtual const AtomicString& type() const;
47     
48     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
49     virtual bool isMouseFocusable() const;
50     virtual bool canSelectAll() const;
51     virtual void selectAll();
52
53     virtual void recalcStyle(StyleChange);
54
55     virtual void dispatchFocusEvent();
56     virtual void dispatchBlurEvent();
57     
58     virtual bool canStartSelection() const { return false; }
59
60     int selectedIndex() const;
61     void setSelectedIndex(int index, bool deselect = true, bool fireOnChange = false);
62     int lastSelectedListIndex() const;
63
64     virtual bool isEnumeratable() const { return true; }
65
66     unsigned length() const;
67
68     int minWidth() const { return m_minwidth; }
69
70     int size() const { return m_size; }
71
72     bool multiple() const { return m_multiple; }
73
74     void add(HTMLElement* element, HTMLElement* before, ExceptionCode&);
75     void remove(int index);
76
77     String value();
78     void setValue(const String&);
79     
80     PassRefPtr<HTMLOptionsCollection> options();
81
82     virtual bool saveState(String& value) const;
83     virtual void restoreState(const String&);
84
85     virtual bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&);
86     virtual bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&);
87     virtual bool removeChild(Node* child, ExceptionCode&);
88     virtual bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&);
89     virtual bool removeChildren();
90     virtual void childrenChanged();
91
92     virtual void parseMappedAttribute(MappedAttribute*);
93
94     virtual RenderObject* createRenderer(RenderArena*, RenderStyle *);
95     virtual bool appendFormData(FormDataList&, bool);
96
97     // get the actual listbox index of the optionIndexth option
98     int optionToListIndex(int optionIndex) const;
99     // reverse of optionToListIndex - get optionIndex from listboxIndex
100     int listToOptionIndex(int listIndex) const;
101
102     void setRecalcListItems();
103
104     const Vector<HTMLElement*>& listItems() const
105     {
106         if (m_recalcListItems)
107             recalcListItems();
108         else
109             checkListItems();
110         return m_listItems;
111     }
112     virtual void reset();
113
114     virtual void defaultEventHandler(Event*);
115     virtual void accessKeyAction(bool sendToAnyElement);
116
117     void setMultiple(bool);
118
119     void setSize(int);
120
121     void setOption(unsigned index, HTMLOptionElement*, ExceptionCode&);
122     void setLength(unsigned, ExceptionCode&);
123
124     Node* namedItem(const String& name, bool caseSensitive = true);
125     Node* item(unsigned index);
126
127     HTMLCollection::CollectionInfo* collectionInfo() { return &m_collectionInfo; }
128     
129     void setActiveSelectionAnchorIndex(int index);
130     void setActiveSelectionEndIndex(int index) { m_activeSelectionEndIndex = index; }
131     void updateListBoxSelection(bool deselectOtherOptions);
132     void listBoxOnChange();
133     void menuListOnChange();
134     
135     int activeSelectionStartListIndex() const;
136     int activeSelectionEndListIndex() const;
137     
138     void scrollToSelection();
139
140 private:
141     void recalcListItems(bool updateSelectedStates = true) const;
142     void checkListItems() const;
143
144     void deselectItems(HTMLOptionElement* excludeElement = 0);
145     bool usesMenuList() const { return !m_multiple && m_size <= 1; }
146     int nextSelectableListIndex(int startIndex);
147     int previousSelectableListIndex(int startIndex);
148     void menuListDefaultEventHandler(Event*);
149     void listBoxDefaultEventHandler(Event*);
150     void typeAheadFind(KeyboardEvent*);
151     void saveLastSelection();
152
153     mutable Vector<HTMLElement*> m_listItems;
154     Vector<bool> m_cachedStateForActiveSelection;
155     Vector<bool> m_lastOnChangeSelection;
156     int m_minwidth;
157     int m_size;
158     bool m_multiple;
159     mutable bool m_recalcListItems;
160     mutable int m_lastOnChangeIndex;
161
162     int m_activeSelectionAnchorIndex;
163     int m_activeSelectionEndIndex;
164     bool m_activeSelectionState;
165
166     // Instance variables for type-ahead find
167     UChar m_repeatingChar;
168     DOMTimeStamp m_lastCharTime;
169     String m_typedString;
170
171     HTMLCollection::CollectionInfo m_collectionInfo;
172 };
173
174 #ifdef NDEBUG
175
176 inline void HTMLSelectElement::checkListItems() const
177 {
178 }
179
180 #endif
181
182 } // namespace
183
184 #endif