libkdegames

KGamePopupItem Class Reference

#include <KGamePopupItem>

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


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
virtual QRectF	boundingRect () const
void	forceHide (HideType type=AnimatedHide)
bool	hidesOnMouseClick () const
	KGamePopupItem (QGraphicsItem *parent=0)
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)
	~KGamePopupItem ()

Member Enumeration Documentation

enum KGamePopupItem::HideType

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

Enumerator:

InstantHide
AnimatedHide

Definition at line 128 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 61 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 53 of file kgamepopupitem.h.

enum KGamePopupItem::Sharpness

Possible values for the popup angles sharpness.

Enumerator:

Square
Sharp
Soft
Softest

Definition at line 57 of file kgamepopupitem.h.

Constructor & Destructor Documentation

KGamePopupItem::KGamePopupItem ( QGraphicsItem * parent = 0 )

Constructs a message item.

It is hidden by default.

Definition at line 137 of file kgamepopupitem.cpp.

KGamePopupItem::~KGamePopupItem ( )

Destructs a message item.

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

void KGamePopupItem::forceHide ( HideType type = AnimatedHide )

Requests the item to be hidden immediately.

Definition at line 387 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 327 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 409 of file kgamepopupitem.cpp.

int KGamePopupItem::messageTimeout ( ) const

Returns:: timeout that is currently set

Definition at line 382 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 174 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 414 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 322 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 375 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 332 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 317 of file kgamepopupitem.cpp.

void KGamePopupItem::setSharpness ( Sharpness sharpness )

Sets the popup angles sharpness.

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

KGamePopupItem::Sharpness KGamePopupItem::sharpness ( ) const

Returns:: current popup angles sharpness

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

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