libkdegames

KGamePopupItem Class Reference

#include <kgamepopupitem.h>

Inheritance diagram for KGamePopupItem:

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 43 of file kgamepopupitem.h.


Public Types
enum	ReplaceMode { LeavePrevious, ReplacePrevious }
enum	Sharpness { Square = 0, Sharp = 2, Soft = 5, Softest = 10 }
enum	Position { TopLeft, TopRight, BottomLeft, BottomRight, Center }
enum	HideType { InstantHide, AnimatedHide }
Signals
void	linkActivated (const QString &link)
void	linkHovered (const QString &link)
void	hidden ()
Public Member Functions
	KGamePopupItem (QGraphicsItem *parent=0)
	~KGamePopupItem ()
void	showMessage (const QString &text, Position pos, ReplaceMode mode=LeavePrevious)
void	setMessageTimeout (int msec)
int	messageTimeout () const
void	setMessageOpacity (qreal opacity)
qreal	messageOpacity () const
void	setMessageIcon (const QPixmap &pix)
void	forceHide (HideType type=AnimatedHide)
void	setBackgroundBrush (const QBrush &brush)
void	setTextColor (const QColor &color)
virtual QRectF	boundingRect () const
virtual void	paint (QPainter p, const QStyleOptionGraphicsItem option, QWidget *widget)
void	setSharpness (Sharpness sharpness)
Sharpness	sharpness () const

Member Enumeration Documentation

enum KGamePopupItem::ReplaceMode

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

Enumerator:

LeavePrevious
ReplacePrevious

Definition at line 51 of file kgamepopupitem.h.

enum KGamePopupItem::Sharpness

Possible values for the popup angles sharpness.

Enumerator:

Square
Sharp
Soft
Softest

Definition at line 55 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 59 of file kgamepopupitem.h.

enum KGamePopupItem::HideType

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

Enumerator:

InstantHide
AnimatedHide

Definition at line 118 of file kgamepopupitem.h.

Constructor & Destructor Documentation

KGamePopupItem::KGamePopupItem ( QGraphicsItem * parent = 0 )

Constructs a message item.

It is hidden by default.

Definition at line 132 of file kgamepopupitem.cpp.

KGamePopupItem::~KGamePopupItem ( )

Destructs a message item.

Definition at line 326 of file kgamepopupitem.cpp.

Member Function Documentation

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 189 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 310 of file kgamepopupitem.cpp.

int KGamePopupItem::messageTimeout ( ) const

Returns:: timeout that is currently set

Definition at line 365 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 315 of file kgamepopupitem.cpp.

qreal KGamePopupItem::messageOpacity ( ) const

Returns:: current message opacity

Definition at line 392 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 358 of file kgamepopupitem.cpp.

void KGamePopupItem::forceHide ( HideType type = AnimatedHide )

Requests the item to be hidden immediately.

Definition at line 370 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 397 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 402 of file kgamepopupitem.cpp.

QRectF KGamePopupItem::boundingRect ( ) const [virtual]

Returns:: the bounding rect of this item.

Reimplemented from QGraphicsItem

Definition at line 321 of file kgamepopupitem.cpp.

void KGamePopupItem::paint	(	QPainter *	p,
		const QStyleOptionGraphicsItem *	option,
		QWidget *	widget
	)			`[virtual]`

Paints item.

Reimplemented from QGraphicsItem

Reimplemented from QGraphicsItem.

Definition at line 167 of file kgamepopupitem.cpp.

void KGamePopupItem::setSharpness ( Sharpness sharpness )

Sets the popup angles sharpness.

Definition at line 417 of file kgamepopupitem.cpp.

KGamePopupItem::Sharpness KGamePopupItem::sharpness ( ) const

Returns:: current popup angles sharpness

Definition at line 422 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.

void KGamePopupItem::hidden ( ) [signal]

Emitted when the popup finishes hiding.

This includes hiding caused by both timeouts and mouse clicks.

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

libkdegames

KGamePopupItem Class Reference

Detailed Description

Public Types

Signals

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

libkdegames

API Reference