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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/***************************************************************************
* Copyright (C) 2008 by Fredrik Höglund <[email protected]> *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef KTOOLTIP_H
#define KTOOLTIP_H
#include <QObject>
#include <QPalette>
#include <QFont>
#include <QRect>
#include <QStyle>
#include <QFontMetrics>
class QString;
class QIcon;
class QSize;
class QPainter;
class QRegion;
class KToolTipItemPrivate;
/**
* KToolTipItem contains the data to be displayed in a tooltip.
*
* Custom data can be stored as QVariants in the object by calling
* setData() with a custom item role, and retrieved and displayed
* by a tooltip delegate by calling data().
*
* The default tooltip delegate uses Qt::DecorationRole and
* Qt::DisplayRole.
*
* To display the tooltip, call KToolTip::showTip() with a pointer
* to the KToolTipItem.
*
* You can reimplement the setData() and/or data() methods in this
* class to implement on-demand loading of data.
*/
class KToolTipItem
{
public:
enum ItemType { DefaultType, UserType = 1000 };
/**
* Creates a KToolTipItem with @p text and no icon.
*/
explicit KToolTipItem(const QString &text, int type = DefaultType);
/**
* Creates a KToolTipItem with an @p icon and @p text.
*/
KToolTipItem(const QIcon &icon, const QString &text, int type = DefaultType);
/**
* Destroys the KToolTipItem.
*/
virtual ~KToolTipItem();
/**
* Returns the item type.
*/
int type() const;
QString text() const;
QIcon icon() const;
virtual QVariant data(int role) const;
virtual void setData(int role, const QVariant &data);
private:
KToolTipItemPrivate * const d;
};
class KStyleOptionToolTip
{
public:
KStyleOptionToolTip();
enum Corner { TopLeftCorner, TopRightCorner, BottomLeftCorner, BottomRightCorner, NoCorner };
Qt::LayoutDirection direction;
QFontMetrics fontMetrics;
QPalette palette;
QRect rect;
QStyle::State state;
QFont font;
QSize decorationSize;
Corner activeCorner;
};
/**
* KToolTipDelegate is responsible for providing the size hint and
* painting the tooltips.
*/
class KToolTipDelegate : public QObject
{
Q_OBJECT
public:
KToolTipDelegate();
virtual ~KToolTipDelegate();
virtual QSize sizeHint(const KStyleOptionToolTip *option, const KToolTipItem *item) const;
/**
* If haveAlphaChannel() returns true, the paint device will be filled with
* Qt::transparent when this function is called, otherwise the content is
* undefined.
*/
virtual void paint(QPainter *painter, const KStyleOptionToolTip *option,
const KToolTipItem *item) const;
/**
* Reimplement this function to specify the region of the tooltip
* that accepts input. Any mouse events that occur outside this
* region will be sent to the widget below the tooltip.
*
* The default implementation returns a region containing the
* bounding rect of the tooltip.
*
* This function will only be called if haveAlphaChannel()
* returns true.
*/
virtual QRegion inputShape(const KStyleOptionToolTip *option) const;
/**
* Reimplement this function to specify a shape mask for the tooltip.
*
* The default implementation returns a region containing the
* bounding rect of the tooltip.
*
* This function will only be called if haveAlphaChannel()
* returns false.
*/
virtual QRegion shapeMask(const KStyleOptionToolTip *option) const;
protected:
/**
* Returns true if the tooltip has an alpha channel, and false
* otherwise.
*
* Implementors should assume that this condition may change at
* any time during the runtime of the application, as compositing
* can be enabled or disabled in the window manager.
*/
bool haveAlphaChannel() const;
#if 0
private Q_SLOTS:
/**
* Schedules a repaint of the tooltip item.
* This slot can be connected to a timer to animate the tooltip.
*/
void update(const KToolTipItem *item);
#endif
};
/**
* KToolTip provides customizable tooltips that can have animations as well as an alpha
* channel, allowing for dynamic transparency effects.
*
* ARGB tooltips work on X11 even when the application isn't using the ARGB visual.
*/
namespace KToolTip
{
void showText(const QPoint &pos, const QString &text, QWidget *widget, const QRect &rect);
void showText(const QPoint &pos, const QString &text, QWidget *widget = 0);
/**
* Shows the tip @p item at the global position indicated by @p pos.
*
* Ownership of the item is transferred to KToolTip. The item will be deleted
* automatically when it is hidden.
*
* The tip is shown immediately when this function is called.
*/
void showTip(const QPoint &pos, KToolTipItem *item);
void hideTip();
void setToolTipDelegate(KToolTipDelegate *delegate);
}
#endif
|
