Struct Element

pub struct Element {

    pub id: SmolStr,
    pub base_type: ElementType,
    pub bindings: BindingsMap,
    pub change_callbacks: BTreeMap<SmolStr, RefCell<Vec<Expression>>>,
    pub property_analysis: RefCell<HashMap<SmolStr, PropertyAnalysis>>,
    pub children: Vec<ElementRc>,
    pub enclosing_component: Weak<Component>,
    pub property_declarations: BTreeMap<SmolStr, PropertyDeclaration>,
    pub named_references: NamedReferenceContainer,
    pub repeated: Option<RepeatedElementInfo>,
    pub is_component_placeholder: bool,
    pub states: Vec<State>,
    pub transitions: Vec<Transition>,
    pub child_of_layout: bool,
    pub layout_info_prop: Option<(NamedReference, NamedReference)>,
    pub default_fill_parent: (bool, bool),
    pub accessibility_props: AccessibilityProps,
    pub geometry_props: Option<GeometryProps>,
    pub is_flickable_viewport: bool,
    pub has_popup_child: bool,
    pub item_index: OnceCell<u32>,
    pub item_index_of_first_children: OnceCell<u32>,
    pub is_legacy_syntax: bool,
    pub inline_depth: i32,
    pub debug: Vec<ElementDebugInfo>,
}

An Element is an instantiation of a Component

Fields

id: SmolStr

The id as named in the original .slint file.

Note that it can only be used for lookup before inlining. After inlining there can be duplicated id in the component. The id are then re-assigned unique id in the assign_id pass

base_type: ElementType

bindings: BindingsMap

Currently contains also the callbacks. FIXME: should that be changed?

change_callbacks: BTreeMap<SmolStr, RefCell<Vec<Expression>>>

property_analysis: RefCell<HashMap<SmolStr, PropertyAnalysis>>

children: Vec<ElementRc>

enclosing_component: Weak<Component>

The component which contains this element.

property_declarations: BTreeMap<SmolStr, PropertyDeclaration>

named_references: NamedReferenceContainer

Main owner for a reference to a property.

repeated: Option<RepeatedElementInfo>

This element is part of a for <xxx> in <model>:

is_component_placeholder: bool

This element is a placeholder to embed an Component at

states: Vec<State>

transitions: Vec<Transition>

child_of_layout: bool

true when this item’s geometry is handled by a layout

layout_info_prop: Option<(NamedReference, NamedReference)>

The property pointing to the layout info. (horizontal, vertical)

default_fill_parent: (bool, bool)

Whether we have preferred-{width,height}: 100%

accessibility_props: AccessibilityProps

geometry_props: Option<GeometryProps>

Reference to the property. This is always initialized from the element constructor, but is Option because it references itself

is_flickable_viewport: bool

true if this Element is the fake Flickable viewport

has_popup_child: bool

true if this Element may have a popup as child meaning it cannot be optimized because the popup references it.

item_index: OnceCell<u32>

This is the component-local index of this item in the item tree array. It is generated after the last pass and before the generators run.

item_index_of_first_children: OnceCell<u32>

the index of the first children in the tree, set with item_index

is_legacy_syntax: bool

True when this element is in a component was declared with the := symbol instead of the component keyword

inline_depth: i32

How many times the element was inlined

debug: Vec<ElementDebugInfo>

Debug information about this element.

There can be several in case of inlining or optimization (child merged into their parent).

The order in the list is first the parent, and then the removed children.

Implementations

impl Element

pub fn make_rc(self) -> ElementRc

pub fn from_node( node: Element, id: SmolStr, parent_type: ElementType, component_child_insertion_point: &mut Option<ChildrenInsertionPoint>, is_legacy_syntax: bool, diag: &mut BuildDiagnostics, tr: &TypeRegister, ) -> ElementRc

pub fn lookup_property<'a>(&self, name: &'a str) -> PropertyLookupResult<'a>

Return the type of a property in this element or its base, along with the final name, in case the provided name points towards a property alias. Type::Invalid is returned if the property does not exist.

pub fn native_class(&self) -> Option<Rc<NativeClass>>

pub fn builtin_type(&self) -> Option<Rc<BuiltinElement>>

pub fn layout_info_prop( &self, orientation: Orientation, ) -> Option<&NamedReference>

pub fn original_name(&self) -> SmolStr

Returns the element’s name as specified in the markup, not normalized.

pub fn is_binding_set( self: &Element, property_name: &str, need_explicit: bool, ) -> bool

Return true if the binding is set, either on this element or in a base

If need_explicit is true, then only consider binding set in the code, not the ones set by the compiler later.

pub fn set_binding_if_not_set( &mut self, property_name: SmolStr, expression_fn: impl FnOnce() -> Expression, ) -> bool

Set the property property_name of this Element only if it was not set. the expression_fn will only be called if it isn’t set

returns true if the binding was changed

pub fn sub_component(&self) -> Option<&Rc<Component>>

pub fn element_infos(&self) -> String

Trait Implementations

impl Debug for Element

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Element

fn default() -> Element

Returns the “default value” for a type.

impl Spanned for Element

fn span(&self) -> Span

fn source_file(&self) -> Option<&SourceFile>

fn to_source_location(&self) -> SourceLocation