Source: ./floatingtext.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 FLOATINGTEXT_H
#define FLOATINGTEXT_H
#include "umlwidget.h"
class AssociationWidget;
class MessageWidget;
class UMLView;

/**
 *	This is a multipurpose class.  In its simplist form it will display a line of text.
 *	It can also be setup to be the text for an operation with regard to the @ref MessageWidget
 *	on the sequence diagram.  It is also used for the text required for an association.
 *
 *	The differences between all these different uses will be the popup menu that is
 *	associated with it.
 *
 *	@short	Displays a line of text or an operation.
 *	@author Paul Hensgen	
 *	@version	1.0
 *	@see	UMLWidget
 */
class FloatingTextData;

class FloatingText : public UMLWidget {
public:
	/**
	 *	Constructs a FloatingText instance.
	 *
	 *	@param	view	The parent of this FloatingText.
	 *	@param	pData The CFloatingText to represent.
	 */
	FloatingText(UMLView * view, UMLWidgetData *pData);

	/**
	 *	Constructs a FloatingText instance.
	 *
	 *	@param	view	The parent of this FloatingText.
	 *	@param	role	The role this FloatingText will take up.
	 *	@param	text	The text to display.
	 */
	FloatingText(UMLView * view, Text_Role role, QString text = "");

	/**
	 *	Constructs a FloatingText instance.
	 *
	 *	@param	view	The parent of this FloatingText.
	 */
	FloatingText(UMLView * view);

	/**
	 *	Standard deconstructor.
	 */
	~FloatingText();

	/**
	 *	Called to set the position of the FloatingText.
	 *
	 *	@param x		Vertical co-ordinate of the point.
	 *	@param	y	Horizontal co-ordinate of the point.
	 */
	void setLinePos(int x, int y);

	/**
	 *	Set the text to display.
	 *
	 *	@param	t	The text to display.
	 */
	void setText(QString t);

	/**
	 *	Set the sequence number to display.
	 *
	 *	@param	sn	The sequence number to display.
	 */
	void setSeqNum(QString sn);

	/**
	 *	Return the sequence number.
	 *
	 *	@return	The sequence number.
	 */
	QString getSeqNum();

	/**
	 *	Set the operation to display.
	 *
	 *	@param	op	The operation to display.
	 */
	void setOperation(QString op);

	/**
	 *	Return the operation that is displayed.
	 *
	 *	@return	The operation that is displayed.
	 */
	QString getOperation();

	/**
	 *	Use to get the text currently displayed by the widget.
	 *	@return	Returns the text currently being displayed by the widget.
	 */
	QString getText();

	/**
	 * If this object is associated with a @ref Association object then
	 * this method will be called by that association when it thinks this
	 * object has been right clicked on.
	 *
	 *	@param	p	The point at which the right button was clicked.
	 */
	void startMenu(AssociationWidget * a, QPoint p);

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

	/**
	 *	Displays a dialog box to change the text.
	 */
	void changeTextDlg();

	/**
	 *	Sets the message to the @ref MessageWidget that this class may represent.
	 *
	 *	@param	m		The MessageWidget that may be represented.
	 */
	void setMessage(MessageWidget * m);

	/**
	 *	Returns the @ref MessageWidget this floating text is related to.
	 *
	 *	@return	Returns the @ref MessageWidget this floating text is related to.
	 */
	MessageWidget * getMessage() {
		return m_pMessage;
	}

	/**
	 *	Overrides a method.  Used to pickup double clicks.
	 */
	void mouseDoubleClickEvent(QMouseEvent * /*me*/);

	/**
	 *	Sets the assoc to the @ref Association to represent.
	 *
	 *	@param	a		The Association to represent.
	 */
	void setAssoc(AssociationWidget * a) {
		m_pAssoc = a;
	}

	/**
	 *	Returns wether this is a line of text.
	 *	Used for transparency in printing.
	 *
	 *	@return Returns wether this is a line of text.
	 */
	bool isText() {
		return true;
	}

	/**
	 * Returns the Association this object is related to.
	 *
	 *	@return Returns the Association this object is related to.
	 */
	AssociationWidget * getAssoc() {
		return m_pAssoc;
	}

	/**
	 * Activate the FloatingText after the serialized data has been loaded
	 */
	virtual bool Activate( IDChangeLog* ChangeLog = 0 );

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

	/**
	 * Sets the role type of this FloatingText
	 */
	void SetRole(Text_Role Role);

	/**
	 * Return the role of the text widget
	 */
	Uml::Text_Role getRole();

	/**
	 *
	 */
	static bool isTextValid(QString text);

	/**
	 *	Calculates the size of the widget.
	 */
	void calculateSize();

	/**
	 * Overrides defalt method
	 */
	void draw(QPainter & p, int offsetX, int offsetY);

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

private:
	/**
	 *   The association it may be linked to.
	 */
	AssociationWidget * m_pAssoc;

	/**
	 *  	The message widget it may be linked to.
	 */
	MessageWidget * m_pMessage;

	/**
	 *   	Override default method
	 */
	void moveEvent(QMoveEvent */*m*/);

	/**
	 *  	Override default method
	 */
	void resizeEvent(QResizeEvent */*re*/);

	/**
	 *    Shows an operation dialog box.
	 */
	void showOpDlg();

	/**
	 *   	Override default method
	 */
	void mouseMoveEvent(QMouseEvent * me);

public slots:
	/**
	 *	Called when a menu selection has been made.
	 *	This method is public due to called by @ref MessageWidget
	 *	when this is text for a @ref MessageWidget.
	 *
	 *	@param	sel	The selection that has been made.
	 */
	void slotMenuSelection(int sel);
};

#endif