elias/egui_node_graph
1
0
Fork 0
mirror of https://github.com/eliasstepanik/egui_node_graph.git synced 2026-01-10 05:18:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

update WidgetValueTrait::value_widget* comments

Browse Source
This commit is contained in:
Kamil Koczurek 2023-05-08 10:41:02 +02:00
parent 3b5198c050
commit 9c8d5f3258
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
egui_node_graph/src/traits.rs
View File

@ -14,10 +14,11 @@ pub trait WidgetValueTrait: Default {
type UserState;
type NodeData;
/// This method will be called for each input parameter with a widget. The
/// return value is a vector of custom response objects which can be used
/// This method will be called for each input parameter with a widget with an disconnected
/// input only. To display UI for connected inputs use [`WidgetValueTrait::value_widget_connected`].
/// The return value is a vector of custom response objects which can be used
/// to implement handling of side effects. If unsure, the response Vec can
/// be empty. It isn't called if the input is connected.
/// be empty.
fn value_widget(
&mut self,
param_name: &str,
@ -27,11 +28,13 @@ pub trait WidgetValueTrait: Default {
node_data: &Self::NodeData,
) -> Vec<Self::Response>;
/// This method will be called for each input parameter with a widget. The
/// return value is a vector of custom response objects which can be used
/// This method will be called for each input parameter with a widget with a connected
/// input only. To display UI for diconnected inputs use [`WidgetValueTrait::value_widget`].
/// The return value is a vector of custom response objects which can be used
/// to implement handling of side effects. If unsure, the response Vec can
/// be empty. This differs from [`WidgetValueTrait::value_widget`]
/// by being called if and only if the input has a connection.
/// be empty.
///
/// Shows the input name label by default.
fn value_widget_connected(
&mut self,
param_name: &str,