summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdhitya Kamakshidasan2016-06-06 02:55:26 +0530
committerAdhitya Kamakshidasan2016-06-06 02:55:26 +0530
commita228688904c86e9c14ffab1e6e0d374d95436c94 (patch)
tree93e9f122886a8858a6d627d228523b234b4ef71d
parent42e35e62c8863add885c868f591412bb1813dd9c (diff)
parent4817f2f547755da5bf09a5612e9ad7656c569d90 (diff)
downloadxcos-on-web-a228688904c86e9c14ffab1e6e0d374d95436c94.tar.gz
xcos-on-web-a228688904c86e9c14ffab1e6e0d374d95436c94.tar.bz2
xcos-on-web-a228688904c86e9c14ffab1e6e0d374d95436c94.zip
Merge pull request #11 from jiteshjha/documentation-folder
New documentation folder added
-rw-r--r--Documentation/Wires connection.md (renamed from DOCUMENTATION.md)1
-rw-r--r--Documentation/Wires connection.md~35
-rw-r--r--PULL_REQUEST_TEMPLATE.md~8
3 files changed, 36 insertions, 8 deletions
diff --git a/DOCUMENTATION.md b/Documentation/Wires connection.md
index 32e1a12..d75087d 100644
--- a/DOCUMENTATION.md
+++ b/Documentation/Wires connection.md
@@ -1,4 +1,5 @@
# XCOS Wires Connection
+#### @jiteshjha @pooja
### function connectionHandlerIsStartEvent()
diff --git a/Documentation/Wires connection.md~ b/Documentation/Wires connection.md~
new file mode 100644
index 0000000..d75087d
--- /dev/null
+++ b/Documentation/Wires connection.md~
@@ -0,0 +1,35 @@
+# XCOS Wires Connection
+#### @jiteshjha @pooja
+
+### function connectionHandlerIsStartEvent()
+
+ - Starts connections on the background in wire-mode.
+ - function connectionHandlerMouseUp() depends on this function.
+
+### function connectionHandlerMouseUp()
+
+ - Avoids any connections for gestures within tolerance except when in wire-mode or when over a port.
+ - Responsible for the removal of self connections over an mxCell (edges or vertices) in wire-mode.
+
+### function updateFixedTerminalPoint()
+
+ - Updates connection points before the routing is called.
+ - Enables connection from any point on an edge.
+ - Without this function, default edge characteristics ( mid-point-specific connections only) come in play.
+
+### function createEdgeState()
+
+ - Overrides methods to preview and create new edges.
+ - Enables horizontal and vertical edges in preview state.
+ - Without this function, any connection from an edge will have it's source point and target point chosen based on the assumed center of a straight edge having source edge's source point and target point.
+
+### function createMarker()
+
+ - Adds in-place highlighting for complete cell area (no hotspot).
+ - Uses complete area of cell for new connections.
+ - Adds in-place highlighting when reconnecting existing edges.
+
+### function WireConnector()
+
+ - Creates a custom horizontal and vertical edge style.
+ - Without this function, the source and terminal of a connection from an source edge is assumed as if the source edge were an perpendicular connection.
diff --git a/PULL_REQUEST_TEMPLATE.md~ b/PULL_REQUEST_TEMPLATE.md~
deleted file mode 100644
index e66c1bd..0000000
--- a/PULL_REQUEST_TEMPLATE.md~
+++ /dev/null
@@ -1,8 +0,0 @@
-Make sure these boxes are checked before your pull request is ready to be reviewed and merged. Thanks!
-
-* [ ] code is in uniquely-named feature branch, and has been rebased on top of latest master (especially if you've been asked to make additional changes)
-* [ ] pull request are descriptively named
-* [ ] if possible, multiple commits squashed if they're smaller changes
-* [ ] reviewed/confirmed/tested by another contributor or maintainer
-
-Thanks!