Struct Behavior 

pub struct Behavior { /* private fields */ }

A base class for behaviors, implementing the basic plumbing of IBehavior.

The class is abstract: deriving classes override the members of BehaviorImpl.

Deviation (DEVIATIONS.md, Behaviors): the reference names the hooks of the attachment of the host to the logical tree OnAttachedToLogicalTree / OnDetachedFromLogicalTree; the styled element behaviors would hide the members of the same name of the styled element, so both families name them on_attached_to_logical_tree_event and on_detached_from_logical_tree_event, as the reference names the other host hooks (OnInitializedEvent, OnDataContextChangedEvent).

Implementations

impl Behavior

pub const TYPE: &'static TypeInfo = <Behavior as ::ferroui_base::StaticType>::TYPE

The runtime type of this class.

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

Returns a strong reference to this object.

impl Behavior

pub fn on_attached(&self)

Called after the behavior is attached to the associated object.

Override this to hook up functionality to the associated object.

pub fn on_detaching(&self)

Called when the behavior is being detached from its associated object.

Override this to unhook functionality from the associated object.

pub fn on_attached_to_visual_tree(&self)

Called after the associated object is attached to the visual tree.

Invoked only when the associated object is a visual.

pub fn on_detached_from_visual_tree(&self)

Called when the associated object is being detached from the visual tree.

Invoked only when the associated object is a visual.

pub fn on_attached_to_logical_tree_event(&self)

Called after the associated object is attached to the logical tree (OnAttachedToLogicalTree).

Invoked only when the associated object is a styled element.

pub fn on_detached_from_logical_tree_event(&self)

Called when the associated object is being detached from the logical tree (OnDetachedFromLogicalTree).

Invoked only when the associated object is a styled element.

pub fn on_loaded(&self)

Called after the associated object is loaded.

Invoked only when the associated object is a control.

pub fn on_unloaded(&self)

Called when the associated object is unloaded.

Invoked only when the associated object is a control.

pub fn on_initialized_event(&self)

Called when the associated object is initialized.

Invoked only when the associated object is a styled element.

pub fn on_data_context_changed_event(&self)

Called when the data context of the associated object changed.

Invoked only when the associated object is a styled element.

pub fn on_resources_changed_event(&self)

Called when the resources of the associated object changed.

Invoked only when the associated object is a styled element.

pub fn on_actual_theme_variant_changed_event(&self)

Called when the actual theme variant of the associated object changed.

Invoked only when the associated object is a styled element.

impl Behavior

pub fn is_enabled_property() -> &'static StyledProperty<bool>

Identifies the IsEnabled property.

impl Behavior

pub fn construct() -> Self

Creates the class data; see FerroObject::construct.

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

Gets the object to which the behavior is attached.

pub fn is_enabled(&self) -> bool

Gets or sets a value indicating whether this instance is enabled.

pub fn set_is_enabled(&self, value: bool)

pub fn attach(&self, associated_object: impl Into<Nullable<FerroObject>>)

Attaches the behavior to the specified object.

Panics

Panics if the behavior is attached to another object.

pub fn detach(&self)

Detaches the behaviors from the associated_object.

Methods from Deref<Target = FerroObject>

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 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>(&self) -> bool

where T: ObjectType,

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

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

where T: ObjectType,

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>(&self, property: &'static StyledProperty<T>)

where T: PropertyValue,

Clears a property’s local value.

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

where T: PropertyValue,

Gets a property value.

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

where T: PropertyValue,

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 has_local_value_binding(&self, property: &FerroProperty) -> bool

Whether a local-value binding targets this property, including direct properties and observable bindings. Unlike is_set, this does not rely on a styled property’s effective-value entry. It does not inspect bindings at style/template priorities.

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

where T: PropertyValue,

Sets a property value with local value priority.

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

where T: PropertyValue,

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>( &self, property: &'static StyledProperty<T>, value: T, )

where T: PropertyValue,

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 bind_binding_with_priority( &self, property: &'static FerroProperty, binding: &dyn BindingBase, priority: BindingPriority, anchor: Option<&Ref<FerroObject>>, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding at the given priority, whatever the default priority of the binding is. Disposing the returned expression removes the binding.

An addition (no upstream counterpart): the values of WinUI’s visual states are bound at BindingPriority::Animation.

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>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<T>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

where T: PropertyValue,

Binds a property to an observable.

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

where T: PropertyValue,

Binds a property to an observable of binding values.

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

where T: PropertyValue,

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>(&self, property: &'static DirectPropertyBase<T>) -> T

where T: PropertyValue,

Gets a direct property value.

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

where T: PropertyValue,

Sets a direct property value.

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

where T: PropertyValue,

Resets a direct property to its unset value.

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

where T: PropertyValue,

Binds a direct property to an observable.

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

where T: PropertyValue,

Binds a direct property to an observable of binding values.

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

where T: PropertyValue,

Binds a direct property to an observable of untyped values.

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

where T: PropertyValue,

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>( &self, property: &'static DirectPropertyBase<T>, field: &Cell<T>, value: T, ) -> bool

where T: PropertyValue + Copy,

set_and_raise for Copy values stored in a Cell.

pub fn get_value_untyped( &self, property: &'static FerroProperty, ) -> Rc<dyn AnyValue>

Gets a property value as an untyped value.

pub fn set_value_untyped( &self, property: &'static FerroProperty, value: &(dyn Any + 'static), 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 + 'static), )

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<Rc<dyn AnyValue>>>, 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>( &self, property: &'static FerroProperty, old_value: Option<&T>, new_value: &T, priority: BindingPriority, is_effective_value: bool, )

where T: PropertyValue,

Raises a property changed notification.

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

where T: PropertyValue,

Raises a property changed notification for a direct property.

Trait Implementations

impl BehaviorImpl for Behavior

fn on_attached(_this: &Self)

Called after the behavior is attached to the associated object.

fn on_detaching(_this: &Self)

Called when the behavior is being detached from its associated object.

fn on_attached_to_visual_tree(_this: &Self)

Called after the associated object is attached to the visual tree.

fn on_detached_from_visual_tree(_this: &Self)

Called when the associated object is being detached from the visual tree.

fn on_attached_to_logical_tree_event(_this: &Self)

Called after the associated object is attached to the logical tree (OnAttachedToLogicalTree).

fn on_detached_from_logical_tree_event(_this: &Self)

Called when the associated object is being detached from the logical tree (OnDetachedFromLogicalTree).

fn on_loaded(_this: &Self)

Called after the associated object is loaded.

fn on_unloaded(_this: &Self)

Called when the associated object is unloaded.

fn on_initialized_event(_this: &Self)

Called when the associated object is initialized.

fn on_data_context_changed_event(_this: &Self)

Called when the data context of the associated object changed.

fn on_resources_changed_event(_this: &Self)

Called when the resources of the associated object changed.

fn on_actual_theme_variant_changed_event(_this: &Self)

Called when the actual theme variant of the associated object changed.

impl Deref for Behavior

type Target = FerroObject

The resulting type after dereferencing.

fn deref(&self) -> &FerroObject

Dereferences the value.

impl FerroObjectImpl for Behavior

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 IBehavior for Behavior

fn associated_object(&self) -> Option<Ref<FerroObject>>

Gets the object to which the behavior is attached.

fn attach(&self, associated_object: Option<Ref<FerroObject>>)

Attaches to the specified object.

fn detach(&self)

Detaches this instance from its associated object.

impl IBehaviorEventsHandler for Behavior

fn attached_to_visual_tree_event_handler(&self)

Called when element is attached to the visual tree.

fn detached_from_visual_tree_event_handler(&self)

Called when element is detached from the visual tree.

fn attached_to_logical_tree_event_handler(&self)

Called when element is attached to the logical tree.

fn detached_from_logical_tree_event_handler(&self)

Called when element is detached from the logical tree.

fn loaded_event_handler(&self)

Called when element is loaded.

fn unloaded_event_handler(&self)

Called when element is unloaded.

fn initialized_event_handler(&self)

Called when element is initialized.

fn data_context_changed_event_handler(&self)

Called when element DataContext changed.

fn resources_changed_event_handler(&self)

Called when element Resources changed.

fn actual_theme_variant_changed_event_handler(&self)

Called when element ActualThemeVariant changed.

impl ObjectType for Behavior

type Parent = FerroObject

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

type VTable = BehaviorVTable

The virtual table of the class.

fn vtable() -> &'static Self::VTable

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 Behavior

const TYPE: &'static TypeInfo

The runtime type.

impl<T: BehaviorImpl> Subclassable<T> for Behavior

where FerroObject: Subclassable<T>,

impl Upcast<Behavior> for Behavior

fn upcast(&self) -> &Behavior

impl<T: ?Sized> Upcast<T> for Behavior

where FerroObject: Upcast<T>,

fn upcast(&self) -> &T