KDE 4.5 API Reference libkdegames
KGameCanvasItem Class Reference
An abstract item. More...
#include <KGameCanvas>
Public Member Functions | |
| KGameCanvasItem (KGameCanvasAbstract *canvas=NULL) | |
| virtual | ~KGameCanvasItem () |
| QPoint | absolutePosition () const |
| virtual void | advance (int msecs) |
| bool | animated () const |
| KGameCanvasAbstract * | canvas () const |
| virtual void | changed () |
| void | hide () |
| virtual bool | layered () const |
| void | lower () |
| void | moveTo (int x, int y) |
| void | moveTo (const QPoint &newpos) |
| int | opacity () const |
| virtual void | paint (QPainter *p)=0 |
| QPoint | pos () const |
| void | putInCanvas (KGameCanvasAbstract *canvas) |
| void | raise () |
| virtual QRect | rect () const =0 |
| void | setAnimated (bool a) |
| void | setOpacity (int o) |
| void | setVisible (bool v) |
| void | show () |
| void | stackOver (KGameCanvasItem *ref) |
| void | stackUnder (KGameCanvasItem *ref) |
| KGameCanvasWidget * | topLevelCanvas () const |
| bool | visible () const |
Detailed Description
An abstract item.
A KGameCanvasItem is an abstract class to represent a generic item that can be put in a canvas.
Definition at line 109 of file kgamecanvas.h.
Constructor & Destructor Documentation
| KGameCanvasItem::KGameCanvasItem | ( | KGameCanvasAbstract * | canvas = NULL |
) |
Constructor, it allows you to specify the reference canvas or to create an orphan item that will be put into a canvas in a second moment.
The item is always hidden after being created. Note that the restacking functions are quite intelligent and will only repaint if there is an actual need of doing it. So if you call raise on an item that is already (locally) on the top, no redraw will take place
Definition at line 234 of file kgamecanvas.cpp.
| KGameCanvasItem::~KGameCanvasItem | ( | ) | [virtual] |
Definition at line 244 of file kgamecanvas.cpp.
Member Function Documentation
| QPoint KGameCanvasItem::absolutePosition | ( | ) | const |
- Returns:
- Position of the item relative to the top level canvas.
Definition at line 507 of file kgamecanvas.cpp.
| void KGameCanvasItem::advance | ( | int | msecs | ) | [virtual] |
Override this function to handle animations, the default function does nothing.
The argument is the number of milliseconds from the creation of the canvas, so that you use it to handle the animation.
Reimplemented in KGameCanvasGroup.
Definition at line 402 of file kgamecanvas.cpp.
| bool KGameCanvasItem::animated | ( | ) | const [inline] |
Returns true if the item is animated.
Definition at line 157 of file kgamecanvas.h.
| KGameCanvasAbstract* KGameCanvasItem::canvas | ( | ) | const [inline] |
Returns the canvas that is actually "owning" the item.
Definition at line 187 of file kgamecanvas.h.
| void KGameCanvasItem::changed | ( | ) | [virtual] |
schedule an update if the item
Definition at line 254 of file kgamecanvas.cpp.
| void KGameCanvasItem::hide | ( | ) | [inline] |
Hides the item.
Definition at line 169 of file kgamecanvas.h.
| bool KGameCanvasItem::layered | ( | ) | const [virtual] |
Override this function to specify if the painting operations will paint over each other.
If not, the item will be drawn more quickly when opacity is != 255, because it does not have to be painted onto a pixmap first. If you don't care about the item's opacity, don't care about this function as well.
Reimplemented in KGameCanvasPixmap, KGameCanvasTiledPixmap, KGameCanvasRectangle, and KGameCanvasText.
Definition at line 400 of file kgamecanvas.cpp.
| void KGameCanvasItem::lower | ( | ) |
Restacks the item on the bottom of the canvas.
Definition at line 436 of file kgamecanvas.cpp.
| void KGameCanvasItem::moveTo | ( | int | x, | |
| int | y | |||
| ) | [inline] |
Overload, same as above.
Definition at line 208 of file kgamecanvas.h.
| void KGameCanvasItem::moveTo | ( | const QPoint & | newpos | ) |
Sets a new position.
Note that an update will be posted to the parent canvas, and if you move an item twice in very little time, a region bigger than needed will be updated, causing a possible inefficiency
Definition at line 498 of file kgamecanvas.cpp.
| int KGameCanvasItem::opacity | ( | ) | const [inline] |
Returns the opacity of the item.
Definition at line 163 of file kgamecanvas.h.
| virtual void KGameCanvasItem::paint | ( | QPainter * | p | ) | [pure virtual] |
Override this function to draw the item with the painter.
Implemented in KGameCanvasDummy, KGameCanvasGroup, KGameCanvasPicture, KGameCanvasPixmap, KGameCanvasTiledPixmap, KGameCanvasRectangle, and KGameCanvasText.
| QPoint KGameCanvasItem::pos | ( | ) | const [inline] |
Returns the position of the item.
Definition at line 197 of file kgamecanvas.h.
| void KGameCanvasItem::putInCanvas | ( | KGameCanvasAbstract * | canvas | ) |
Lets you specify the owning canvas.
Call this function with canvas set to NULL to remove the item from the current canvas.
Definition at line 336 of file kgamecanvas.cpp.
| void KGameCanvasItem::raise | ( | ) |
Restacks the item on the top of the canvas.
Definition at line 424 of file kgamecanvas.cpp.
| virtual QRect KGameCanvasItem::rect | ( | ) | const [pure virtual] |
Override this function to return the rect the item will be drawn into.
Implemented in KGameCanvasDummy, KGameCanvasGroup, KGameCanvasPicture, KGameCanvasPixmap, KGameCanvasTiledPixmap, KGameCanvasRectangle, and KGameCanvasText.
| void KGameCanvasItem::setAnimated | ( | bool | a | ) |
Set the item as animated or not.
Definition at line 376 of file kgamecanvas.cpp.
| void KGameCanvasItem::setOpacity | ( | int | o | ) |
Set the item's opacity value (int the 0-255 range).
Definition at line 391 of file kgamecanvas.cpp.
| void KGameCanvasItem::setVisible | ( | bool | v | ) |
Set the item as visible or hidden.
Definition at line 361 of file kgamecanvas.cpp.
| void KGameCanvasItem::show | ( | ) | [inline] |
Shows the item.
Definition at line 172 of file kgamecanvas.h.
| void KGameCanvasItem::stackOver | ( | KGameCanvasItem * | ref | ) |
Restacks the item immediately over ref.
Definition at line 449 of file kgamecanvas.cpp.
| void KGameCanvasItem::stackUnder | ( | KGameCanvasItem * | ref | ) |
Restacks the item immediately under ref.
Definition at line 473 of file kgamecanvas.cpp.
| KGameCanvasWidget* KGameCanvasItem::topLevelCanvas | ( | ) | const [inline] |
Returns the toplevel canvas widget, or NULL.
Definition at line 190 of file kgamecanvas.h.
| bool KGameCanvasItem::visible | ( | ) | const [inline] |
Returns true if the item is visible.
Definition at line 151 of file kgamecanvas.h.
The documentation for this class was generated from the following files:
