From b81843ee6c26312dc9ce70002ce8ae80de8868d0 Mon Sep 17 00:00:00 2001 From: Michael Alexsander Date: Tue, 7 Jan 2020 22:05:32 -0300 Subject: [PATCH] Complete docs for GraphEdit/Node and PopupMenu --- doc/classes/GraphEdit.xml | 18 ++++++++++-------- doc/classes/GraphNode.xml | 23 +++++++++++++++++------ doc/classes/PopupMenu.xml | 2 ++ 3 files changed, 29 insertions(+), 14 deletions(-) diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 3041a7cb7fa..c143471f80c 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -160,6 +160,7 @@ + Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [code]activity[/code] theme property. @@ -194,12 +195,12 @@ - Signal sent at the beginning of a GraphNode movement. + Emitted at the beginning of a GraphNode movement. - Signal sent at the end of a GraphNode movement. + Emitted at the end of a GraphNode movement. @@ -210,7 +211,7 @@ - Signal sent when user dragging connection from input port into empty space of the graph. + Emitted when user dragging connection from input port into empty space of the graph. @@ -223,7 +224,7 @@ - Signal sent to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created. + Emitted to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created. @@ -234,17 +235,17 @@ - Signal sent when user dragging connection from output port into empty space of the graph. + Emitted when user dragging connection from output port into empty space of the graph. - Signal sent when the user presses [code]Ctrl + C[/code]. + Emitted when the user presses [code]Ctrl + C[/code]. - Signal sent when a GraphNode is attempted to be removed from the GraphEdit. + Emitted when a GraphNode is attempted to be removed from the GraphEdit. @@ -274,7 +275,7 @@ - Signal sent when the user presses [code]Ctrl + V[/code]. + Emitted when the user presses [code]Ctrl + V[/code]. @@ -288,6 +289,7 @@ + Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 77b3eb1ca07..8fda9c20a53 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -170,12 +170,12 @@ - Sets properties of the slot with id [code]idx[/code]. + Sets properties of the slot with ID [code]idx[/code]. If [code]enable_left[/code]/[code]right[/code], a port will appear and the slot will be able to be connected from this side. [code]type_left[/code]/[code]right[/code] is an arbitrary type of the port. Only ports with the same type values can be connected. [code]color_left[/code]/[code]right[/code] is the tint of the port's icon on this side. [code]custom_left[/code]/[code]right[/code] is a custom texture for this side's port. - [b]Note:[/b] this method only sets properties of the slot. To create the slot, add a [Control]-derived child to the GraphNode. + [b]Note:[/b] This method only sets properties of the slot. To create the slot, add a [Control]-derived child to the GraphNode. @@ -188,20 +188,27 @@ [b]Note:[/b] You cannot use position directly, as [GraphEdit] is a [Container]. + Sets the overlay shown above the GraphNode. See [enum Overlay]. + If [code]true[/code], the user can resize the GraphNode. + [b]Note:[/b] Dragging the handle will only trigger the [signal resize_request] signal, the GraphNode needs to be resized manually. + If [code]true[/code], the GraphNode is selected. + If [code]true[/code], the close button will be visible. + [b]Note:[/b] Pressing it will only trigger the [signal close_request] signal, the GraphNode needs to be removed manually. + The text displayed in the GraphNode's title bar. - Signal sent on closing the GraphNode. + Emitted when the GraphNode is requested to be closed. Happens on clicking the close button (see [member show_close]). @@ -210,32 +217,36 @@ - Signal sent when the GraphNode is dragged. + Emitted when the GraphNode is dragged. - Signal sent when the GraphNode is moved. + Emitted 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. + Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]). + No overlay is shown. + Show overlay set in the [code]breakpoint[/code] theme property. + Show overlay set in the [code]position[/code] theme property. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index c920b52df64..89039eebda2 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -521,6 +521,7 @@ + Sets the state of an multistate item. See [method add_multistate_item] for details. @@ -595,6 +596,7 @@ + Cycle to the next state of an multistate item. See [method add_multistate_item] for details.