Struct slint_interpreter::ComponentDefinition

source ·
pub struct ComponentDefinition { /* private fields */ }
Expand description

ComponentDefinition is a representation of a compiled component from .slint markup.

It can be constructed from a .slint file using the Compiler::build_from_path or Compiler::build_from_source functions. And then it can be instantiated with the Self::create function.

The ComponentDefinition acts as a factory to create new instances. When you’ve finished creating the instances it is safe to drop the ComponentDefinition.

Implementations§

source§

impl ComponentDefinition

source

pub fn create(&self) -> Result<ComponentInstance, PlatformError>

Creates a new instance of the component and returns a shared handle to it.

source

pub fn properties(&self) -> impl Iterator<Item = (String, ValueType)> + '_

Returns an iterator over all publicly declared properties. Each iterator item is a tuple of property name and property type for each of them.

source

pub fn callbacks(&self) -> impl Iterator<Item = String> + '_

Returns the names of all publicly declared callbacks.

source

pub fn functions(&self) -> impl Iterator<Item = String> + '_

Returns the names of all publicly declared functions.

source

pub fn globals(&self) -> impl Iterator<Item = String> + '_

Returns the names of all exported global singletons

Note: Only globals that are exported or re-exported from the main .slint file will be exposed in the API

source

pub fn global_properties( &self, global_name: &str, ) -> Option<impl Iterator<Item = (String, ValueType)> + '_>

List of publicly declared properties in the exported global singleton specified by its name.

source

pub fn global_callbacks( &self, global_name: &str, ) -> Option<impl Iterator<Item = String> + '_>

List of publicly declared callbacks in the exported global singleton specified by its name.

source

pub fn global_functions( &self, global_name: &str, ) -> Option<impl Iterator<Item = String> + '_>

List of publicly declared functions in the exported global singleton specified by its name.

source

pub fn name(&self) -> &str

The name of this Component as written in the .slint file

source

pub fn type_loader(&self) -> Rc<TypeLoader>

Return the TypeLoader used when parsing the code in the interpreter.

WARNING: this is not part of the public API

source

pub fn raw_type_loader(&self) -> Option<TypeLoader>

Return the TypeLoader used when parsing the code in the interpreter in a state before most passes were applied by the compiler.

Each returned type loader is a deep copy of the entire state connected to it, so this is a fairly expensive function!

WARNING: this is not part of the public API

Trait Implementations§

source§

impl Clone for ComponentDefinition

source§

fn clone(&self) -> ComponentDefinition

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more