Reviewed by Eric. Landed by rwlbuis.
[WebKit-https.git] / WebCore / platform / ListBox.h
1 /*
2  * Copyright (C) 2004, 2006 Apple Computer, 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ListBox_h
27 #define ListBox_h
28
29 #include "DeprecatedValueList.h"
30 #include "DeprecatedString.h"
31 #include "ScrollView.h"
32 #include "TextDirection.h"
33
34 #if PLATFORM(QT)
35 class QListWidget;
36 #endif
37
38 namespace WebCore {
39
40 enum ListBoxItemType {
41     ListBoxOption,
42     ListBoxGroupLabel,
43     ListBoxSeparator
44 };
45
46 struct ListBoxItem
47 {
48     DeprecatedString string;
49     ListBoxItemType type;
50     bool enabled;
51     
52     ListBoxItem(const DeprecatedString &s, ListBoxItemType t, bool e) : string(s), type(t), enabled(e) { }
53 };
54
55 class ListBox : public ScrollView {
56 public:
57     enum SelectionMode { Single, Extended };
58
59     ListBox();
60     ~ListBox();
61
62     IntSize sizeForNumberOfLines(int numLines) const;
63     
64     unsigned count() const { return _items.count(); }
65
66     void setSelectionMode(SelectionMode);
67
68     void clear();
69     void appendItem(const DeprecatedString &s, bool enabled) { appendItem(s, ListBoxOption, enabled); }
70     void appendGroupLabel(const DeprecatedString &s, bool enabled) { appendItem(s, ListBoxGroupLabel, enabled); }
71     void doneAppendingItems();
72
73     void setSelected(int, bool);
74     bool isSelected(int) const;
75
76     void setEnabled(bool enabled);
77     bool isEnabled();
78     
79     const ListBoxItem &itemAtIndex(int index) const { return _items[index]; }
80     
81     void setWritingDirection(TextDirection);
82     
83     bool changingSelection() { return _changingSelection; }
84
85     virtual FocusPolicy focusPolicy() const;
86     virtual bool checksDescendantsForFocus() const;
87     
88     static void clearCachedTextRenderers();
89     void setFont(const Font&);
90
91 #if PLATFORM(QT)
92     virtual void setParentWidget(QWidget*);
93 #endif
94
95 private:
96 #if PLATFORM(QT)
97     QListWidget* m_listWidget;
98     SelectionMode m_selectionMode;
99 #endif
100
101     void appendItem(const DeprecatedString &, ListBoxItemType, bool);
102
103     // A Vector<ListBoxItem> might be more efficient for large lists.
104     DeprecatedValueList<ListBoxItem> _items;
105
106     bool _changingSelection;
107     bool _enabled;
108
109     mutable float _width;
110     mutable bool _widthGood;
111 };
112
113 }
114
115 #endif