added source items

[blast.git] / AbstractBoxItem.h

diff --git a/AbstractBoxItem.h b/AbstractBoxItem.h
index 6eeb46c011f04b5d313df596c58338a5da850bd3..132adc996f7f1ef979c4d97932adbff30713841e 100644 (file)
--- a/AbstractBoxItem.h
+++ b/AbstractBoxItem.h
@@ -22,6 +22,7 @@ public:
   enum ChangeType { Resize = 0, InterfaceMove };
 
   AbstractBoxItem(AbstractBlock *_refBlock, Dispatcher *_dispatcher, Parameters *_params, QGraphicsItem* parent = Q_NULLPTR);
+  AbstractBoxItem(Dispatcher *_dispatcher, Parameters *_params, QGraphicsItem* parent = Q_NULLPTR);
 
   virtual ~AbstractBoxItem();
 
@@ -40,25 +41,51 @@ public:
   inline QPointF getOriginPoint() { return originPoint; }
 
   // setters
-  inline void setId(int id){ this->id = id; }
+  void setRefBlock(AbstractBlock* _refBlock);
+  inline void setId(int _id){ id = _id; }
   inline void setSelected(bool _selected) { selected = _selected; }  
-  inline void setRstClkVisible(bool b){ rstClkVisible = b;}
+  void setRstClkVisible(bool b);
+  void setWishboneVisible(bool b);
   void setDimension(int x, int y);
   inline void setCurrentInterface(InterfaceItem* iface) { currentInterface = iface; }
 
   // testers
   virtual bool isBoxItem();
-  virtual bool isGroupItem();  
+  virtual bool isGroupItem();
+  virtual bool isSourceItem();
   inline bool isSelected() { return selected; }
   inline bool isRstClkVisible(){ return rstClkVisible;}
+  inline bool isWishboneVisible(){ return wishboneVisible;}
   bool isInterfaces(int orientation) const;
 
   // others
 
+  virtual void nameChanged() = 0; // called when an interface or box name have changed
   void addInterface(InterfaceItem* i, bool resetPosition = false);
   void removeInterface(InterfaceItem* i);
   void resetInterfacesPosition();
-  void deplaceInterface(QPointF pos);
+  /*!
+   * \brief moveInterfaceTo
+   * \param pos the new position (in scene) of the interface
+   *
+   * This method is called when user moves an InterfaceItem.
+   * see BoxItem::mouseMoveEvent() and GroupItem::mouseMoveEvent()
+   */
+  void moveInterfaceTo(QPointF pos);
+  /*!
+   * \brief updateInterfacesAndConnections
+   *
+   * This method allows to recompute the absolute position of the interfaces of this box
+   * taking into account their relative position (see positionRatio atribute) in the width/height
+   * of the box border they are located on. It allows update the shape of all ConnectionItem
+   * connected to this box.
+   *
+   * CAUTION: this method supposes that before its call, a call to prepareGeometryChange() hase been
+   * done for the BoxItem that owns this InterfaceItem, so that the scene will readraw automatically
+   * the BoxItem. For the connections, the call to prepareGeometryChange() is done within setPath()
+   * that is called in this method. Thus, there is no need to call update() after the termination of
+   * this method.
+   */
   void updateInterfacesAndConnections();
 
   InterfaceItem *searchInterfaceByName(QString name);
@@ -90,12 +117,13 @@ protected:
   int nameHeight; // the height of the name in Arial 10
   int nameMargin; // the margin around each side of the name
   int ifaceMargin; // the margin around each side of interfaces' name
-  QPointF originPoint; // the left-top point that is the origin of the bounding box
+  QPointF originPoint; // the left-top point that is the origin of the bounding box, in the item coordinates
 
   bool selected;
-  bool rstClkVisible;
+  bool rstClkVisible; //! true if clock/reset interfaces are visible
+  bool wishboneVisible; //! true if wishbone interfaces are visible
 
-  QPointF currentPosition; // the start point for resize
+  QPointF currentPosition; // the start point for resize, i.e. the position of the lef-top corner of the box, in the scene coordinates
 
   virtual void updateMinimumSize() = 0; // modify the minimum size
   virtual bool updateGeometry(ChangeType type) = 0; // modify the originPoint and the total dimension