pub struct SampleComponent {}
Expand description

This an example of the API that is generated for a component in .slint design markup. This may help you understand what functions you can call and how you can pass data in and out. This is the source code:

SampleComponent := Window {
    property<int> counter;
    // note that dashes will be replaced by underscores in the generated code
    property<string> user-name;
    callback hello();
    // ... maybe more elements here
}

Implementations§

Creates a new instance that is reference counted and pinned in memory.

A getter is generated for each property declared at the root of the component. In this case, this is the getter that returns the value of the counter property declared in the .slint design markup.

A setter is generated for each property declared at the root of the component, In this case, this is the setter that sets the value of the counter property declared in the .slint design markup.

Returns the value of the user_name property declared in the .slint design markup.

Assigns a new value to the user_name property.

For each callback declared at the root of the component, a function to call that callback is generated. This is the function that calls the hello callback declared in the .slint design markup.

For each callback declared at the root of the component, a function connect to that callback is generated. This is the function that registers the function f as callback when the callback hello is emitted. In order to access the component in the callback, you’d typically capture a weak reference obtained using ComponentHandle::as_weak and then upgrade it to a strong reference when the callback is run:

    let sample = SampleComponent::new();
    let sample_weak = sample.as_weak();
    sample.as_ref().on_hello(move || {
        let sample = sample_weak.unwrap();
        sample.as_ref().set_counter(42);
    });

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more

Returns a new weak pointer.

Returns a clone of this handle that’s a strong reference.

Marks the window of this component to be shown on the screen. This registers the window with the windowing system. In order to react to events from the windowing system, such as draw requests or mouse/touch input, it is still necessary to spin the event loop, using crate::run_event_loop.

Marks the window of this component to be hidden on the screen. This de-registers the window from the windowing system and it will not receive any further events.

Returns the Window associated with this component. The window API can be used to control different aspects of the integration into the windowing system, such as the position on the screen.

This is a convenience function that first calls Self::show, followed by crate::run_event_loop() and Self::hide.

This function provides access to instances of global singletons exported in .slint.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more