From 4f929a0fdfae24b1ca5acf0b732219119090ee43 Mon Sep 17 00:00:00 2001 From: Juan Linietsky Date: Tue, 12 Sep 2017 17:42:36 -0300 Subject: Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. --- doc/classes/GraphNode.xml | 365 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 365 insertions(+) create mode 100644 doc/classes/GraphNode.xml (limited to 'doc/classes/GraphNode.xml') diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml new file mode 100644 index 000000000..f6a12497b --- /dev/null +++ b/doc/classes/GraphNode.xml @@ -0,0 +1,365 @@ + + + + A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. + + + A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. + + + + + + + + + + + Disable all input and output slots of the GraphNode. + + + + + + + + + Disable input and output slot whose index is 'idx'. + + + + + + + + + Return the color of the input connection 'idx'. + + + + + + + Return the number of enabled input slots (connections) to the GraphNode. + + + + + + + + + Return the position of the input connection 'idx'. + + + + + + + + + Return the type of the input connection 'idx'. + + + + + + + + + Return the color of the output connection 'idx'. + + + + + + + Return the number of enabled output slots (connections) of the GraphNode. + + + + + + + + + Return the position of the output connection 'idx'. + + + + + + + + + Return the type of the output connection 'idx'. + + + + + + + Return the offset of the GraphNode. + + + + + + + + + + + + + + + Return the color set to 'idx' left (input) slot. + + + + + + + + + Return the color set to 'idx' right (output) slot. + + + + + + + + + Return the (integer) type of left (input) 'idx' slot. + + + + + + + + + Return the (integer) type of right (output) 'idx' slot. + + + + + + + Return the title of the GraphNode. + + + + + + + Returns true if the close button is shown. False otherwise. + + + + + + + + + + + + + + + + + + + + + + + + + + + Return true if left (input) slot 'idx' is enabled. False otherwise. + + + + + + + + + Return true if right (output) slot 'idx' is enabled. False otherwise. + + + + + + + + + + + + + + + + + Set the offset of the GraphNode. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Set the title of the GraphNode. + + + + + + + + + + + + + + + Signal sent on closing the GraphNode. + + + + + + + + + Signal sent when the GraphNode is dragged. + + + + + Signal sent when the GraphNode is moved. + + + + + Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3-70-g09d2