First look

Elevator pitch

Documentation

Getting started

dotnet add package Qml.Netdotnet add package Qml.Net.WindowsBinariesdotnet add package Qml.Net.OSXBinariesdotnet add package Qml.Net.LinuxBinaries

Examples

Quick overview

//QmlType.csusingQml.Net;usingSystem.Threading.Tasks;namespaceQmlQuickOverview{[Signal("customSignal",NetVariantType.String)]// You can define signals that Qml can listen to.publicclassQmlType{/// <summary>/// Properties are exposed to Qml./// </summary>[NotifySignal("stringPropertyChanged")]// For Qml binding/MVVM.publicstringStringProperty{get;set;}/// <summary>/// Methods can return .NET types./// The returned type can be invoked from Qml (properties/methods/events/etc)./// </summary>/// <returns></returns>publicQmlTypeCreateNetObject(){returnnewQmlType();}/// <summary>/// Qml can pass .NET types to .NET methods./// </summary>/// <param name="parameter"></param>publicvoidTestMethod(QmlTypeparameter){}/// <summary>/// Async methods can be invoked with continuations happening on Qt's main thread./// </summary>publicasyncTask<string>TestAsync(){// On the UI threadawaitTask.Run(()=>{// On the background thread});// On the UI threadreturn"async result!";}/// <summary>/// Qml can also pass Qml/C++ objects that can be invoked from .NET/// </summary>/// <param name="qObject"></param>publicvoidTestMethodWithQObject(dynamico){stringresult=o.propertyDefinedInCpp;o.methodDefinedInCpp(result);// You can also listen to signals on QObjects.varqObject=oasINetQObject;varhandler=qObject.AttachSignal("signalName", parameters=>{// parameters is a list of arguements passed to the signal.});handler.Dispose();// When you are done listening to signal.// You can also listen to when a property changes (notify signal).handler=qObject.AttachNotifySignal("property", parameters=>{// parameters is a list of arguements passed to the signal.});handler.Dispose();// When you are done listening to signal.}/// <summary>/// .NET can activate signals to send notifications to Qml./// </summary>publicvoidActivateCustomSignal(stringmessage){this.ActivateSignal("customSignal",message);}}}

//QmlExample.csusingQml.Net;usingQml.Net.Runtimes;namespaceQmlQuickOverview{classQmlExample{staticintMain(string[]args){RuntimeManager.DiscoverOrDownloadSuitableQtRuntime();using(varapp=newQGuiApplication(args)){using(varengine=newQQmlApplicationEngine()){// Register our new type to be used in QmlQml.Net.Qml.RegisterType<QmlType>("test",1,1);engine.Load("Main.qml");returnapp.Exec();}}}}}

//Main.qmlimportQtQuick2.7importQtQuick.Controls2.0importQtQuick.Layouts1.0importtest1.1ApplicationWindow{visible:true    width:640    height:480    title:qsTr("Hello World")QmlType{      id:testComponent.onCompleted:function(){// We can read/set propertiesconsole.log(test.stringProperty)test.stringPropertyChanged.connect(function(){console.log("The property was changed!")})test.stringProperty="New value!"// We can return .NET types (even ones not registered with Qml)varnetObject=test.createNetObject();// All properties/methods/signals can be invoked on "netObject"// We can also pass the .NET object back to .NETnetObject.testMethod(netObject)// We can invoke async tasks that have continuation on the UI threadvartask=netObject.testAsync()// And we can await the taskNet.await(task,function(result){// With the result!console.log(result)})// We can trigger signals from .NETtest.customSignal.connect(function(message){console.log("message: "+message)})test.activateCustomSignal("test message!")}functiontestHandler(message){console.log("Message - "+message)}}}

Currently implemented

Running Unit Tests

Contributors ✨