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
|
/*******************************************************************
Copyright 2007 Dmitry Suzdalev <dimsuz@gmail.com>
This library 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 K_GAME_POPUP_ITEM_H
#define K_GAME_POPUP_ITEM_H
#include <libkdegames_export.h>
#include <QtGui/QGraphicsPathItem>
#include <QtCore/QObject>
class KGamePopupItemPrivate;
/**
* \class KGamePopupItem kgamepopupitem.h <KGamePopupItem>
*
* QGraphicsItem capable of showing short popup messages
* which do not interrupt the gameplay.
* Message can stay on screen for specified amount of time
* and automatically hide after (unless user hovers it with mouse).
*
* Example of use:
* \code
* KGamePopupItem *messageItem = new KGamePopupItem();
* myGraphicsScene->addItem(messageItem);
* ...
* messageItem->setMessageTimeout( 3000 ); // 3 sec
* messageItem->showMessage("Hello, I'm a game message! How do you do?", BottomLeft);
* \endcode
*/
class KDEGAMES_EXPORT KGamePopupItem : public QObject, public QGraphicsItem
{
Q_OBJECT
Q_INTERFACES(QGraphicsItem)
public:
/**
* Possible values for message showing mode in respect to a previous
* message
*/
enum ReplaceMode { LeavePrevious, ReplacePrevious };
/**
* Possible values for the popup angles sharpness
*/
enum Sharpness { Square=0, Sharp=2, Soft=5, Softest=10 };
/**
* The possible places in the scene where a message can be shown
*/
enum Position { TopLeft, TopRight, BottomLeft, BottomRight, Center };
/**
* Constructs a message item. It is hidden by default.
*/
KGamePopupItem(QGraphicsItem * parent = 0);
/**
* Destructs a message item
*/
~KGamePopupItem();
/**
* Shows the message: item will appear at specified place
* of the scene using simple animation
* Item will be automatically hidden after timeout set in setMessageTimeOut() passes
* If item is hovered with mouse it won't hide until user moves
* the mouse away
*
* Note that if pos == Center, message animation will be of fade in/out type,
* rather than slide in/out
*
* @param text holds the message to show
* @param pos position on the scene where the message will appear
* @param mode how to handle an already shown message by this item:
either leave it and ignore the new one or replace it
*/
void showMessage( const QString& text, Position pos, ReplaceMode mode = LeavePrevious);
/**
* Sets the amount of time the item will stay visible on screen
* before it goes away.
* By default item is shown for 2000 msec
* If item is hovered with mouse it will hide only after
* user moves the mouse away
*
* @param msec amount of time in milliseconds.
* if msec is 0, then message will stay visible until it
* gets explicitly hidden by forceHide()
*/
void setMessageTimeout( int msec );
/**
* @return timeout that is currently set
*/
int messageTimeout() const;
/**
* Sets the message opacity from 0 (fully transparent) to 1 (fully opaque)
* For example 0.5 is half transparent
* It defaults to 1.0
*/
void setMessageOpacity( qreal opacity );
/**
* @return current message opacity
*/
qreal messageOpacity() const;
/**
* Sets custom pixmap to show instead of default icon on the left
*/
void setMessageIcon( const QPixmap& pix );
/**
* Sets whether to hide this popup item on mouse click.
* By default a mouse click will cause an item to hide
*/
void setHideOnMouseClick( bool hide );
/**
* @return whether this popup item hides on mouse click.
*/
bool hidesOnMouseClick() const;
/**
* Used to specify how to hide in forceHide() - instantly or animatedly
*/
enum HideType { InstantHide, AnimatedHide };
/**
* Requests the item to be hidden immediately.
*/
void forceHide(HideType type=AnimatedHide);
/**
* Sets brush used to paint item backgound
* By default system-default brush is used
* @see KColorScheme
*/
void setBackgroundBrush( const QBrush& brush );
/**
* Sets default color for unformatted text
* By default system-default color is used
* @see KColorScheme
*/
void setTextColor( const QColor& color );
/**
* @return the bounding rect of this item. Reimplemented from QGraphicsItem
*/
virtual QRectF boundingRect() const;
/**
* Paints item. Reimplemented from QGraphicsItem
*/
virtual void paint( QPainter* p, const QStyleOptionGraphicsItem *option, QWidget* widget );
/**
* Sets the popup angles sharpness
*/
void setSharpness( Sharpness sharpness );
/**
* @return current popup angles sharpness
*/
Sharpness sharpness() const;
Q_SIGNALS:
/**
* Emitted when user clicks on a link in item
*/
void linkActivated( const QString& link );
/**
* Emitted when user hovers a link in item
*/
void linkHovered( const QString& link );
/**
* Emitted when the popup finishes hiding. This includes hiding caused by
* both timeouts and mouse clicks.
*/
void hidden();
private Q_SLOTS:
void animationFrame(int);
void hideMe();
void playHideAnimation();
void onLinkHovered(const QString&);
void onTextItemClicked();
private:
void setupTimeline();
virtual void mousePressEvent( QGraphicsSceneMouseEvent* );
virtual void mouseReleaseEvent( QGraphicsSceneMouseEvent* );
virtual void hoverEnterEvent( QGraphicsSceneHoverEvent* );
virtual void hoverLeaveEvent( QGraphicsSceneHoverEvent* );
KGamePopupItemPrivate * const d;
};
#endif
|