Struct ControlTheme 

pub struct ControlTheme { /* private fields */ }

Defines a switchable theme for a control.

Implementations

impl ControlTheme

pub const TYPE: &'static TypeInfo = <ControlTheme as crate::StaticType>::TYPE

The runtime type of this class.

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

Returns a strong reference to this object.

impl ControlTheme

pub fn construct() -> Self

Creates the class data; see FerroObject::construct.

pub fn new() -> Ref<Self>

Creates a control theme without a target type.

pub fn with_target_type(target_type: &'static TypeInfo) -> Ref<Self>

Creates a control theme for the given control type.

pub fn for_type<T: ObjectType>() -> Ref<Self>

Creates a control theme for control class T.

pub fn target_type(&self) -> Option<&'static TypeInfo>

The type for which this control theme is intended.

pub fn set_target_type(&self, value: Option<&'static TypeInfo>)

pub fn based_on(&self) -> Option<Ref<ControlTheme>>

A control theme that is the basis of the current theme.

pub fn set_based_on(&self, value: Option<Ref<ControlTheme>>)

pub fn with_setters( target_type: &'static TypeInfo, setters: impl IntoIterator<Item = Rc<Setter>>, ) -> Ref<Self>

Creates a control theme for the given control type with setters.

Methods from Deref<Target = StyleBase>

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

Returns a strong reference to this object.

pub fn set_parent(&self, parent: Option<&Ref<StyleBase>>)

Sets the parent style. Called when the style is added to or removed from the children of another style; validates that the style can be nested in parent.

pub fn to_display_string(&self) -> String

A string describing the style: its selector, target type or query.

pub fn children(&self) -> StyleChildren

The children of the style.

pub fn owner(&self) -> Option<ResourceHostRef>

The owner of the style: the resource host whose styles collection the style, or an ancestor of it, was added to.

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

Raised when the owner of the style changes.

pub fn parent(&self) -> Option<Ref<StyleBase>>

The parent style, if the style is a nested style.

pub fn resources(&self) -> Ref<ResourceDictionary>

The dictionary of style resources.

pub fn set_resources(&self, value: Ref<ResourceDictionary>)

pub fn setters(&self) -> FerroList<Rc<dyn SetterBase>>

The style’s setters. The list is returned by handle: clones refer to the same list.

pub fn add_setter(&self, setter: Rc<dyn SetterBase>)

Adds a setter to the style.

pub fn clear_setters(&self)

Removes all setters from the style.

pub fn add(&self, setter: Rc<dyn SetterBase>)

Adds a setter to the style.

pub fn animations(&self) -> FerroList<Rc<dyn IAnimation>>

The style’s animations. The list is returned by handle: clones refer to the same list.

pub fn add_animation(&self, animation: impl Into<Rc<dyn IAnimation>>)

Adds an animation to the style: it runs on every control the style applies to, while the style is active.

pub fn clear_animations(&self)

Removes all animations from the style.

pub fn add_child(&self, child: &BoxedValue)

Adds an untyped child: a setter is added to the setters, a style to the child styles. Panics for anything else.

pub fn add_style(&self, style: impl Into<Rc<dyn IStyle>>)

Adds a child style.

pub fn try_get_resource( &self, key: &ResourceKey, theme_variant: Option<&ThemeVariant>, ) -> Option<ResourceValue>

Tries to find a resource in the style’s resources and then in its child styles.

pub fn add_owner(&self, owner: &ResourceHostRef)

Adds an owner to the style.

pub fn remove_owner(&self, owner: &ResourceHostRef)

Removes the owner of the style.

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: 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 Deref for ControlTheme

type Target = StyleBase

The resulting type after dereferencing.

fn deref(&self) -> &StyleBase

Dereferences the value.

impl FerroObjectImpl for ControlTheme

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 ControlTheme

type Parent = StyleBase

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

type VTable = <StyleBase as ObjectType>::VTable

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 ControlTheme

const TYPE: &'static TypeInfo

The runtime type.

impl StyleBaseImpl for ControlTheme

fn set_parent(_this: &Self, _parent: Option<&Ref<StyleBase>>)

Sets the parent style. Called when the style is added to or removed from the children of another style; validates that the style can be nested in parent.

fn to_display_string(this: &Self) -> String

A string describing the style: its selector, target type or query.

impl<T> Subclassable<T> for ControlTheme

where StyleBase: Subclassable<T>,

impl Upcast<ControlTheme> for ControlTheme

fn upcast(&self) -> &ControlTheme

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

where StyleBase: Upcast<T>,

fn upcast(&self) -> &T