Struct slint::docs::generated_code::SampleComponent
source · [−]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
sourceimpl SampleComponent
impl SampleComponent
sourcepub fn get_counter(&self) -> i32
pub fn get_counter(&self) -> i32
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.
sourcepub fn set_counter(&self, value: i32)
pub fn set_counter(&self, value: i32)
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.
sourcepub fn get_user_name(&self) -> SharedString
pub fn get_user_name(&self) -> SharedString
Returns the value of the user_name
property declared in the .slint
design markup.
sourcepub fn set_user_name(&self, value: SharedString)
pub fn set_user_name(&self, value: SharedString)
Assigns a new value to the user_name
property.
sourcepub fn invoke_hello(&self)
pub fn invoke_hello(&self)
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.
sourcepub fn on_hello(&self, f: impl Fn() + 'static)
pub fn on_hello(&self, f: impl Fn() + 'static)
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
sourceimpl Clone for SampleComponent
impl Clone for SampleComponent
sourcefn clone(&self) -> SampleComponent
fn clone(&self) -> SampleComponent
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl ComponentHandle for SampleComponent
impl ComponentHandle for SampleComponent
sourcefn clone_strong(&self) -> Self
fn clone_strong(&self) -> Self
Returns a clone of this handle that’s a strong reference.
sourcefn show(&self)
fn show(&self)
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
.
sourcefn hide(&self)
fn hide(&self)
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.
sourcefn window(&self) -> &Window
fn window(&self) -> &Window
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.
sourcefn run(&self)
fn run(&self)
This is a convenience function that first calls Self::show
, followed by crate::run_event_loop()
and Self::hide
.
Auto Trait Implementations
impl RefUnwindSafe for SampleComponent
impl Send for SampleComponent
impl Sync for SampleComponent
impl Unpin for SampleComponent
impl UnwindSafe for SampleComponent
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more