.NET binding library for Pashua, a macOS tool for displaying dialog boxes. The use case for this is small utilities where it would be nice to have a GUI but the overhead of using something like Xamarin Mac is not justified.
Only v0.11 of Pashua has been tested (this is the latest version as of writing this).
.NET Standard 2.0, C#
MIT
There is one class for every element type described in the official Pashua documentation, each of which has properties that correspond to the documented fields. One notable special case is the Date class, which has the two boolean options replaced with a SelectionMode enumeration property for whether times/dates/both can be selected.
A "script" for the purposes of this library is just an IEnumerable<IPashuaControl>.
There is an extension method on IEnumerable<IPashuaControl> called RunScript. This is a synchronous blocking call.
By default, the library will look in the following locations for Pashua:
/Applications/Pashua.app~/Applications/Pashua.app./Pashua.app
However, the RunScript method takes an optional parameter for a custom location for Pashua.app. This should be a path that includes the app, for example ~/PortableApp/Pashua.app.
RunScript will check all the controls for validation issues before executing the script and will throw a PashuaScriptException that contains all the issues found.
The name of the element in the Pashua script is handled automatically. You can get access to it with the Id property, but there shouldn't be a reason to use it in normal use.
Each control type that has output also has a property of an appropriate Action type (for example, Action for Button.Clicked or Action<DateTime> for Date.TimestampChosen) that will be called when the Pashua output is parsed.
For controls like Button or CheckBox where the user might not interact with it, the action will simply not be called if the user doesn't click that control. All other controls will pass along something even if it's just an empty string.
Action properties:
Button.ClickedCancelButton.ClickedCheckBox.CheckedComboBox.OptionSelectedDate.TimestampChosenDefaultButton.ClickedOpenBrowser.PathSelectedPassword.TextEnteredPopup.OptionSelectedRadioButton.OptionSelectedSaveBrowser.PathSelectedTextBox.TextEnteredTextField.TextEntered
All the controls implement IPashuaControl which has a WriteTo(TextWriter) method. If you want to see the script that will be sent to Pashua, there is also an extension method on IEnumerable<IPashuaScript> called WriteTo that can be used:
List<IPashuaControl> script = ...
script.WriteTo(Console.Out); // Or use a StreamWriter to a file or somethingIf for some reason you want to validate the script without running it, that can be done with GetScriptValidationIssues:
var allIssues = script.GetScriptValidationIssues();See the Demo project for examples of all the control types.
The demo can be run with the following command:
dotnet run --project src/PashuaNetBindings.Demo/PashuaNetBindings.Demo.csproj
string thoughts = null;
var script = new List<IPashuaControl>
{
new Window
{
Title = "Hello from Pashua!"
},
new Text
{
Default = "A simple GUI without having to deal with Xamarin.Mac"
},
new TextField
{
Label = "Your thoughts:",
TextEntered = t => thoughts = t,
},
new DefaultButton
{
Label = "Submit"
}
};
script.RunScript();
Console.Out.WriteLine(thoughts.EnteredText);Everything in the library is in one namespace for simplicity, however the controls are as organized in a subfolder.
Most the control classes were created with a code generator project (src/DataModelGenerator). This is just a console app that spits out all the partial .Generated.cs files based on the contents of Pashua Documentation.tsv, which is a tweaked version of all the control documentation copied from the Pashua site. Properties that were too much of a special case were just handled in a manual partial class.
See CHANGELOG.md.