[105ed6]: src / interfaces / component / connector.h Maximize Restore History

Download this file

connector.h    89 lines (76 with data), 2.9 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
Copyright (C) 2010 Julian B채ume <julian@svg4all.de>
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.
This program 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 this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef KTECHLAB_CONNECTOR_H
#define KTECHLAB_CONNECTOR_H
#include <QtCore/QObject>
#include <QVariantMap>
class QPainterPath;
namespace KTechLab {
class Node;
class ConnectorPrivate;
/**
* \short Represent a connection between 2 components on a document.
* A Connector consists of the following data:
* \li id - unique identifier of the connector
* \li route - a string representation of a QPainterPath
* \li end-node-is-child - 1 -> node belongs to component; 0 -> otherwise
* \li end-node-id - id of the node; only set if end-node-is-child == 0
* \li end-node-cid - id of the connection; only set if end-node-is-child == 1
* \li end-node-parent - id of the end-node-cid parent; only set if end-node-is-child == 1
* \li start-node-is-child - 1 -> node belongs to component; 0 -> otherwise
* \li start-node-id - id of the node; only set if start-node-is-child == 0
* \li start-node-cid - id of the connection; only set if start-node-is-child == 1
* \li start-node-parent - id of the start-node-cid parent; only set if start-node-is-child == 1
* \li manual-route - 1 -> route is layed out manually; 0 -> otherwise
* \li (router - name of the routing plugin that created the route)
*/
class Connector : public QObject
{
Q_OBJECT
public:
/**
* Create a new instance given the connector data.
*/
Connector(const QVariantMap &connectorData, QObject* parent = 0);
/**
* Copy constructor
*/
Connector(const Connector& connector);
virtual ~Connector();
/**
* Set the path to a specific route
*/
void setRoute(const QPainterPath& route);
/**
* Set the node, where the route starts
*/
void setStartNode(const Node& node);
/**
* Set the node, where the route ends
*/
void setEndNode(const Node& node);
/**
* Get a path representing the route of the connector
*/
QPainterPath route() const;
private:
/**
* Get connector data as a \class QVariantMap
*/
QVariantMap data() const;
ConnectorPrivate *d;
};
}
#endif // KTECHLAB_CONNECTOR_H