Merge sources dir branch devel to trunk

git-svn-id: svn+ssh://svn.tuxfamily.org/svnroot/qet/qet/trunk@2613 bfdf4180-ca20-0410-9c96-a3a8aa849046

sources/qetgraphicsitem/element.h

@@ -0,0 +1,152 @@
+/*
+	Copyright 2006-2013 The QElectroTech Team
+	This file is part of QElectroTech.
+	
+	QElectroTech 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.
+	
+	QElectroTech is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	GNU General Public License for more details.
+	
+	You should have received a copy of the GNU General Public License
+	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
+*/
+#ifndef ELEMENT_H
+#define ELEMENT_H
+#include <QtGui>
+#include "terminal.h"
+#include "qetgraphicsitem.h"
+class Diagram;
+class ElementTextItem;
+/**
+	This is the base class for electrical elements.
+*/
+class Element : public QetGraphicsItem {
+	
+	Q_OBJECT
+	
+	// constructors, destructor
+	public:
+	Element(QGraphicsItem * = 0, Diagram * = 0);
+	virtual ~Element();
+	
+	private:
+	Element(const Element &);
+	
+	// attributes
+	public:
+	enum { Type = UserType + 1000 };
+	
+	protected:
+	
+	private:
+	QSize   dimensions;
+	QPoint  hotspot_coord;
+	QPixmap preview;
+	
+	// methods
+	public:
+	/**
+		Enable the use of qgraphicsitem_cast to safely cast a QGraphicsItem into an
+		Element.
+		@return the QGraphicsItem type
+	*/
+	virtual int type() const { return Type; }
+	
+	// pure virtual methods to be defined in derived classes
+	/// @return the list of terminals for this element
+	virtual QList<Terminal *> terminals() const = 0;
+	/// @return the list of conductors attached to this element
+	virtual QList<Conductor *> conductors() const = 0;
+	/// @return the list of text items attached to this element
+	virtual QList<ElementTextItem *> texts() const = 0;
+	/// @return the current number of terminals of this element
+	virtual int terminalsCount() const = 0;
+	/// @return the minimum number of terminals for this element
+	virtual int minTerminalsCount() const = 0;
+	/// @return the maximum number of terminals for this element
+	virtual int maxTerminalsCount() const = 0;
+	/**
+		Draw this element
+	*/
+	virtual void paint(QPainter *, const QStyleOptionGraphicsItem *) = 0;
+	/// @return This element type ID
+	virtual QString typeId() const = 0;
+	/// @return the human name for this element
+	virtual QString name() const = 0;
+	
+	virtual bool isHighlighted() const;
+	virtual void setHighlighted(bool);
+	void paint(QPainter *, const QStyleOptionGraphicsItem *, QWidget *);
+	QRectF boundingRect() const;
+	QSize setSize(int, int);
+	QSize size() const;
+	QPixmap  pixmap();
+	
+	// methods related to the hotspot
+	QPoint setHotspot(QPoint);
+	QPoint hotspot() const;
+	
+	// selection-related methods
+	void select();
+	void deselect();	
+	
+	// methods related to internal connections
+	bool internalConnections();
+	void setInternalConnections(bool);
+	virtual void rotateBy(const qreal &);
+	
+	// methods related to XML import/export
+	static bool valideXml(QDomElement &);
+	virtual bool fromXml(QDomElement &, QHash<int, Terminal *> &, bool = false);
+	virtual QDomElement toXml(QDomDocument &, QHash<Terminal *, int> &) const;
+	
+	// orientation-related methods
+	int orientation() const;
+	
+	protected:
+	void drawAxes(QPainter *, const QStyleOptionGraphicsItem *);
+	
+	private:
+	bool internal_connections_;
+	bool must_highlight_;
+	void drawSelection(QPainter *, const QStyleOptionGraphicsItem *);
+	void drawHighlight(QPainter *, const QStyleOptionGraphicsItem *);
+	void updatePixmap();
+};
+
+/**
+	Indicate whether this element allows internal connections, i.e. whether its
+	terminals can be linked together using a conductor.
+	@return true if internal connections are accepted, false otherwise
+*/
+inline bool Element::internalConnections() {
+	return(internal_connections_);
+}
+
+/**
+	Specify whether this element allows internal connections, i.e. whether its
+	terminals can be linked together using a conductor.
+	@return true for internal connections to be accepted, false otherwise
+*/
+inline void Element::setInternalConnections(bool ic) {
+	internal_connections_ = ic;
+}
+
+/**
+	Indicate the current orientation of this element
+	O = 0°
+	1 = 90°
+	2 = 180°
+	3 = 270°
+	@return the current orientation of this element
+*/
+inline int Element::orientation() const {
+	return(QET::correctAngle(rotation())/90);
+}
+
+#endif