Struct slint_interpreter::ComponentInstance
source ยท pub struct ComponentInstance { /* private fields */ }
Expand description
This represent an instance of a dynamic component
You can create an instance with the ComponentDefinition::create
function.
Properties and callback can be accessed using the associated functions.
An instance can be put on screen with the ComponentInstance::run
function.
Implementationsยง
sourceยงimpl ComponentInstance
impl ComponentInstance
sourcepub fn definition(&self) -> ComponentDefinition
pub fn definition(&self) -> ComponentDefinition
Return the ComponentDefinition
that was used to create this instance.
sourcepub fn get_property(&self, name: &str) -> Result<Value, GetPropertyError>
pub fn get_property(&self, name: &str) -> Result<Value, GetPropertyError>
Return the value for a public property of this component.
Examples
use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString};
let code = r#"
export component MyWin inherits Window {
in-out property <int> my_property: 42;
}
"#;
let mut compiler = ComponentCompiler::default();
let definition = spin_on::spin_on(
compiler.build_from_source(code.into(), Default::default()));
assert!(compiler.diagnostics().is_empty(), "{:?}", compiler.diagnostics());
let instance = definition.unwrap().create().unwrap();
assert_eq!(instance.get_property("my_property").unwrap(), Value::from(42));
sourcepub fn set_property(
&self,
name: &str,
value: Value
) -> Result<(), SetPropertyError>
pub fn set_property( &self, name: &str, value: Value ) -> Result<(), SetPropertyError>
Set the value for a public property of this component
sourcepub fn set_callback(
&self,
name: &str,
callback: impl Fn(&[Value]) -> Value + 'static
) -> Result<(), SetCallbackError>
pub fn set_callback( &self, name: &str, callback: impl Fn(&[Value]) -> Value + 'static ) -> Result<(), SetCallbackError>
Set a handler for the callback with the given name. A callback with that name must be defined in the document otherwise an error will be returned.
Note: Since the ComponentInstance
holds the handler, the handler itself should not
contain a strong reference to the instance. So if you need to capture the instance,
you should use Self::as_weak
to create a weak reference.
Examples
use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString, ComponentHandle};
use core::convert::TryInto;
let code = r#"
component MyWin inherits Window {
callback foo(int) -> int;
in-out property <int> my_prop: 12;
}
"#;
let definition = spin_on::spin_on(
ComponentCompiler::default().build_from_source(code.into(), Default::default()));
let instance = definition.unwrap().create().unwrap();
let instance_weak = instance.as_weak();
instance.set_callback("foo", move |args: &[Value]| -> Value {
let arg: u32 = args[0].clone().try_into().unwrap();
let my_prop = instance_weak.unwrap().get_property("my_prop").unwrap();
let my_prop : u32 = my_prop.try_into().unwrap();
Value::from(arg + my_prop)
}).unwrap();
let res = instance.invoke("foo", &[Value::from(500)]).unwrap();
assert_eq!(res, Value::from(500+12));
sourcepub fn invoke(&self, name: &str, args: &[Value]) -> Result<Value, InvokeError>
pub fn invoke(&self, name: &str, args: &[Value]) -> Result<Value, InvokeError>
Call the given callback or function with the arguments
Examples
See the documentation of Self::set_callback
for an example
sourcepub fn get_global_property(
&self,
global: &str,
property: &str
) -> Result<Value, GetPropertyError>
pub fn get_global_property( &self, global: &str, property: &str ) -> Result<Value, GetPropertyError>
Return the value for a property within an exported global singleton used by this component.
The global
parameter is the exported name of the global singleton. The property
argument
is the name of the property
Examples
use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString};
let code = r#"
global Glob {
in-out property <int> my_property: 42;
}
export { Glob as TheGlobal }
component MyWin inherits Window {
}
"#;
let mut compiler = ComponentCompiler::default();
let definition = spin_on::spin_on(
compiler.build_from_source(code.into(), Default::default()));
assert!(compiler.diagnostics().is_empty(), "{:?}", compiler.diagnostics());
let instance = definition.unwrap().create().unwrap();
assert_eq!(instance.get_global_property("TheGlobal", "my_property").unwrap(), Value::from(42));
sourcepub fn set_global_property(
&self,
global: &str,
property: &str,
value: Value
) -> Result<(), SetPropertyError>
pub fn set_global_property( &self, global: &str, property: &str, value: Value ) -> Result<(), SetPropertyError>
Set the value for a property within an exported global singleton used by this component.
sourcepub fn set_global_callback(
&self,
global: &str,
name: &str,
callback: impl Fn(&[Value]) -> Value + 'static
) -> Result<(), SetCallbackError>
pub fn set_global_callback( &self, global: &str, name: &str, callback: impl Fn(&[Value]) -> Value + 'static ) -> Result<(), SetCallbackError>
Set a handler for the callback in the exported global singleton. A callback with that name must be defined in the specified global and the global must be exported from the main document otherwise an error will be returned.
Examples
use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString};
use core::convert::TryInto;
let code = r#"
export global Logic {
pure callback to_uppercase(string) -> string;
}
component MyWin inherits Window {
out property <string> hello: Logic.to_uppercase("world");
}
"#;
let definition = spin_on::spin_on(
ComponentCompiler::default().build_from_source(code.into(), Default::default()));
let instance = definition.unwrap().create().unwrap();
instance.set_global_callback("Logic", "to_uppercase", |args: &[Value]| -> Value {
let arg: SharedString = args[0].clone().try_into().unwrap();
Value::from(SharedString::from(arg.to_uppercase()))
}).unwrap();
let res = instance.get_property("hello").unwrap();
assert_eq!(res, Value::from(SharedString::from("WORLD")));
let abc = instance.invoke_global("Logic", "to_uppercase", &[
SharedString::from("abc").into()
]).unwrap();
assert_eq!(abc, Value::from(SharedString::from("ABC")));
sourcepub fn invoke_global(
&self,
global: &str,
callable_name: &str,
args: &[Value]
) -> Result<Value, InvokeError>
pub fn invoke_global( &self, global: &str, callable_name: &str, args: &[Value] ) -> Result<Value, InvokeError>
Call the given callback or function within a global singleton with the arguments
Examples
See the documentation of Self::set_global_callback
for an example
sourcepub fn highlight(&self, path: PathBuf, offset: u32)
pub fn highlight(&self, path: PathBuf, offset: u32)
Highlight the elements which are pointed by a given source location.
WARNING: this is not part of the public API
sourcepub fn set_design_mode(&self, active: bool)
pub fn set_design_mode(&self, active: bool)
Request information on clicked object
WARNING: this is not part of the public API
Trait Implementationsยง
sourceยงimpl ComponentHandle for ComponentInstance
impl ComponentHandle for ComponentInstance
sourceยงfn clone_strong(&self) -> Self
fn clone_strong(&self) -> Self
sourceยงfn show(&self) -> Result<(), PlatformError>
fn show(&self) -> Result<(), PlatformError>
crate::run_event_loop
.sourceยงfn hide(&self) -> Result<(), PlatformError>
fn hide(&self) -> Result<(), PlatformError>
sourceยงfn run(&self) -> Result<(), PlatformError>
fn run(&self) -> Result<(), PlatformError>
Self::show
, followed by crate::run_event_loop()
and Self::hide
.sourceยงimpl From<ComponentInstance> for VRc<ComponentVTable, ErasedComponentBox>
impl From<ComponentInstance> for VRc<ComponentVTable, ErasedComponentBox>
sourceยงfn from(value: ComponentInstance) -> Self
fn from(value: ComponentInstance) -> Self
Auto Trait Implementationsยง
impl !RefUnwindSafe for ComponentInstance
impl !Send for ComponentInstance
impl !Sync for ComponentInstance
impl Unpin for ComponentInstance
impl !UnwindSafe for ComponentInstance
Blanket Implementationsยง
sourceยงimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
sourceยงfn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
ยงimpl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
ยงfn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.ยงfn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.ยงfn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
โs vtable from &Trait
โs.ยงfn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
โs vtable from &mut Trait
โs.