Struct Object

pub struct Object { /* private fields */ }

Expand description

Object represents a strong reference to an instance of C++ kanzi::Object.

Implementations§

§

impl Object

pub const fn as_ptr(&self) -> *mut ObjectWrapper

pub const fn as_wrapper(&self) -> &ObjectWrapper

§

impl Object

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>
where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

Local value set with setProperty or loaded from kzb
Value set by a style affecting the property.
Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

§Arguments

property_type - The property type identifying the property to retrieve.

§Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>
where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

§Arguments

property_type - The property type identifying the property to retrieve.

§Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>
where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

§Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

§

impl Object

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations§

§

impl Clone for Object

§

fn clone(&self) -> Object

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for Object

§

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

Formats the value using the given formatter. Read more

§

impl Inheritable for Object

§

unsafe fn downcast_unchecked<T>(self) -> T
where T: Inherits<Self>,

Downcast the object to a more specific type. Read more

§

unsafe fn downcast_unchecked_ref<T>(&self) -> &T
where T: Inherits<Self>,

Downcast the object reference to a more specific type. Read more

§

Struct ObjectCopy item path

Implementations§

impl Object

pub const fn as_ptr(&self) -> *mut ObjectWrapper

pub const fn as_wrapper(&self) -> &ObjectWrapper

impl Object

pub fn as_object(&self) -> &Object

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

pub fn is_stale(&self) -> bool

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>where T: PropertyTypeConstraint,

§Arguments

§Returns

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>where T: PropertyTypeConstraint,

§Arguments

§Returns

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>where T: PropertyTypeConstraint,

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>where T: PropertyTypeConstraint,

§Returns

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>where T: PropertyTypeConstraint,

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

pub fn get_domain(&self) -> Result<Domain, Error>

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>where T: PropertyTypeConstraint,

impl Object

pub fn debug_string(&self) -> Result<String, Error>

Trait Implementations§

impl Clone for Object

fn clone(&self) -> Object

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

impl Debug for Object

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

impl Inheritable for Object

unsafe fn downcast_unchecked<T>(self) -> Twhere T: Inherits<Self>,

unsafe fn downcast_unchecked_ref<T>(&self) -> &Twhere T: Inherits<Self>,

impl Inherits<Object> for Action

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ActionBase

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for Activity2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for Activity3D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ActivityCodeBehind

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ActivityConcept

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ActivityElement

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ActivityHostConcept

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for AnimationBindingProcessor

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for AnimationPlayer

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for AnimationResource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ApplyAction

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ApplyActivationAction

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for ApplyPropertyAction

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for BinaryResource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for BindingProcessor

fn upcast(self) -> Base

Struct Object

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>
where T: PropertyTypeConstraint,

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>
where T: PropertyTypeConstraint,

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>
where T: PropertyTypeConstraint,

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

unsafe fn downcast_unchecked<T>(self) -> T
where T: Inherits<Self>,

unsafe fn downcast_unchecked_ref<T>(&self) -> &T
where T: Inherits<Self>,