+
+ | Qt Widgets (main.cpp) / Qt Quick (main.qml) |
+ ⟵ UI code, written by hand |
+
+
+ | src/Binding.h |
+ ⟵ generated from binding.json |
+
+
+ | src/Binding.cpp |
+
+
+ | rust/src/interface.rs |
+
+
+ | rust/src/implementation.rs |
+ ⟵ Rust code, written by hand |
+
+
+
To combine Qt and Rust, write an interface in a JSON file. From that, the generator creates Qt code and Rust code. The Qt code can be used directly. The Rust code has two files: interface and implementation. The interface can be used directly.
```json
{
- "cppFile": "src/person.cpp",
+ "cppFile": "src/Binding.cpp",
"rust": {
"dir": "rust",
"interfaceModule": "interface",
"implementationModule": "implementation"
},
"objects": {
- "Person": {
+ "Greeting": {
"type": "Object",
"properties": {
- "name": {
+ "message": {
"type": "QString",
"write": true
}
@@ -30,7 +56,7 @@ To combine Qt and Rust, write an interface in a JSON file. From that, the genera
}
```
-This file describes an binding with one object, `Person`. `Person` has one property: `name`. It is a writable property.
+This file describes an binding with one object, `Greeting`. `Greeting` has one property: `message`. It is a writable property.
The Rust Qt Binding Generator will create binding source code from this description:
@@ -40,45 +66,46 @@ rust_qt_binding_generator binding.json
This will create four files:
-* *src/person.h*
-* *src/person.cpp*
-* rust/src/implementation.rs
+* *src/Binding.h*
+* *src/Binding.cpp*
* *rust/src/interface.rs*
+* rust/src/implementation.rs
Only `implementation.rs` should be changed. The other files are the binding. `implementation.rs` is initialy created with a simple implementation that is shown here with some comments.
```rust
use interface::*;
-/// A Person
-pub struct Person {
+/// A Greeting
+pub struct Greeting {
/// Emit signals the the Qt code.
- emit: PersonEmitter,
- /// The name of the person.
- name: String,
+ emit: GreetingEmitter,
+ /// The message of the person.
+ message: String,
}
/// Implementation of the binding
-impl PersonTrait for Person {
- /// Create a new person with default data.
- fn new(emit: PersonEmitter) -> Person {
- Person {
+/// GreetingTrait is defined in interface.rs
+impl GreetingTrait for Greeting {
+ /// Create a new greeting with default data.
+ fn new(emit: GreetingEmitter) -> Greeting {
+ Greeting {
emit: emit,
- name: String::new(),
+ message: "Hello World!",
}
}
/// The emitter can emit signals to the Qt code.
- fn emit(&self) -> &PersonEmitter {
+ fn emit(&self) -> &GreetingEmitter {
&self.emit
}
- /// Get the name of the Person
- fn get_name(&self) -> &str {
- &self.name
+ /// Get the message of the Greeting
+ fn get_message(&self) -> &str {
+ &self.message
}
- /// Set the name of the Person
- fn set_name(&mut self, value: String) {
- self.name = value;
- self.emit.name_changed();
+ /// Set the message of the Greeting
+ fn set_message(&mut self, value: String) {
+ self.message = value;
+ self.emit.message_changed();
}
}
```
@@ -87,6 +114,60 @@ The building block of Qt and QML projects are QObject and the Model View classes
This way, Rust code can be called from Qt and QML projects.
-## More information
+### Qt Widgets with Rust
+This C++ code uses the Rust code written above.
+
+```cpp
+#include "Binding.h"
+#include 
+