Reviewed by Adam.
[WebKit-https.git] / WebCore / platform / PopupMenu.h
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  *
19  */
20
21 #ifndef POPUPMENU_H
22 #define POPUPMENU_H
23
24 #include "Shared.h"
25
26 #include "IntRect.h"
27 #include <wtf/PassRefPtr.h>
28
29 #if PLATFORM(MAC)
30 #include "RetainPtr.h"
31 #ifdef __OBJC__
32 @class NSPopUpButtonCell;
33 #else
34 class NSPopUpButtonCell;
35 #endif
36 #elif PLATFORM(WIN)
37 typedef struct HWND__* HWND;
38 typedef struct HDC__* HDC;
39 typedef struct HBITMAP__* HBITMAP;
40 #endif
41
42 namespace WebCore {
43
44 class Document;
45 class FrameView;
46 class String;
47 class RenderStyle;
48
49 class PopupMenuClient {
50 public:
51     virtual ~PopupMenuClient() {}
52     virtual void valueChanged(unsigned listIndex, bool fireEvents = true) = 0;
53
54     virtual String itemText(unsigned listIndex) const = 0;
55     virtual bool itemIsEnabled(unsigned listIndex) const = 0;
56     virtual RenderStyle* itemStyle(unsigned listIndex) const = 0;
57     virtual RenderStyle* clientStyle() const = 0;
58     virtual Document* clientDocument() const = 0;
59     virtual int clientPaddingLeft() const = 0;
60     virtual int clientPaddingRight() const = 0;
61     virtual int listSize() const = 0;
62     virtual int selectedIndex() const = 0;
63     virtual void hidePopup() = 0;
64     virtual bool itemIsSeparator(unsigned listIndex) const = 0;
65     virtual bool itemIsLabel(unsigned listIndex) const = 0;
66     virtual bool itemIsSelected(unsigned listIndex) const = 0;
67     virtual bool shouldPopOver() const = 0;
68     virtual void setTextFromItem(unsigned listIndex) = 0;
69 };
70
71 class PopupMenu : public Shared<PopupMenu> {
72 public:
73     static PassRefPtr<PopupMenu> create(PopupMenuClient* client) { return new PopupMenu(client); }
74     ~PopupMenu();
75     
76     void disconnectClient() { m_popupClient = 0; }
77
78     void show(const IntRect&, FrameView*, int index);
79     void hide();
80
81     void updateFromElement();
82     
83     PopupMenuClient* client() const { return m_popupClient; }
84
85 #if PLATFORM(WIN)
86     bool up(unsigned lines = 1);
87     bool down(unsigned lines = 1);
88
89     int itemHeight() const { return m_itemHeight; }
90     const IntRect& windowRect() const { return m_windowRect; }
91     IntRect clientRect() const;
92
93     int listIndexAtPoint(const IntPoint& point) { return (point.y() + m_scrollOffset) / m_itemHeight; }
94
95     bool setFocusedIndex(int index, bool setControlText = true, bool fireOnChange = false);
96     int focusedIndex() const;
97     void focusFirst();
98     void focusLast();
99
100     void paint(const IntRect& damageRect, HDC hdc = 0);
101
102     HWND popupHandle() const { return m_popup; }
103
104     void setWasClicked(bool b = true) { m_wasClicked = b; }
105     bool wasClicked() const { return m_wasClicked; }
106
107     void setScrollOffset(int offset) { m_scrollOffset = offset; }
108     int scrollOffset() const { return m_scrollOffset; }
109
110     bool scrollTo(int);
111     bool scrollToRevealSelection();
112
113     void incrementWheelDelta(int delta);
114     void reduceWheelDelta(int delta);
115     int wheelDelta() const { return m_wheelDelta; }
116 #endif
117
118 protected:
119     PopupMenu(PopupMenuClient* client);
120     
121 private:
122     PopupMenuClient* m_popupClient;
123     
124 #if PLATFORM(MAC)
125     void clear();
126     void populate();
127
128     RetainPtr<NSPopUpButtonCell> m_popup;
129 #elif PLATFORM(WIN)
130     void calculatePositionAndSize(const IntRect&, FrameView*);
131     void invalidateItem(int index);
132
133     HWND m_popup;
134     HDC m_DC;
135     HBITMAP m_bmp;
136     bool m_wasClicked;
137     IntRect m_windowRect;
138     int m_itemHeight;
139     int m_scrollOffset;
140     int m_wheelDelta;
141 #endif
142
143 };
144
145 }
146
147 #endif