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
|
/***************************************************************************
* 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 KTOOLTIPITEM_H
#define KTOOLTIPITEM_H
#include <QVariant>
class QString;
class QIcon;
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;
};
#endif
|
