Source: ./activitywidget.h


Annotated List
Files
Globals
Hierarchy
Index
/***************************************************************************
 *                                                                         *
 *   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 ACTIVITYWIDGET_H
#define ACTIVITYWIDGET_H
#include 
#include "umlwidget.h"

#define ACTIVITY_MARGIN 5
#define ACTIVITY_WIDTH 30
#define ACTIVITY_HEIGHT 10

/**
 * This class is the graphical version of a UML Activity.  A ActivityWidget is created
 * by a @ref UMLView.  An ActivityWidget belongs to only one @ref UMLView instance.
 * When the @ref UMLView instance that this class belongs to, it will be automatically deleted.
 *
 * The ActivityWidget class inherits from the @ref UMLWidget class which adds most of the functionality
 * to this class.
 *
 * @short  A graphical version of a UML Activity.
 * @author Paul Hensgen 
 * @version 1.0
 */
class ActivityWidget : public UMLWidget {
	Q_OBJECT

public:

	enum ActivityType
	{
	    Initial = 0,
	    Normal,
	    End,
	    Branch,
	    Fork
	};
	/**
	 *	Creates a Activity widget.
	 *
	 *	@param	view		The parent of the widget.
	 *	@param	pData		The UMLWidgetData to represent.
	 */
	ActivityWidget( UMLView * view, UMLWidgetData* pData );

	/**
	 *	Creates a Activity widget.
	 *
	 *	@param	view		The parent of the widget.
	 *	@param	activityType  The type of activity.
	 */
	ActivityWidget( UMLView * view, ActivityType activityType );

	/**
	 *	Creates a Activity widget.
	 *
	 *	@param	view		The parent of the widget.
	 */
	ActivityWidget(UMLView * view);

	/**
	 *	Standard deconstructor
	 */
	~ActivityWidget();

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

	/**
	 *	Overrides the standard paint event.
	 */
	void draw(QPainter & p, int offsetX, int offsetY);

	/**
	 * Sets the name of the Activity.
	 */
	virtual void SetName(QString strName);

	/**
	 * Returns the name of the Activity.
	 */
	virtual QString GetName();

	/**
	 *   Returns the documentation of the activity.
	 */
	QString getDoc();

	/**
	 *   Sets the documenation of the activity.
	 */
	void setDoc( QString doc );

	/**
	 *   Returns the type of activity.
	 */
	ActivityType getActivityType();

	/**
	 *     Sets the type of activity.
	 */
	void setActivityType( ActivityType activityType );

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

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

public slots:

	/**
	 *   Captures any popup menu signals for menus it created.
	 */
	void slotMenuSelection(int sel);
};

#endif

Generated by: jr on radge on Wed Sep 25 00:11:47 2002, using kdoc 2.0a54.