Skip to content

Commit

Permalink
Add default annotation editor with markdown lexer
Browse files Browse the repository at this point in the history
  • Loading branch information
glopesdev committed Mar 31, 2023
1 parent 5ddb87c commit 13abe95
Show file tree
Hide file tree
Showing 6 changed files with 344 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Bonsai.Core/Expressions/AnnotationBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ namespace Bonsai.Expressions
[DefaultProperty(nameof(Name))]
[WorkflowElementCategory(ElementCategory.Property)]
[XmlType("Annotation", Namespace = Constants.XmlNamespace)]
[Editor("Bonsai.Design.AnnotationBuilderEditor, Bonsai.Design", typeof(ComponentEditor))]
[Description("Represents a written explanation or critical comment added to the workflow.")]
public class AnnotationBuilder : ExpressionBuilder, INamedElement, IArgumentBuilder
{
Expand All @@ -33,7 +34,6 @@ public class AnnotationBuilder : ExpressionBuilder, INamedElement, IArgumentBuil
[XmlIgnore]
[Externalizable(false)]
[Category(nameof(CategoryAttribute.Design))]
[Editor(DesignTypes.MultilineStringEditor, DesignTypes.UITypeEditor)]
[Description("The text associated with this annotation.")]
public string Text { get; set; }

Expand Down
35 changes: 35 additions & 0 deletions Bonsai.Design/AnnotationBuilderEditor.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
using System;
using System.ComponentModel;
using System.Windows.Forms;
using Bonsai.Expressions;

namespace Bonsai.Design
{
/// <summary>
/// Provides a user interface editor that displays a dialog box for editing
/// a workflow annotation.
/// </summary>
public class AnnotationBuilderEditor : WorkflowComponentEditor
{
/// <inheritdoc/>
public override bool EditComponent(ITypeDescriptorContext context, object component, IServiceProvider provider, IWin32Window owner)
{
if (provider != null)
{
var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
if (editorState != null && !editorState.WorkflowRunning && component is AnnotationBuilder annotationBuilder)
{
using var editorDialog = new AnnotationBuilderEditorDialog();
editorDialog.Annotation = annotationBuilder.Text;
if (editorDialog.ShowDialog(owner) == DialogResult.OK)
{
annotationBuilder.Text = editorDialog.Annotation;
}
return true;
}
}

return false;
}
}
}
96 changes: 96 additions & 0 deletions Bonsai.Design/AnnotationBuilderEditorDialog.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

88 changes: 88 additions & 0 deletions Bonsai.Design/AnnotationBuilderEditorDialog.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
using ScintillaNET;
using System;
using System.Drawing;
using System.Windows.Forms;

namespace Bonsai.Design
{
internal partial class AnnotationBuilderEditorDialog : Form
{
public AnnotationBuilderEditorDialog()
{
InitializeComponent();
scintilla.StyleResetDefault();
scintilla.Styles[Style.Default].Font = "Consolas";
scintilla.Styles[Style.Default].Size = 10;
scintilla.StyleClearAll();

scintilla.CaretLineBackColor = ColorTranslator.FromHtml("#feefff");
scintilla.Styles[Style.Markdown.Default].ForeColor = Color.Black;
scintilla.Styles[Style.Markdown.Link].Underline = true;
scintilla.Styles[Style.Markdown.Em1].Italic = true;
scintilla.Styles[Style.Markdown.Em2].Italic = true;
scintilla.Styles[Style.Markdown.Strong1].Bold = true;
scintilla.Styles[Style.Markdown.Strong2].Bold = true;
scintilla.Styles[Style.Markdown.Header1].Bold = true;
scintilla.Styles[Style.Markdown.Header2].Bold = true;
scintilla.Styles[Style.Markdown.Header3].Bold = true;
scintilla.Styles[Style.Markdown.Header4].Bold = true;
scintilla.Styles[Style.Markdown.Header5].Bold = true;
scintilla.Styles[Style.Markdown.Header6].Bold = true;
scintilla.Styles[Style.Markdown.Strong1].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Strong2].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Header1].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Header2].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Header3].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Header4].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Header5].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Header6].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.UListItem].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.OListItem].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.HRule].ForeColor = ColorTranslator.FromHtml("#2b91af");
scintilla.Styles[Style.Markdown.Code].ForeColor = ColorTranslator.FromHtml("#a31515");
scintilla.Styles[Style.Markdown.Code2].ForeColor = ColorTranslator.FromHtml("#a31515");
scintilla.Styles[Style.Markdown.CodeBk].ForeColor = ColorTranslator.FromHtml("#a31515");
scintilla.Styles[Style.Markdown.BlockQuote].ForeColor = ColorTranslator.FromHtml("#a31515");
scintilla.Lexer = Lexer.Markdown;
}

public string Annotation { get; set; }

protected override void OnLoad(EventArgs e)
{
scintilla.Text = Annotation;
scintilla.EmptyUndoBuffer();
if (Owner != null)
{
Icon = Owner.Icon;
ShowIcon = true;
}

base.OnLoad(e);
}

protected override void OnKeyDown(KeyEventArgs e)
{
if (e.KeyCode == Keys.Escape && !e.Handled)
{
Close();
e.Handled = true;
}

base.OnKeyDown(e);
}

private void scintilla_KeyDown(object sender, KeyEventArgs e)
{
if (e.KeyCode == Keys.Enter && e.Modifiers == Keys.Control)
{
okButton.PerformClick();
}
}

private void scintilla_TextChanged(object sender, EventArgs e)
{
Annotation = scintilla.Text;
}
}
}
120 changes: 120 additions & 0 deletions Bonsai.Design/AnnotationBuilderEditorDialog.resx
Original file line number Diff line number Diff line change
@@ -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>
5 changes: 4 additions & 1 deletion Bonsai.Design/Bonsai.Design.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@
<PackageTags>Bonsai Design Rx Reactive Extensions</PackageTags>
<UseWindowsForms>true</UseWindowsForms>
<TargetFramework>net462</TargetFramework>
<VersionPrefix>2.7.1</VersionPrefix>
<VersionPrefix>2.8.0</VersionPrefix>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="jacobslusser.ScintillaNET" Version="3.6.3" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\Bonsai.Core\Bonsai.Core.csproj" />
</ItemGroup>
Expand Down

0 comments on commit 13abe95

Please sign in to comment.