2877302b2dadc9cb0dfc39f2361be0cd5d33be5b
[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 namespace WebCore {
35
36 enum ListBoxItemType {
37     ListBoxOption,
38     ListBoxGroupLabel,
39     ListBoxSeparator
40 };
41
42 struct ListBoxItem
43 {
44     DeprecatedString string;
45     ListBoxItemType type;
46     bool enabled;
47     
48     ListBoxItem(const DeprecatedString &s, ListBoxItemType t, bool e) : string(s), type(t), enabled(e) { }
49 };
50
51 class ListBox : public ScrollView {
52 public:
53     enum SelectionMode { Single, Extended };
54
55     ListBox();
56     ~ListBox();
57
58     IntSize sizeForNumberOfLines(int numLines) const;
59     
60     unsigned count() const { return _items.count(); }
61
62     void setSelectionMode(SelectionMode);
63
64     void clear();
65     void appendItem(const DeprecatedString &s, bool enabled) { appendItem(s, ListBoxOption, enabled); }
66     void appendGroupLabel(const DeprecatedString &s, bool enabled) { appendItem(s, ListBoxGroupLabel, enabled); }
67     void doneAppendingItems();
68
69     void setSelected(int, bool);
70     bool isSelected(int) const;
71
72     void setEnabled(bool enabled);
73     bool isEnabled();
74     
75     const ListBoxItem &itemAtIndex(int index) const { return _items[index]; }
76     
77     void setWritingDirection(TextDirection);
78     
79     bool changingSelection() { return _changingSelection; }
80
81     virtual FocusPolicy focusPolicy() const;
82     virtual bool checksDescendantsForFocus() const;
83     
84     static void clearCachedTextRenderers();
85     void setFont(const Font&);
86
87 private:
88     void appendItem(const DeprecatedString &, ListBoxItemType, bool);
89
90     // A Vector<ListBoxItem> might be more efficient for large lists.
91     DeprecatedValueList<ListBoxItem> _items;
92
93     bool _changingSelection;
94     bool _enabled;
95
96     mutable float _width;
97     mutable bool _widthGood;
98 };
99
100 }
101
102 #endif