1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_VIEWS_TOOLTIP_MANAGER_H_
#define CHROME_VIEWS_TOOLTIP_MANAGER_H_
#include <windows.h>
#include <string>
#include "base/basictypes.h"
class ChromeFont;
namespace views {
class View;
class Widget;
// TooltipManager takes care of the wiring to support tooltips for Views.
// This class is intended to be used by Widgets. To use this, you must
// do the following:
// Add the following to your MSG_MAP:
//
// MESSAGE_RANGE_HANDLER(WM_MOUSEFIRST, WM_MOUSELAST, OnMouseRange)
// MESSAGE_RANGE_HANDLER(WM_NCMOUSEMOVE, WM_NCMOUSEMOVE, OnMouseRange)
// MSG_WM_NOTIFY(OnNotify)
//
// With the following implementations:
// LRESULT XXX::OnMouseRange(UINT u_msg, WPARAM w_param, LPARAM l_param,
// BOOL& handled) {
// tooltip_manager_->OnMouse(u_msg, w_param, l_param);
// handled = FALSE;
// return 0;
// }
//
// LRESULT XXX::OnNotify(int w_param, NMHDR* l_param) {
// bool handled;
// LRESULT result = tooltip_manager_->OnNotify(w_param, l_param, &handled);
// SetMsgHandled(handled);
// return result;
// }
//
// And of course you'll need to create the TooltipManager!
//
// Lastly, you'll need to override GetTooltipManager.
//
// See XPFrame for an example of this in action.
class TooltipManager {
public:
// Returns the height of tooltips. This should only be invoked from within
// GetTooltipTextOrigin.
static int GetTooltipHeight();
// Returns the default font used by tooltips.
static ChromeFont GetDefaultFont();
// Returns the separator for lines of text in a tooltip.
static const std::wstring& GetLineSeparator();
// Creates a TooltipManager for the specified Widget and parent window.
TooltipManager(Widget* widget, HWND parent);
virtual ~TooltipManager();
// Notification that the view hierarchy has changed in some way.
void UpdateTooltip();
// Invoked when the tooltip text changes for the specified views.
void TooltipTextChanged(View* view);
// Invoked when toolbar icon gets focus.
void ShowKeyboardTooltip(View* view);
// Invoked when toolbar loses focus.
void HideKeyboardTooltip();
// Message handlers. These forward to the tooltip control.
virtual void OnMouse(UINT u_msg, WPARAM w_param, LPARAM l_param);
LRESULT OnNotify(int w_param, NMHDR* l_param, bool* handled);
// Not used directly by TooltipManager, but provided for AeroTooltipManager.
virtual void OnMouseLeave() {}
protected:
virtual void Init();
// Updates the tooltip for the specified location.
void UpdateTooltip(int x, int y);
// Parent window the tooltip is added to.
HWND parent_;
// Tooltip control window.
HWND tooltip_hwnd_;
// Tooltip information.
TOOLINFO toolinfo_;
// Last location of the mouse. This is in the coordinates of the rootview.
int last_mouse_x_;
int last_mouse_y_;
// Whether or not the tooltip is showing.
bool tooltip_showing_;
private:
// Sets the tooltip position based on the x/y position of the text. If the
// tooltip fits, true is returned.
bool SetTooltipPosition(int text_x, int text_y);
// Calculates the preferred height for tooltips. This always returns a
// positive value.
int CalcTooltipHeight();
// Trims the tooltip to fit, setting text to the clipped result, width to the
// width (in pixels) of the clipped text and line_count to the number of lines
// of text in the tooltip.
void TrimTooltipToFit(std::wstring* text,
int* width,
int* line_count,
int position_x,
int position_y,
HWND window);
// Invoked when the timer elapses and tooltip has to be destroyed.
void DestroyKeyboardTooltipWindow(HWND window_to_destroy);
// Hosting Widget.
Widget* widget_;
// The View the mouse is under. This is null if the mouse isn't under a
// View.
View* last_tooltip_view_;
// Whether or not the view under the mouse needs to be refreshed. If this
// is true, when the tooltip is asked for the view under the mouse is
// refreshed.
bool last_view_out_of_sync_;
// Text for tooltip from the view.
std::wstring tooltip_text_;
// The clipped tooltip.
std::wstring clipped_text_;
// Number of lines in the tooltip.
int line_count_;
// Width of the last tooltip.
int tooltip_width_;
// Height for a tooltip; lazily calculated.
static int tooltip_height_;
// control window for tooltip displayed using keyboard.
HWND keyboard_tooltip_hwnd_;
// Used to register DestroyTooltipWindow function with postdelayedtask
// function.
ScopedRunnableMethodFactory<TooltipManager> keyboard_tooltip_factory_;
DISALLOW_EVIL_CONSTRUCTORS(TooltipManager);
};
} // namespace views
#endif // CHROME_VIEWS_TOOLTIP_MANAGER_H_
|
