language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-10-01 06:11:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Fix Rust docs about generated API

Browse source
This commit is contained in:
Simon Hausmann 2020-12-09 16:48:02 +01:00
parent c77109d257
commit c72c2a58ff
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
api/sixtyfps-rs/lib.rs
View file

@ -98,15 +98,15 @@ This documentation contains a documented generated component: [`docs::generated_
The following associated function are added to the component:
- [`fn new() -> Pin<Rc<Self>>`](docs::generated_code::SampleComponent::new): to instantiate the component.
- [`fn new() -> Self`](docs::generated_code::SampleComponent::new): to instantiate the component.
For each top-level property
- A setter [`fn set_<property_name>(&self, value: <PropertyType>)`](docs::generated_code::SampleComponent::set_counter)
- A getter [`fn get_<property_name>(self: Pin<&Self>) -> <PropertyType>`](docs::generated_code::SampleComponent::get_counter)
- A getter [`fn get_<property_name>(&self) -> <PropertyType>`](docs::generated_code::SampleComponent::get_counter)
For each top-level signal
- [`fn emit_<signal_name>(self: Pin<&Self>)`](docs::generated_code::SampleComponent::emit_hello): to emit the signal
- [`fn on_<signal_name>(self: Pin<&Self>, callback: impl Fn(<SignalArgs>) + 'static)`](docs::generated_code::SampleComponent::on_hello): to set the signal handler.
- [`fn emit_<signal_name>(&self)`](docs::generated_code::SampleComponent::emit_hello): to emit the signal
- [`fn on_<signal_name>(&self, callback: impl Fn(<SignalArgs>) + 'static)`](docs::generated_code::SampleComponent::on_hello): to set the signal handler.
### Type Mappings