• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

libkdegames

KGameCanvasAbstract Class Reference

#include <kgamecanvas.h>

Inheritance diagram for KGameCanvasAbstract:

Inheritance graph
[legend]

List of all members.


Detailed Description

Container class.

A KGameCanvasAbstract is a set of canvas items.

Definition at line 52 of file kgamecanvas.h.


Public Member Functions

 KGameCanvasAbstract ()
virtual ~KGameCanvasAbstract ()
const QList< KGameCanvasItem * > * items () const
KGameCanvasItem * itemAt (const QPoint &pos) const
KGameCanvasItem * itemAt (int x, int y) const
QList< KGameCanvasItem * > itemsAt (const QPoint &pos) const
QList< KGameCanvasItem * > itemsAt (int x, int y) const
virtual void ensureAnimating ()=0
virtual void ensurePendingUpdate ()=0
virtual void invalidate (const QRect &r, bool translate=true)=0
virtual void invalidate (const QRegion &r, bool translate=true)=0
virtual class KGameCanvasWidget * topLevelCanvas ()=0
virtual QPoint canvasPosition () const =0

Protected Attributes

QList< KGameCanvasItem * > m_items
QList< KGameCanvasItem * > m_animated_items

Friends

class KGameCanvasItem

Constructor & Destructor Documentation

KGameCanvasAbstract::KGameCanvasAbstract (  ) 

The constructor.

Definition at line 50 of file kgamecanvas.cpp.

KGameCanvasAbstract::~KGameCanvasAbstract (  )  [virtual]

Definition at line 54 of file kgamecanvas.cpp.


Member Function Documentation

const QList<KGameCanvasItem*>* KGameCanvasAbstract::items (  )  const [inline]

Returns a const pointer to the list holding all the items in the canvas.

Definition at line 67 of file kgamecanvas.h.

KGameCanvasItem * KGameCanvasAbstract::itemAt ( const QPoint &  pos  )  const

Helper function to retrieve the topmost item at the given position.

Definition at line 60 of file kgamecanvas.cpp.

KGameCanvasItem* KGameCanvasAbstract::itemAt ( int  x,
int  y 
) const [inline]

Overload, same as above.

Definition at line 73 of file kgamecanvas.h.

QList< KGameCanvasItem * > KGameCanvasAbstract::itemsAt ( const QPoint &  pos  )  const

Helper function to retrieve all the items at the given position, starting from the topmost one.

Definition at line 69 of file kgamecanvas.cpp.

QList<KGameCanvasItem*> KGameCanvasAbstract::itemsAt ( int  x,
int  y 
) const [inline]

Overload, same as above.

Definition at line 80 of file kgamecanvas.h.

virtual void KGameCanvasAbstract::ensureAnimating (  )  [pure virtual]

Virtual function to let know the canvas that it has animated items in it.

virtual void KGameCanvasAbstract::ensurePendingUpdate (  )  [pure virtual]

Virtual function to ensure an update is pending, called from children.

virtual void KGameCanvasAbstract::invalidate ( const QRect &  r,
bool  translate = true 
) [pure virtual]

Virtual function to update a rect.

virtual void KGameCanvasAbstract::invalidate ( const QRegion &  r,
bool  translate = true 
) [pure virtual]

Virtual function to update a region.

virtual class KGameCanvasWidget* KGameCanvasAbstract::topLevelCanvas (  )  [pure virtual]

Returns the toplevel non-group KGameCanvasWidget object.

Implemented in KGameCanvasGroup, KGameCanvasWidget, and KGameCanvasAdapter.

virtual QPoint KGameCanvasAbstract::canvasPosition (  )  const [pure virtual]

Returns:
Position of the abstract canvas relative to the toplevel canvas.

Implemented in KGameCanvasGroup, KGameCanvasWidget, and KGameCanvasAdapter.


Friends And Related Function Documentation

friend class KGameCanvasItem [friend]

Reimplemented in KGameCanvasWidget.

Definition at line 55 of file kgamecanvas.h.


Member Data Documentation

QList<KGameCanvasItem*> KGameCanvasAbstract::m_items [protected]

Definition at line 57 of file kgamecanvas.h.

QList<KGameCanvasItem*> KGameCanvasAbstract::m_animated_items [protected]

Definition at line 58 of file kgamecanvas.h.


The documentation for this class was generated from the following files:
  • kgamecanvas.h
  • kgamecanvas.cpp

libkdegames

Skip menu "libkdegames"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • kblackbox
  • kgoldrunner
  • kmahjongg
  • ksquares
  • libkdegames
  •   highscore
  •   kgame
  •   kggzgames
  •   kggzmod
  •   kggznet
  • libkmahjongg
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal