aw/valentina
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation for nodes.

Browse Source 
--HG--
branch : develop
This commit is contained in:
dismine 2014-01-27 12:59:41 +02:00
parent 84fce7ec86
commit b711410ee6
5 changed files with 102 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/tools/nodeDetails/vabstractnode.h
View File

@ -32,42 +32,42 @@
#include "../vabstracttool.h"
/**
* @brief The VAbstractNode class
* @brief The VAbstractNode class parent class for all detail node.
*/
class VAbstractNode : public VAbstractTool
{
Q_OBJECT
public:
/**
* @brief VAbstractNode
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerNode
* @param parent parent object
* @brief VAbstractNode constructor.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerNode.
* @param parent parent object.
*/
VAbstractNode(VDomDocument *doc, VContainer *data, const qint64 &id, const qint64 &idNode,
const qint64 &idTool, QObject *parent = 0);
virtual ~VAbstractNode() {}
/**
* @brief AttrIdObject
*/
static const QString AttrIdObject;
static const QString AttrIdTool;
virtual void DeleteNode();
protected:
/**
* @brief idNode
* @brief idNodenode id.
*/
qint64 idNode;
/**
* @brief idTool id tool.
*/
qint64 idTool;
/**
* @brief AddToModeling
* @param domElement
* @brief AddToModeling add tag to modeling tag current pattern peace.
* @param domElement tag.
*/
void AddToModeling(const QDomElement &domElement);
/**
* @brief decrementReferens
* @brief decrementReferens decrement reference for all parent objects.
*/
virtual void decrementReferens();
};

43
src/tools/nodeDetails/vnodearc.h
View File

@ -33,43 +33,40 @@
#include <QGraphicsPathItem>
/**
* @brief The VNodeArc class
* @brief The VNodeArc class arc detail node.
*/
class VNodeArc :public VAbstractNode, public QGraphicsPathItem
{
Q_OBJECT
public:
/**
* @brief VNodeArc
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerArc
* @brief VNodeArc constructor.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerArc.
* @param typeCreation way we create this tool.
* @param parent parent object
* @param parent parent object.
*/
VNodeArc(VDomDocument *doc, VContainer *data, qint64 id, qint64 idArc,
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0);
/**
* @brief Create help create tool
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerArc
* @brief Create help create tool.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerArc.
* @param parse parser file mode.
* @param typeCreation way we create this tool.
*/
static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idArc, const Document::Documents &parse,
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *parent = 0);
/**
* @brief TagName
*/
static const QString TagName;
/**
* @brief ToolType
*/
static const QString ToolType;
/**
* @brief DeleteNode delete node from detail.
*/
virtual void DeleteNode();
public slots:
/**
@ -86,23 +83,23 @@ protected:
*/
virtual void RefreshDataInFile();
/**
* @brief mouseReleaseEvent handle mouse release events.
* @param event
* @brief mouseReleaseEvent handle mouse release events.
* @param event mouse release event.
*/
virtual void mouseReleaseEvent ( QGraphicsSceneMouseEvent * event );
/**
* @brief hoverMoveEvent handle hover move events.
* @param event
* @param event hover move event.
*/
virtual void hoverMoveEvent ( QGraphicsSceneHoverEvent * event );
/**
* @brief hoverLeaveEvent handle hover leave events.
* @param event
* @param event hover leave event.
*/
virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * event );
private:
/**
* @brief RefreshGeometry refresh item on scene.
* @brief RefreshGeometry refresh item on scene.
*/
void RefreshGeometry();
};

59
src/tools/nodeDetails/vnodepoint.h
View File

@ -33,44 +33,41 @@
#include "../../widgets/vgraphicssimpletextitem.h"
/**
* @brief The VNodePoint class
* @brief The VNodePoint class point detail node.
*/
class VNodePoint: public VAbstractNode, public QGraphicsEllipseItem
{
Q_OBJECT
public:
/**
* @brief VNodePoint
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerPoint
* @brief VNodePoint constructor.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerPoint.
* @param typeCreation way we create this tool.
* @param parent parent object
* @param parent parent object.
*/
VNodePoint(VDomDocument *doc, VContainer *data, qint64 id, qint64 idPoint,
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0 );
/**
* @brief Create help create tool
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerPoint
* @brief Create help create tool.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerPoint.
* @param parse parser file mode.
* @param typeCreation way we create this tool.
*/
static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idPoint,
const Document::Documents &parse, const Tool::Sources &typeCreation, const qint64 &idTool = 0,
QObject *parent = 0);
/**
* @brief TagName
*/
static const QString TagName;
/**
* @brief ToolType
*/
static const QString ToolType;
/**
* @brief DeleteNode delete node from detail.
*/
virtual void DeleteNode();
public slots:
/**
@ -78,21 +75,21 @@ public slots:
*/
virtual void FullUpdateFromFile();
/**
* @brief NameChangePosition
* @param pos
* @brief NameChangePosition label change position.
* @param pos new position.
*/
void NameChangePosition(const QPointF &pos);
protected:
/**
* @brief radius
* @brief radius radius circle.
*/
qreal radius;
/**
* @brief namePoint
* @brief namePoint label name.
*/
VGraphicsSimpleTextItem *namePoint;
/**
* @brief lineName
* @brief lineName pointer to label line.
*/
QGraphicsLineItem *lineName;
/**
@ -104,33 +101,33 @@ protected:
*/
virtual void RefreshDataInFile();
/**
* @brief mouseReleaseEvent handle mouse release events.
* @param event
* @brief mouseReleaseEvent handle mouse release events.
* @param event mouse release event.
*/
virtual void mouseReleaseEvent ( QGraphicsSceneMouseEvent * event );
/**
* @brief hoverMoveEvent handle hover move events.
* @param event
* @param event hover move event.
*/
virtual void hoverMoveEvent ( QGraphicsSceneHoverEvent * event );
/**
* @brief hoverLeaveEvent handle hover leave events.
* @param event
* @param event hover leave event.
*/
virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * event );
/**
* @brief UpdateNamePosition
* @brief UpdateNamePosition update label position in file.
* @param mx label bias x axis.
* @param my label bias y axis.
*/
virtual void UpdateNamePosition(qreal mx, qreal my);
/**
* @brief RefreshPointGeometry
* @param point
* @brief RefreshPointGeometry refresh point on scene.
* @param point point position.
*/
virtual void RefreshPointGeometry(const VPointF &point);
/**
* @brief RefreshLine
* @brief RefreshLine refresh label line on scene.
*/
void RefreshLine();
private:

43
src/tools/nodeDetails/vnodespline.h
View File

@ -33,30 +33,30 @@
#include <QGraphicsPathItem>
/**
* @brief The VNodeSpline class
* @brief The VNodeSpline class spline detail node.
*/
class VNodeSpline:public VAbstractNode, public QGraphicsPathItem
{
Q_OBJECT
public:
/**
* @brief VNodeSpline
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerSpline
* @brief VNodeSpline constructor.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerSpline.
* @param typeCreation way we create this tool.
* @param parent parent object
* @param parent parent object.
*/
VNodeSpline(VDomDocument *doc, VContainer *data, qint64 id, qint64 idSpline,
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0);
/**
* @brief Create help create tool
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerSpline
* @brief Create help create tool.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerSpline.
* @param parse parser file mode.
* @param typeCreation way we create this tool.
* @return
@ -64,14 +64,11 @@ public:
static VNodeSpline *Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idSpline,
const Document::Documents &parse, const Tool::Sources &typeCreation,
const qint64 &idTool = 0, QObject *parent = 0);
/**
* @brief TagName
*/
static const QString TagName;
/**
* @brief ToolType
*/
static const QString ToolType;
/**
* @brief DeleteNode delete node from detail.
*/
virtual void DeleteNode();
public slots:
/**
@ -88,23 +85,23 @@ protected:
*/
virtual void RefreshDataInFile();
/**
* @brief mouseReleaseEvent handle mouse release events.
* @param event
* @brief mouseReleaseEvent handle mouse release events.
* @param event mouse release event.
*/
virtual void mouseReleaseEvent ( QGraphicsSceneMouseEvent * event );
/**
* @brief hoverMoveEvent handle hover move events.
* @param event
* @param event hover move event.
*/
virtual void hoverMoveEvent ( QGraphicsSceneHoverEvent * event );
/**
* @brief hoverLeaveEvent handle hover leave events.
* @param event
* @param event hover leave event.
*/
virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * event );
private:
/**
* @brief RefreshGeometry refresh item on scene.
* @brief RefreshGeometry refresh item on scene.
*/
void RefreshGeometry ();
};

43
src/tools/nodeDetails/vnodesplinepath.h
View File

@ -33,44 +33,41 @@
#include <QGraphicsPathItem>
/**
* @brief The VNodeSplinePath class
* @brief The VNodeSplinePath class spline path detail node.
*/
class VNodeSplinePath : public VAbstractNode, public QGraphicsPathItem
{
Q_OBJECT
public:
/**
* @brief VNodeSplinePath
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerSpline
* @brief VNodeSplinePath constructor.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerSpline.
* @param typeCreation way we create this tool.
* @param parent parent object
* @param parent parent object.
*/
VNodeSplinePath(VDomDocument *doc, VContainer *data, qint64 id, qint64 idSpline,
const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0,
QGraphicsItem * parent = 0);
/**
* @brief Create help create tool
* @param doc dom document container
* @param data container with variables
* @param id object id in container
* @param id object id in containerSpline
* @brief Create help create tool.
* @param doc dom document container.
* @param data container with variables.
* @param id object id in container.
* @param id object id in containerSpline.
* @param parse parser file mode.
* @param typeCreation way we create this tool.
*/
static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idSpline,
const Document::Documents &parse, const Tool::Sources &typeCreation, const qint64 &idTool = 0,
QObject *parent = 0);
/**
* @brief TagName
*/
static const QString TagName;
/**
* @brief ToolType
*/
static const QString ToolType;
/**
* @brief DeleteNode delete node from detail.
*/
virtual void DeleteNode();
public slots:
/**
@ -87,23 +84,23 @@ protected:
*/
virtual void RefreshDataInFile();
/**
* @brief mouseReleaseEvent handle mouse release events.
* @param event
* @brief mouseReleaseEvent handle mouse release events.
* @param event mouse release event.
*/
virtual void mouseReleaseEvent ( QGraphicsSceneMouseEvent * event );
/**
* @brief hoverMoveEvent handle hover move events.
* @param event
* @param event hover move event.
*/
virtual void hoverMoveEvent ( QGraphicsSceneHoverEvent * event );
/**
* @brief hoverLeaveEvent handle hover leave events.
* @param event
* @param event hover leave event.
*/
virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * event );
private:
/**
* @brief RefreshGeometry refresh item on scene.
* @brief RefreshGeometry refresh item on scene.
*/
void RefreshGeometry();
};