Merge pull request #195 from SainsburyWellcomeCentre/aeon-environment

Add labeled button UI element

src/Aeon.Environment/Aeon.Environment.csproj

@@ -7,7 +7,7 @@
     <PackageTags>Bonsai Rx Project Aeon Environment</PackageTags>
     <TargetFramework>net472</TargetFramework>
     <VersionPrefix>0.1.0</VersionPrefix>
-    <VersionSuffix>build231015</VersionSuffix>
+    <VersionSuffix>build231208</VersionSuffix>
   </PropertyGroup>
 
   <ItemGroup>

src/Aeon.Environment/Aeon.Environment.csproj.user

@@ -5,6 +5,9 @@
     <Compile Update="AnnotationControl.cs">
       <SubType>UserControl</SubType>
     </Compile>
+    <Compile Update="ButtonControl.cs">
+      <SubType>UserControl</SubType>
+    </Compile>
     <Compile Update="EnvironmentStateControl.cs">
       <SubType>UserControl</SubType>
     </Compile>

src/Aeon.Environment/ButtonControl.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Windows.Forms;
+
+namespace Aeon.Environment
+{
+    partial class ButtonControl : UserControl
+    {
+        public ButtonControl(ButtonSource source)
+        {
+            Source = source ?? throw new ArgumentNullException(nameof(source));
+            InitializeComponent();
+            var text = Source.Text;
+            if (!string.IsNullOrEmpty(text))
+            {
+                button.Text = text;
+            }
+        }
+
+        public ButtonSource Source { get; }
+
+        private void button_Click(object sender, EventArgs e)
+        {
+            Source.OnNext(button.Text);
+        }
+    }
+}

src/Aeon.Environment/ButtonControl.resx

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!-- 
+    Microsoft ResX Schema 
+    
+    Version 2.0
+    
+    The primary goals of this format is to allow a simple XML format 
+    that is mostly human readable. The generation and parsing of the 
+    various data types are done through the TypeConverter classes 
+    associated with the data types.
+    
+    Example:
+    
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+                
+    There are any number of "resheader" rows that contain simple 
+    name/value pairs.
+    
+    Each data row contains a name, and value. The row also contains a 
+    type or mimetype. Type corresponds to a .NET class that support 
+    text/value conversion through the TypeConverter architecture. 
+    Classes that don't support this are serialized and stored with the 
+    mimetype set.
+    
+    The mimetype is used for serialized objects, and tells the 
+    ResXResourceReader how to depersist the object. This is currently not 
+    extensible. For a given mimetype the value must be set accordingly:
+    
+    Note - application/x-microsoft.net.object.binary.base64 is the format 
+    that the ResXResourceWriter will generate, however the reader can 
+    read any of the formats listed below.
+    
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+    
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array 
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+</root>

src/Aeon.Environment/ButtonSource.cs

@@ -0,0 +1,14 @@
+using System.ComponentModel;
+using Aeon.Acquisition;
+using Bonsai;
+
+namespace Aeon.Environment
+{
+    [TypeVisualizer(typeof(ButtonSourceVisualizer))]
+    [Description("Provides a labeled button control generating a sequence of events for each button click.")]
+    public class ButtonSource : MetadataSource<string>
+    {
+        [Description("Specifies the text associated with this button.")]
+        public string Text { get; set; }
+    }
+}

src/Aeon.Environment/ButtonSourceVisualizer.cs

@@ -0,0 +1,41 @@
+using Bonsai.Design;
+using Bonsai.Expressions;
+using System;
+using System.Windows.Forms;
+
+namespace Aeon.Environment
+{
+    public class ButtonSourceVisualizer : DialogTypeVisualizer
+    {
+        ButtonControl control;
+
+        public override void Load(IServiceProvider provider)
+        {
+            var context = (ITypeVisualizerContext)provider.GetService(typeof(ITypeVisualizerContext));
+            var visualizerElement = ExpressionBuilder.GetVisualizerElement(context.Source);
+            var source = (ButtonSource)ExpressionBuilder.GetWorkflowElement(visualizerElement.Builder);
+
+            control = new ButtonControl(source);
+            control.Dock = DockStyle.Fill;
+
+            var visualizerService = (IDialogTypeVisualizerService)provider.GetService(typeof(IDialogTypeVisualizerService));
+            if (visualizerService != null)
+            {
+                visualizerService.AddControl(control);
+            }
+        }
+
+        public override void Show(object value)
+        {
+        }
+
+        public override void Unload()
+        {
+            if (control != null)
+            {
+                control.Dispose();
+                control = null;
+            }
+        }
+    }
+}

src/Aeon.Environment/TareWeightVisualizer.cs

@@ -1,8 +1,6 @@
 using Bonsai.Design;
 using Bonsai.Expressions;
 using System;
-using System.Drawing;
-using System.Reactive;
 using System.Windows.Forms;
 
 namespace Aeon.Environment