Source: ./messagewidget.h

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef MESSAGEWIDGET_H
#define MESSAGEWIDGET_H

#include "umlwidget.h"
#include "floatingtext.h"
#include "objectwidget.h"
#include "messagewidgetdata.h"

/**
 *	Used to display a message on a sequence diagram.  The message could be between
 *	two objects or a message that calls itself on an object.  This class will only
 *	display the line that is required and the text will be setup by the @ref FloatingText
 *	widget that is passed in the constructor.
 *
 *	@short	Displays a message.
 *	@author Paul Hensgen
 *	@version  1.0
 *	@see	UMLWidget
 *	@see	FloatingText
 */
class MessageWidget : public UMLWidget {
	Q_OBJECT
public:
	/**
	 *	Cosntructs a MessageWidget.
	 *
	 *  @param	view		The parent to this class.
	 *  @param	pData		The CMessageWidget to represent
	 */
	MessageWidget(UMLView * view, UMLWidgetData * pData);

	/**
	 *	Cosntructs a MessageWidget.
	 *
	 *	@param	view	The parent to this class.
	 *	@param	a	The role A widget for this message.
	 *	@param	b	The role B	widget for this message.
	 *	@param	ft	The FloatingText widget that is needed to display text.
	 *	@param	id	A unique id used for deleting this object cleanly.
	 *	@param	y	The vertical position to display this message.
	 */
	MessageWidget(UMLView * view, UMLWidget * a, UMLWidget * b, FloatingText * ft, int id, int y);

	/**
	 *	Cosntructs a MessageWidget.
	 *
	 *	@param	view		The parent to this class.
	 */
	MessageWidget(UMLView * view);

	/**
	 *	Initializes key variables of the class.
	 */
	void init();

	/**
	 *	Standard deconstructor.
	 */
	virtual ~MessageWidget();

	/**
	 *	Check to see if the given UMLWidget is involved in the message.
	 *
	 *	@param	w	The UMLWidget to check for.
	 *	@return	The status of the check.	true - if is contained, false - not contained.
	 */
	bool contains(UMLWidget * w);

	/**
	 *	Returns the A widget it is related to.
	 *
	 *	@return Returns the A widget it is related to.
	 */
	UMLWidget * getWidgetA() {
		return m_pWA;
	}

	/**
	 *	Returns the B widget it is related to.
	 *
	 *	@return Returns the B widget it is related to.
	 */
	UMLWidget * getWidgetB() {
		return m_pWB;
	}

	/**
	 *	Returns the id of the A widget it is related to.
	 *
	 *	@return Returns the id of the A widget it is related to..
	 */
	int getCopyIDA() {
		return ((MessageWidgetData*)m_pData)->m_nWidgetAID;
	}

	/**
	 *	Returns the id of the B widget it is related to.
	 *
	 *	@return Returns the id of the B widget it is related to..
	 */
	int getCopyIDB() {
		return ((MessageWidgetData*)m_pData)->m_nWidgetBID;
	}

	/**
	 *	Sets the A widget it is related to.
	 *
	 *	@param wa the A widget it is related to.
	 */
	void setWidgetA(UMLWidget * wa) {
		m_pWA = wa;
		((MessageWidgetData*)m_pData)->m_nWidgetAID = ((ObjectWidget *)wa) -> getLocalID();
	}

	/**
	 *	Sets the B widget it is related to.
	 *
	 *	@param wa the B widget it is related to.
	 */
	void setWidgetB(UMLWidget * wb) {
		m_pWB = wb;
		((MessageWidgetData*)m_pData)->m_nWidgetBID = ((ObjectWidget *)wb) -> getLocalID();
	}

	/**
	 *	Returns the text widget it is related to.
	 *
	 *	@return Returns the text widget it is related to.
	 */
	FloatingText * getFloatingText() {
		return m_pFText;
	}

	/**
	 *	Sets the text widget it is related to.
	 *
	 *	@param wa the text widget it is related to.
	 */
	void setFloatingText(FloatingText * f) {
		m_pFText = f;
	}

	/**
	 *	Calculate the geometry of the widget.
	 */
	void calculateWidget();

	/**
	 * Activates a MessageWidget, Connects its m_pWA and m_pWB pointers to UMLObjects
	 * and also send signals about its floatingText
	 */
	bool Activate(IDChangeLog * Log = 0);

	/**
	 * Synchronizes the Widget's m_pData member with its display properties, for exmaple:
	 * the X and Y position of the widget, etc
	 */
	virtual void SynchronizeData();

	/**
	 *
	 */
	void CalculateDimensions();

	/**
	 * override default method
	 */
	void draw(QPainter & p, int offsetX, int offsetY);


	/**
	 *   Used to cleanup any other widget it may need to delete.
	 */
	void cleanup();

	/**
	 *	Overrides the standard operation.
	 */
	void mouseMoveEvent(QMouseEvent *me);

	/**
	 *	Sets the state of whether the widget is selected.
	 *
	 *	@param _select The state of whether the widget is selected.
	 */
	void setSelected(bool _select);

	/**
	 *		Returns the minimum height this widget should be set at on
	 *		a sequence diagrams.  Takes into account the widget positions
	 *		it is related to.
	 */
	int getMinHeight();

	/**
	 *		Returns the maximum height this widget should be set at on
	 *		a sequence diagrams.  Takes into account the widget positions
	 *		it is related to.
	 */
	int getMaxHeight();

	/**
	 *	Overrides the standard operation.
	 */
	virtual void mouseReleaseEvent(QMouseEvent * me);

	/**
	 *	Overrides the standard operation.
	 */
	virtual void mousePressEvent(QMouseEvent *me);
private:
	void moveEvent(QMoveEvent */*m*/);
	void resizeEvent(QResizeEvent */*re*/);
	void mouseDoubleClickEvent(QMouseEvent */* me*/);

	UMLWidget * m_pWA, * m_pWB;
	FloatingText * m_pFText;
	int m_nY;
public slots:
	void slotWidgetMoved(int id);
	void slotMenuSelection(int sel);
};

#endif