Struct FerroObject 

pub struct FerroObject { /* private fields */ }

An object with FerroProperty support: the root of the class hierarchy.

Implementations

impl FerroObject

pub const TYPE: &'static TypeInfo

The runtime type of this class.

pub fn construct() -> FerroObject

Creates the class data. Use from the construct function of a derived class; the object becomes usable once passed to instantiate.

pub fn dispatcher(&self) -> &Arc<Dispatcher>

Returns the Dispatcher that this object is associated with: the dispatcher of the thread that owns the object.

pub fn check_access(&self) -> bool

Returns whether the calling thread is the thread that owns this object.

pub fn verify_access(&self)

Checks that the calling thread is the thread that owns this object.

Panics

Panics when it is not.

pub fn new() -> Ref<FerroObject>

Creates a plain object.

pub fn to_ref(&self) -> Ref<FerroObject>

A strong reference to this object.

pub fn to_weak(&self) -> WeakRef<FerroObject>

A weak reference to this object.

pub fn get_type(&self) -> &'static TypeInfo

The runtime type of the object.

pub fn is<T: ObjectType>(&self) -> bool

Whether the object is of class T or a class derived from it.

pub fn downcast_ref<T: ObjectType>(&self) -> Option<&T>

Returns the object viewed as class T if it is one.

pub fn on_property_changed(&self, change: &FerroPropertyChangedEventArgs<'_>)

Invokes the on_property_changed virtual member.

pub fn inheritance_parent(&self) -> Option<Ref<FerroObject>>

The parent object that inherited property values are inherited from.

pub fn set_inheritance_parent(&self, value: impl Into<Nullable<FerroObject>>)

Sets the parent object that inherited property values are inherited from.

pub fn clear_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, )

Clears a property’s local value.

pub fn get_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, ) -> T

Gets a property value.

pub fn get_base_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, ) -> Option<T>

Gets a property’s base value: the value excluding animated values. Returns None if the value comes from inheritance or the default.

pub fn is_animating(&self, property: &FerroProperty) -> bool

Checks whether a property is animating.

pub fn is_set(&self, property: &FerroProperty) -> bool

Checks whether a styled property has a value assigned to it or a binding targeting it.

pub fn set_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, )

Sets a property value with local value priority.

pub fn set_value_with_priority<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, priority: BindingPriority, ) -> Option<Rc<dyn IDisposable>>

Sets a property value with the given priority. For priorities other than local value, disposing the returned handle removes the value.

pub fn set_current_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, )

Sets the value of a property without changing its value source.

This is used by a component that programmatically sets the value of one of its own properties without disabling an application’s declared use of the property: the effective value changes, but existing bindings and styles continue to work. The new value has the property’s current priority.

pub fn bind_binding( &self, property: &'static FerroProperty, binding: &dyn BindingBase, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding. Returns the binding expression which represents the binding instance on this object.

pub fn bind_binding_with_anchor( &self, property: &'static FerroProperty, binding: &dyn BindingBase, anchor: Option<&Ref<FerroObject>>, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding.

Some bindings need context to locate their source: a data context, named elements or resources. If this object is not an element, or is not yet attached to the tree, anchor provides that context.

pub fn indexer(&self, binding: &IndexerDescriptor) -> IndexerBinding

Gets a binding to a property of this object: the indexer taking an IndexerDescriptor (source[!Property] is source.indexer(&Property.bind())).

pub fn bind_indexer( &self, binding: &IndexerDescriptor, value: &dyn BindingBase, ) -> Rc<dyn BindingExpressionBase>

Binds the property of an IndexerDescriptor to a binding: the setter of the indexer (target[!Property] = binding is target.bind_indexer(&Property.bind(), &binding)).

pub fn bind<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<T>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable.

pub fn bind_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<BindingValue<T>>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of binding values.

pub fn bind_untyped<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<BoxedValue>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of untyped values.

pub fn coerce_value(&self, property: &'static FerroProperty)

Coerces the specified property.

pub fn get_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, ) -> T

Gets a direct property value.

pub fn set_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, value: T, )

Sets a direct property value.

pub fn clear_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, )

Resets a direct property to its unset value.

pub fn bind_direct<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<T>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable.

pub fn bind_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<BindingValue<T>>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable of binding values.

pub fn bind_direct_untyped<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<BoxedValue>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable of untyped values.

pub fn set_and_raise<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, field: &RefCell<T>, value: T, ) -> bool

Sets the backing field of a direct property, raising a change notification if the value changed. Returns true if it changed.

pub fn set_and_raise_cell<T: PropertyValue + Copy>( &self, property: &'static DirectPropertyBase<T>, field: &Cell<T>, value: T, ) -> bool

set_and_raise for Copy values stored in a Cell.

pub fn get_value_untyped(&self, property: &'static FerroProperty) -> BoxedValue

Gets a property value as an untyped value.

pub fn set_value_untyped( &self, property: &'static FerroProperty, value: &dyn Any, priority: BindingPriority, ) -> Option<Rc<dyn IDisposable>>

Sets a property from an untyped value, which must hold exactly the property’s value type or the unset marker.

pub fn set_current_value_untyped( &self, property: &'static FerroProperty, value: &dyn Any, )

set_current_value with an untyped value.

pub fn clear_value_untyped(&self, property: &'static FerroProperty)

Clears a property’s local value.

pub fn bind_property_untyped( &self, property: &'static FerroProperty, source: Rc<dyn IObservable<BoxedValue>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of untyped values.

pub fn property_changed( &self, handler: impl Fn(&FerroPropertyChangedEventArgs<'_>) + 'static, ) -> Rc<dyn IDisposable>

Subscribes to property changes on this object. Disposing the returned handle unsubscribes.

pub fn add_property_changed_handler( &self, handler: Rc<dyn Fn(&FerroPropertyChangedEventArgs<'_>)>, ) -> u64

Subscribes handler to property changes on this object and returns the token that remove_property_changed_handler takes: property_changed for a subscriber that keeps the object and the token itself, so that no handle is made.

pub fn remove_property_changed_handler(&self, token: u64) -> bool

Ends a subscription of add_property_changed_handler.

pub fn property_changed_subscriber_count(&self) -> usize

The number of subscribers to property changes on this object (a diagnostics member, used by tests to verify that subscriptions are released).

pub fn raise_property_changed<T: PropertyValue>( &self, property: &'static FerroProperty, old_value: Option<&T>, new_value: &T, priority: BindingPriority, is_effective_value: bool, )

Raises a property changed notification.

pub fn raise_direct_property_changed<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, old_value: &T, new_value: &T, )

Raises a property changed notification for a direct property.

Trait Implementations

impl Debug for FerroObject

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

Formats the value using the given formatter.

impl FerroObjectDiagnosticExtensions for FerroObject

fn get_diagnostic(&self, property: &'static FerroProperty) -> FerroPropertyValue

Gets a diagnostic for a FerroProperty on a FerroObject: a FerroPropertyValue that can be used to diagnose the state of the property on the object.

fn get_value_store_diagnostic(&self) -> ValueStoreDiagnostic

Gets a ValueStoreDiagnostic: the frames of values that are applied to the object.

impl FerroObjectExtensions for FerroObject

fn get_observable<P: TypedProperty>( &self, property: &'static P, ) -> Rc<dyn IObservable<P::Value>>

Gets an observable for a property.

fn get_observable_with<P: TypedProperty, TResult: PropertyValue>( &self, property: &'static P, converter: impl Fn(P::Value) -> TResult + 'static, ) -> Rc<dyn IObservable<TResult>>

Gets an observable for a property, projecting each value with converter.

fn get_observable_untyped( &self, property: &'static FerroProperty, ) -> Rc<dyn IObservable<BoxedValue>>

Gets an observable of untyped values for a property.

fn get_observable_untyped_with<TResult: PropertyValue>( &self, property: &'static FerroProperty, converter: impl Fn(BoxedValue) -> TResult + 'static, ) -> Rc<dyn IObservable<TResult>>

Gets an observable of untyped values for a property, projecting each value with converter.

fn get_binding_observable<P: TypedProperty>( &self, property: &'static P, ) -> Rc<dyn IObservable<BindingValue<P::Value>>>

Gets an observable of binding values for a property.

fn get_binding_observable_with<P: TypedProperty, TResult: PropertyValue>( &self, property: &'static P, converter: impl Fn(P::Value) -> TResult + 'static, ) -> Rc<dyn IObservable<BindingValue<TResult>>>

Gets an observable of binding values for a property, projecting each value with converter.

fn get_binding_observable_untyped( &self, property: &'static FerroProperty, ) -> Rc<dyn IObservable<BindingValue<BoxedValue>>>

Gets an observable of untyped binding values for a property.

fn get_binding_observable_untyped_with<TResult: PropertyValue>( &self, property: &'static FerroProperty, converter: impl Fn(BoxedValue) -> TResult + 'static, ) -> Rc<dyn IObservable<BindingValue<TResult>>>

Gets an observable of untyped binding values for a property, projecting each value with converter.

fn get_property_changed_observable( &self, property: &'static FerroProperty, ) -> ObjectPropertyChangedObservable

Gets an observable that listens for property changed events of a property on this object. It fires each time the property changes and does not fire with the current value on subscription.

fn bind_typed<P: TypedProperty>( &self, property: &'static P, source: Rc<dyn IObservable<P::Value>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a typed property of any kind to an observable. The priority is ignored for direct properties.

fn bind_typed_value<P: TypedProperty>( &self, property: &'static P, source: Rc<dyn IObservable<BindingValue<P::Value>>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a typed property of any kind to an observable of binding values. The priority is ignored for direct properties.

fn get_typed_value<P: TypedProperty>(&self, property: &'static P) -> P::Value

Gets the value of a typed property of any kind.

fn get_typed_base_value<P: TypedProperty>( &self, property: &'static P, ) -> Option<P::Value>

Gets the base value of a typed property of any kind: the value excluding animated values. For direct properties this is the value.

fn get_base_value_untyped(&self, property: &'static FerroProperty) -> BoxedValue

Gets the base value of a property as an untyped value; the unset marker when there is none.

impl FerroObjectImpl for FerroObject

fn constructed(_this: &Self)

Called once, right after the object has been allocated. This is where constructor logic that needs a reference to the object runs. Overrides must call parent_constructed first.

fn on_property_changed_core( this: &Self, change: &FerroPropertyChangedEventArgs<'_>, )

Called for every property change on the object, including changes of non-effective (base) values. Overriding this is rarely needed; override on_property_changed instead.

fn on_property_changed( _this: &Self, _change: &FerroPropertyChangedEventArgs<'_>, )

Called when the effective value of a property changes on the object.

fn update_data_validation( _this: &Self, _property: &'static FerroProperty, _state: BindingValueType, _error: Option<&BindingError>, )

Called to update the validation state for properties for which data validation is enabled.

impl ObjectType for FerroObject

type Parent = FerroObject

The base class. The root class is its own parent.

type VTable = FerroObjectVTable

The virtual table of the class.

fn vtable() -> &'static FerroObjectVTable

The virtual table used by instances whose most-derived class is Self.

fn register_class()

The static initialisation of the class. The first call on a thread, after doing the same for the base class:

impl StaticType for FerroObject

const TYPE: &'static TypeInfo

The runtime type.

impl<T: FerroObjectImpl> Subclassable<T> for FerroObject

impl Upcast<FerroObject> for FerroObject

fn upcast(&self) -> &FerroObject