updates to doxygen commentation and removal of one unneeded method
authorVille Tiensuu <ville.tiensuu@ixonos.com>
Mon, 3 May 2010 08:45:58 +0000 (11:45 +0300)
committerVille Tiensuu <ville.tiensuu@ixonos.com>
Mon, 3 May 2010 08:45:58 +0000 (11:45 +0300)
src/map/baselocationitem.h
src/map/friendlocationitem.cpp
src/map/friendlocationitem.h
tests/map/ownlocationitem/testownlocationitem.cpp

index f857432..9e9354f 100644 (file)
 #include <QGraphicsPixmapItem>
 
 
-
+/**
+* @brief Baseclass for showing own and friends locations on the map.
+*        This class is abstract
+*
+* @class BaseLocationItem baselocationitem.h "map/baselocationitem.h"
+* @author Ville Tiensuu
+*/
 class BaseLocationItem : public QGraphicsPixmapItem, public QObject
 {    
 
 public:
+
+    /**
+    * @brief Constructor of BaseLocationItem.
+    *        Sets parent.
+    *
+    * @param parent
+    */
     BaseLocationItem(QObject *parent = 0);
 
     /*******************************************************************************
index 9df90b0..222f37e 100644 (file)
@@ -24,7 +24,6 @@
 #include "mapengine.h"
 #include "mapcommon.h"
 
-
 FriendLocationItem::FriendLocationItem(const QPixmap &icon,
                                        const QPointF &friendsLocation,
                                        QObject *parent)
@@ -36,7 +35,8 @@ FriendLocationItem::FriendLocationItem(const QPixmap &icon,
     setPosition(QPointF( friendsLocation.x(), friendsLocation.y() ));
     setZValue(FRIEND_LOCATION_ICON_Z_LEVEL);
     setOffset(-icon.width()/2, -icon.height()/2);
-    setFlag(QGraphicsItem::ItemIgnoresTransformations);
+    setFlag(QGraphicsItem::ItemIgnoresTransformations);    
+    m_name = new QString;
 }
 
 void FriendLocationItem::mousePressEvent(QGraphicsSceneMouseEvent *event)
@@ -48,12 +48,12 @@ void FriendLocationItem::mousePressEvent(QGraphicsSceneMouseEvent *event)
     emit iconClicked(*m_name);
 }
 
-void FriendLocationItem::setIcon(const QPixmap &icon)
+QString FriendLocationItem::name() const
 {
-    setPixmap(icon);
+    return *m_name;
 }
 
 void FriendLocationItem::setName(const QString &name)
 {
-    m_name = new QString(name);
+    *m_name = name;
 }
index e90dd0b..66742ef 100644 (file)
@@ -49,16 +49,18 @@ public:
     *        Sets item to ignore transformations. this feature is needed to make icon on the map
     *        immune to scaling
     *
-    * @param icon friends Facebook profile picture, friendsLocation Position in QPoinF, parent
+    * @param icon Friends Facebook profile picture, friendsLocation Position in QPoinF, parent
+    * @param friendsLocation Location of friend
+    * @param parent Parent
     */
-    FriendLocationItem(const QPixmap &icon, const QPointF &friendsLocation, QObject *parent = 0);
+    FriendLocationItem(const QPixmap &icon, const QPointF &friendsLocation, QObject *parent = 0);    
 
     /**
-    * @brief sets friends Facebook profile picture that is show on the map.
+    * @brief getter for name
     *
-    * @param icon friends Facebook profile picture
+    * @return QString name of friend
     */
-    void setIcon(const QPixmap &icon);
+    QString name() const;
 
     /**
     * @brief sets name for friend.
index 218ff18..badabdc 100644 (file)
@@ -103,8 +103,8 @@ class TestOwnLocationItem: public QObject
 
 
      // Test Offset
-//     QCOMPARE(ownLocationItem.offset(),
-//              QPoint(-ownLocationItem.pixmap().width(), -ownLocationItem.pixmap().height()));
+     QCOMPARE(ownLocationItem.offset(),
+              QPointF(-ownLocationItem.pixmap().width()/2, -ownLocationItem.pixmap().height()/2));
 
 
      // Test ItemIgnoresTransformations Flags