KGamePopupItem Class Reference

#include <KGamePopupItem>

Inheritance diagram for KGamePopupItem:

Public Types
enum	HideType { InstantHide, AnimatedHide }
enum	Position {   TopLeft, TopRight, BottomLeft, BottomRight,   Center }
enum	ReplaceMode { LeavePrevious, ReplacePrevious }
enum	Sharpness { Square =0, Sharp =2, Soft =5, Softest =10 }

Signals
void	hidden ()
void	linkActivated (const QString &link)
void	linkHovered (const QString &link)

Public Member Functions
	KGamePopupItem (QGraphicsItem *parent=0)
	~KGamePopupItem ()
virtual QRectF	boundingRect () const
void	forceHide (HideType type=AnimatedHide)
bool	hidesOnMouseClick () const
qreal	messageOpacity () const
int	messageTimeout () const
virtual void	paint (QPainter *p, const QStyleOptionGraphicsItem *option, QWidget *widget)
void	setBackgroundBrush (const QBrush &brush)
void	setHideOnMouseClick (bool hide)
void	setMessageIcon (const QPixmap &pix)
void	setMessageOpacity (qreal opacity)
void	setMessageTimeout (int msec)
void	setSharpness (Sharpness sharpness)
void	setTextColor (const QColor &color)
Sharpness	sharpness () const
void	showMessage (const QString &text, Position pos, ReplaceMode mode=LeavePrevious)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const
Public Member Functions inherited from QGraphicsItem
	QGraphicsItem (QGraphicsItem *parent)
virtual	~QGraphicsItem ()
bool	acceptDrops () const
Qt::MouseButtons	acceptedMouseButtons () const
bool	acceptHoverEvents () const
bool	acceptsHoverEvents () const
bool	acceptTouchEvents () const
virtual void	advance (int phase)
virtual QRectF	boundingRect () const =0
QRegion	boundingRegion (const QTransform &itemToDeviceTransform) const
qreal	boundingRegionGranularity () const
CacheMode	cacheMode () const
QList< QGraphicsItem * >	childItems () const
QList< QGraphicsItem * >	children () const
QRectF	childrenBoundingRect () const
void	clearFocus ()
QPainterPath	clipPath () const
virtual bool	collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode) const
virtual bool	collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode) const
QList< QGraphicsItem * >	collidingItems (Qt::ItemSelectionMode mode) const
QGraphicsItem *	commonAncestorItem (const QGraphicsItem *other) const
virtual bool	contains (const QPointF &point) const
QCursor	cursor () const
QVariant	data (int key) const
QTransform	deviceTransform (const QTransform &viewportTransform) const
qreal	effectiveOpacity () const
void	ensureVisible (const QRectF &rect, int xmargin, int ymargin)
void	ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)
bool	filtersChildEvents () const
GraphicsItemFlags	flags () const
QGraphicsItem *	focusItem () const
QGraphicsItem *	focusProxy () const
void	grabKeyboard ()
void	grabMouse ()
QGraphicsEffect *	graphicsEffect () const
QGraphicsItemGroup *	group () const
bool	handlesChildEvents () const
bool	hasCursor () const
bool	hasFocus () const
void	hide ()
Qt::InputMethodHints	inputMethodHints () const
void	installSceneEventFilter (QGraphicsItem *filterItem)
bool	isActive () const
bool	isAncestorOf (const QGraphicsItem *child) const
bool	isBlockedByModalPanel (QGraphicsItem **blockingPanel) const
bool	isClipped () const
bool	isEnabled () const
bool	isObscured () const
bool	isObscured (const QRectF &rect) const
bool	isObscured (qreal x, qreal y, qreal w, qreal h) const
virtual bool	isObscuredBy (const QGraphicsItem *item) const
bool	isPanel () const
bool	isSelected () const
bool	isUnderMouse () const
bool	isVisible () const
bool	isVisibleTo (const QGraphicsItem *parent) const
bool	isWidget () const
bool	isWindow () const
QTransform	itemTransform (const QGraphicsItem *other, bool *ok) const
QPointF	mapFromItem (const QGraphicsItem *item, const QPointF &point) const
QPolygonF	mapFromItem (const QGraphicsItem *item, const QRectF &rect) const
QPolygonF	mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const
QPainterPath	mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const
QPointF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const
QPolygonF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
QPointF	mapFromParent (const QPointF &point) const
QPolygonF	mapFromParent (const QRectF &rect) const
QPolygonF	mapFromParent (const QPolygonF &polygon) const
QPainterPath	mapFromParent (const QPainterPath &path) const
QPointF	mapFromParent (qreal x, qreal y) const
QPolygonF	mapFromParent (qreal x, qreal y, qreal w, qreal h) const
QPolygonF	mapFromScene (const QPolygonF &polygon) const
QPointF	mapFromScene (const QPointF &point) const
QPolygonF	mapFromScene (const QRectF &rect) const
QPainterPath	mapFromScene (const QPainterPath &path) const
QPointF	mapFromScene (qreal x, qreal y) const
QPolygonF	mapFromScene (qreal x, qreal y, qreal w, qreal h) const
QRectF	mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const
QRectF	mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
QRectF	mapRectFromParent (const QRectF &rect) const
QRectF	mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const
QRectF	mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const
QRectF	mapRectFromScene (const QRectF &rect) const
QRectF	mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const
QRectF	mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
QRectF	mapRectToParent (const QRectF &rect) const
QRectF	mapRectToParent (qreal x, qreal y, qreal w, qreal h) const
QRectF	mapRectToScene (const QRectF &rect) const
QRectF	mapRectToScene (qreal x, qreal y, qreal w, qreal h) const
QPointF	mapToItem (const QGraphicsItem *item, const QPointF &point) const
QPolygonF	mapToItem (const QGraphicsItem *item, const QRectF &rect) const
QPolygonF	mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const
QPainterPath	mapToItem (const QGraphicsItem *item, const QPainterPath &path) const
QPointF	mapToItem (const QGraphicsItem *item, qreal x, qreal y) const
QPolygonF	mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
QPointF	mapToParent (const QPointF &point) const
QPolygonF	mapToParent (const QRectF &rect) const
QPainterPath	mapToParent (const QPainterPath &path) const
QPointF	mapToParent (qreal x, qreal y) const
QPolygonF	mapToParent (qreal x, qreal y, qreal w, qreal h) const
QPolygonF	mapToParent (const QPolygonF &polygon) const
QPolygonF	mapToScene (const QRectF &rect) const
QPainterPath	mapToScene (const QPainterPath &path) const
QPointF	mapToScene (qreal x, qreal y) const
QPolygonF	mapToScene (qreal x, qreal y, qreal w, qreal h) const
QPolygonF	mapToScene (const QPolygonF &polygon) const
QPointF	mapToScene (const QPointF &point) const
QMatrix	matrix () const
void	moveBy (qreal dx, qreal dy)
qreal	opacity () const
virtual QPainterPath	opaqueArea () const
virtual void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)=0
QGraphicsItem *	panel () const
PanelModality	panelModality () const
QGraphicsItem *	parentItem () const
QGraphicsObject *	parentObject () const
QGraphicsWidget *	parentWidget () const
QPointF	pos () const
void	removeSceneEventFilter (QGraphicsItem *filterItem)
void	resetMatrix ()
void	resetTransform ()
void	rotate (qreal angle)
qreal	rotation () const
void	scale (qreal sx, qreal sy)
qreal	scale () const
QGraphicsScene *	scene () const
QRectF	sceneBoundingRect () const
QMatrix	sceneMatrix () const
QPointF	scenePos () const
QTransform	sceneTransform () const
void	scroll (qreal dx, qreal dy, const QRectF &rect)
void	setAcceptDrops (bool on)
void	setAcceptedMouseButtons (QFlags< Qt::MouseButton > buttons)
void	setAcceptHoverEvents (bool enabled)
void	setAcceptsHoverEvents (bool enabled)
void	setAcceptTouchEvents (bool enabled)
void	setActive (bool active)
void	setBoundingRegionGranularity (qreal granularity)
void	setCacheMode (CacheMode mode, const QSize &logicalCacheSize)
void	setCursor (const QCursor &cursor)
void	setData (int key, const QVariant &value)
void	setEnabled (bool enabled)
void	setFiltersChildEvents (bool enabled)
void	setFlag (GraphicsItemFlag flag, bool enabled)
void	setFlags (QFlags< QGraphicsItem::GraphicsItemFlag > flags)
void	setFocus (Qt::FocusReason focusReason)
void	setFocusProxy (QGraphicsItem *item)
void	setGraphicsEffect (QGraphicsEffect *effect)
void	setGroup (QGraphicsItemGroup *group)
void	setHandlesChildEvents (bool enabled)
void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)
void	setMatrix (const QMatrix &matrix, bool combine)
void	setOpacity (qreal opacity)
void	setPanelModality (PanelModality panelModality)
void	setParentItem (QGraphicsItem *newParent)
void	setPos (const QPointF &pos)
void	setPos (qreal x, qreal y)
void	setRotation (qreal angle)
void	setScale (qreal factor)
void	setSelected (bool selected)
void	setToolTip (const QString &toolTip)
void	setTransform (const QTransform &matrix, bool combine)
void	setTransformations (const QList< QGraphicsTransform * > &transformations)
void	setTransformOriginPoint (qreal x, qreal y)
void	setTransformOriginPoint (const QPointF &origin)
void	setVisible (bool visible)
void	setX (qreal x)
void	setY (qreal y)
void	setZValue (qreal z)
virtual QPainterPath	shape () const
void	shear (qreal sh, qreal sv)
void	show ()
void	stackBefore (const QGraphicsItem *sibling)
QGraphicsObject *	toGraphicsObject ()
const QGraphicsObject *	toGraphicsObject () const
QString	toolTip () const
QGraphicsItem *	topLevelItem () const
QGraphicsWidget *	topLevelWidget () const
QTransform	transform () const
QList< QGraphicsTransform * >	transformations () const
QPointF	transformOriginPoint () const
void	translate (qreal dx, qreal dy)
virtual int	type () const
void	ungrabKeyboard ()
void	ungrabMouse ()
void	unsetCursor ()
void	update (qreal x, qreal y, qreal width, qreal height)
void	update (const QRectF &rect)
QGraphicsWidget *	window () const
qreal	x () const
qreal	y () const
qreal	zValue () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QGraphicsItem
typedef	GraphicsItemFlags
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Protected Member Functions inherited from QGraphicsItem
virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)
virtual void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)
virtual void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)
virtual void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)
virtual void	dropEvent (QGraphicsSceneDragDropEvent *event)
virtual void	focusInEvent (QFocusEvent *event)
virtual void	focusOutEvent (QFocusEvent *event)
virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)
virtual void	inputMethodEvent (QInputMethodEvent *event)
virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const
virtual QVariant	itemChange (GraphicsItemChange change, const QVariant &value)
virtual void	keyPressEvent (QKeyEvent *event)
virtual void	keyReleaseEvent (QKeyEvent *event)
virtual void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)
virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)
void	prepareGeometryChange ()
virtual bool	sceneEvent (QEvent *event)
virtual bool	sceneEventFilter (QGraphicsItem *watched, QEvent *event)
void	updateMicroFocus ()
virtual void	wheelEvent (QGraphicsSceneWheelEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

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:

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);

Definition at line 45 of file kgamepopupitem.h.

Member Enumeration Documentation

enum KGamePopupItem::HideType

Used to specify how to hide in forceHide() - instantly or animatedly.

Enumerator
InstantHide
AnimatedHide

Definition at line 129 of file kgamepopupitem.h.

enum KGamePopupItem::Position

The possible places in the scene where a message can be shown.

Enumerator
TopLeft
TopRight
BottomLeft
BottomRight
Center

Definition at line 62 of file kgamepopupitem.h.

enum KGamePopupItem::ReplaceMode

Possible values for message showing mode in respect to a previous message.

Enumerator
LeavePrevious
ReplacePrevious

Definition at line 54 of file kgamepopupitem.h.

enum KGamePopupItem::Sharpness

Possible values for the popup angles sharpness.

Enumerator
Square
Sharp
Soft
Softest

Definition at line 58 of file kgamepopupitem.h.

Constructor & Destructor Documentation

KGamePopupItem::KGamePopupItem

(

QGraphicsItem *

parent = 0

)

Constructs a message item.

It is hidden by default.

Definition at line 169 of file kgamepopupitem.cpp.

KGamePopupItem::~KGamePopupItem

(

)

Destructs a message item.

Definition at line 403 of file kgamepopupitem.cpp.

Member Function Documentation

QRectF KGamePopupItem::boundingRect ( ) const

virtual

Returns

the bounding rect of this item. Reimplemented from QGraphicsItem

Definition at line 398 of file kgamepopupitem.cpp.

void KGamePopupItem::forceHide

(

HideType

type = AnimatedHide

)

Requests the item to be hidden immediately.

Definition at line 449 of file kgamepopupitem.cpp.

void KGamePopupItem::hidden ( )

signal

Emitted when the popup finishes hiding.

This includes hiding caused by both timeouts and mouse clicks.

bool KGamePopupItem::hidesOnMouseClick

(

)

const

Returns

whether this popup item hides on mouse click.

Definition at line 387 of file kgamepopupitem.cpp.

void KGamePopupItem::linkActivated ( const QString &  link )

signal

Emitted when user clicks on a link in item.

void KGamePopupItem::linkHovered ( const QString &  link )

signal

Emitted when user hovers a link in item.

qreal KGamePopupItem::messageOpacity

(

)

const

Returns

current message opacity

Definition at line 473 of file kgamepopupitem.cpp.

int KGamePopupItem::messageTimeout

(

)

const

Returns

timeout that is currently set

Definition at line 444 of file kgamepopupitem.cpp.

void KGamePopupItem::paint ( QPainter *  p, const QStyleOptionGraphicsItem *  option, QWidget *  widget  )

virtual

Paints item.

Reimplemented from QGraphicsItem

Definition at line 208 of file kgamepopupitem.cpp.

void KGamePopupItem::setBackgroundBrush

(

const QBrush &

brush

)

Sets brush used to paint item backgound By default system-default brush is used.

See also

KColorScheme

Definition at line 478 of file kgamepopupitem.cpp.

void KGamePopupItem::setHideOnMouseClick

(

bool

hide

)

Sets whether to hide this popup item on mouse click.

By default a mouse click will cause an item to hide

Definition at line 382 of file kgamepopupitem.cpp.

void KGamePopupItem::setMessageIcon

(

const QPixmap &

pix

)

Sets custom pixmap to show instead of default icon on the left.

Definition at line 437 of file kgamepopupitem.cpp.

void KGamePopupItem::setMessageOpacity

(

qreal

opacity

)

Sets the message opacity from 0 (fully transparent) to 1 (fully opaque) For example 0.5 is half transparent It defaults to 1.0.

Definition at line 392 of file kgamepopupitem.cpp.

void KGamePopupItem::setMessageTimeout

(

int

msec

)

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

Parameters

msec	amount of time in milliseconds. if msec is 0, then message will stay visible until it gets explicitly hidden by forceHide()

Definition at line 377 of file kgamepopupitem.cpp.

void KGamePopupItem::setSharpness

(

Sharpness

sharpness

)

Sets the popup angles sharpness.

Definition at line 504 of file kgamepopupitem.cpp.

void KGamePopupItem::setTextColor

(

const QColor &

color

)

Sets default color for unformatted text By default system-default color is used.

See also

KColorScheme

Definition at line 483 of file kgamepopupitem.cpp.

KGamePopupItem::Sharpness KGamePopupItem::sharpness

(

)

const

Returns

current popup angles sharpness

Definition at line 509 of file kgamepopupitem.cpp.

void KGamePopupItem::showMessage	(	const QString &	text,
		Position	pos,
		ReplaceMode	mode = LeavePrevious
	)

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

Parameters

text	holds the message to show
pos	position on the scene where the message will appear
mode	how to handle an already shown message by this item: either leave it and ignore the new one or replace it

Definition at line 234 of file kgamepopupitem.cpp.

---

The documentation for this class was generated from the following files:

• kgamepopupitem.h
• kgamepopupitem.cpp