Struct ButtonOpenFolderPickerBehavior 

pub struct ButtonOpenFolderPickerBehavior { /* private fields */ }

Open folder picker behavior for Button: the picker opens when the button is clicked.

Implementations

impl ButtonOpenFolderPickerBehavior

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

The runtime type of this class.

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

Returns a strong reference to this object.

impl ButtonOpenFolderPickerBehavior

pub fn construct() -> Self

Creates the class data; see ferroui_base::FerroObject::construct.

pub fn new() -> Ref<Self>

Creates a behavior.

Methods from Deref<Target = OpenFolderPickerBehaviorBase>

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

Returns a strong reference to this object.

pub fn on_pick(&self, args: &FolderPickerEventArgs)

Raises the pick event.

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

Occurs after the folder picker successfully returns one or more folders. Disposing the returned handle removes the handler.

pub fn allow_multiple(&self) -> bool

Gets or sets an option indicating whether the open picker allows users to select multiple folders. This is a property of the object model.

pub fn set_allow_multiple(&self, value: bool)

pub async fn execute( &self, sender: Option<&BoxedValue>, _parameter: Option<&BoxedValue>, )

Executes the open folder picker using the provided sender and command parameter: does nothing when the sender is not a visual.

Methods from Deref<Target = PickerBehaviorBase>

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

Returns a strong reference to this object.

pub fn storage_provider(&self) -> Option<StorageProviderRef>

Gets or sets the storage provider that the picker uses to access the file system. This is a property of the object model.

pub fn set_storage_provider(&self, value: Option<StorageProviderRef>)

pub fn title(&self) -> Option<String>

Gets or sets the text that appears in the title bar of a picker. This is a property of the object model.

pub fn set_title(&self, value: Option<String>)

pub fn suggested_start_location(&self) -> Option<StorageFolderRef>

Gets or sets the initial location where the picker looks for files to present to the user. This is a property of the object model.

pub fn set_suggested_start_location(&self, value: Option<StorageFolderRef>)

pub fn suggested_start_location_path(&self) -> Option<String>

Gets or sets a fallback path that is used to resolve the suggested start location when no folder is provided.

pub fn set_suggested_start_location_path(&self, value: Option<String>)

pub fn suggested_file_name(&self) -> Option<String>

Gets or sets the file name that the file picker suggests to the user. This is a property of the object model.

pub fn set_suggested_file_name(&self, value: Option<String>)

pub fn create_suggested_start_location_directory(&self) -> bool

Gets or sets a value indicating whether to create the suggested start location directory if it doesn’t exist. This is a property of the object model.

pub fn set_create_suggested_start_location_directory(&self, value: bool)

pub fn resolve_storage_provider( &self, fallback_visual: Option<&Visual>, ) -> Option<Rc<dyn IStorageProvider>>

Resolves the storage provider using the configured value or the provided fallback visual (then the associated object, then the behavior itself).

pub async fn resolve_suggested_start_location( &self, provider: Option<Rc<dyn IStorageProvider>>, ) -> Option<Rc<dyn IStorageFolder>>

Resolves the suggested start folder using the configured value or the configured path, translated by provider.

Methods from Deref<Target = InvokeCommandBehaviorBase>

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

Returns a strong reference to this object.

pub fn command(&self) -> Option<Rc<dyn ICommand>>

Gets or sets the command this behavior should invoke.

pub fn set_command(&self, value: Option<Rc<dyn ICommand>>)

pub fn can_execute_command(&self) -> bool

Gets a value indicating whether command can execute with the current can-execute parameter.

pub fn can_execute_command_parameter(&self) -> Option<Rc<dyn AnyValue>>

Gets or sets the parameter that is passed to the can_execute of the command. When it is not set, command_parameter is used if it is set. It does not change the parameter passed to the execute of the command.

pub fn set_can_execute_command_parameter(&self, value: Option<Rc<dyn AnyValue>>)

pub fn use_command_can_execute_for_is_enabled(&self) -> bool

Gets or sets a value indicating whether the IsEnabled property of the associated control should follow can_execute_command.

pub fn set_use_command_can_execute_for_is_enabled(&self, value: bool)

pub fn command_parameter(&self) -> Option<Rc<dyn AnyValue>>

Gets or sets the parameter that is passed to the execute of the command. If this is not set, the parameter given to the behavior is used.

pub fn set_command_parameter(&self, value: Option<Rc<dyn AnyValue>>)

pub fn input_converter(&self) -> Option<Rc<dyn IValueConverter>>

Gets or sets the converter that is run on the parameter given to the behavior.

pub fn set_input_converter(&self, value: Option<Rc<dyn IValueConverter>>)

pub fn input_converter_parameter(&self) -> Option<Rc<dyn AnyValue>>

Gets or sets the parameter that is passed to the convert of the input_converter.

pub fn set_input_converter_parameter(&self, value: Option<Rc<dyn AnyValue>>)

pub fn input_converter_language(&self) -> Option<String>

Gets or sets the language that is passed to the convert of the input_converter.

pub fn set_input_converter_language(&self, value: Option<String>)

pub fn pass_event_args_to_command(&self) -> bool

Specifies whether the event args of the event that triggered this behavior should be passed to the command as a parameter.

pub fn set_pass_event_args_to_command(&self, value: bool)

pub fn resolve_parameter( &self, parameter: Option<&Rc<dyn AnyValue>>, ) -> Option<Rc<dyn AnyValue>>

Resolves the command parameter that will be supplied to the command: the command_parameter if it is set, else the parameter given to the behavior converted by the input_converter, else the parameter itself if pass_event_args_to_command.

Methods from Deref<Target = StyledElementBehaviorOfT>

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

Returns a strong reference to this object.

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

The type of the objects the behavior attaches to (the T of the reference).

pub fn associated_object_as<T>(&self) -> Option<Ref<T>>

where T: ObjectType,

Gets the object to which this behavior is attached, as T.

Methods from Deref<Target = StyledElementBehavior>

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

Returns a strong reference to this object.

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.

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

Gets the object to which the behavior is attached.

pub fn associated_styled_element(&self) -> Option<Ref<StyledElement>>

Gets the styled element to which this 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 = StyledElement>

pub fn get_logical_ancestors(&self) -> LogicalAncestors

Enumerates the ancestors of the element in the logical tree, from its parent to the root.

pub fn get_self_and_logical_ancestors(&self) -> LogicalAncestors

Enumerates the element and its ancestors in the logical tree.

pub fn find_logical_ancestor_of_type<T>( &self, include_self: bool, ) -> Option<Ref<T>>

where T: ObjectType,

Finds the first logical ancestor of class T, optionally starting with the element itself.

pub fn get_logical_children(&self) -> Rc<Vec<Ref<StyledElement>>>

The logical children of the element.

pub fn get_logical_descendants(&self) -> LogicalDescendants

Enumerates the descendants of the element in the logical tree, in depth-first pre-order.

pub fn get_self_and_logical_descendants(&self) -> LogicalDescendants

Enumerates the element and its descendants in the logical tree, in depth-first pre-order.

pub fn find_logical_descendant_of_type<T>( &self, include_self: bool, ) -> Option<Ref<T>>

where T: ObjectType,

Finds the first logical descendant of class T (depth first), optionally starting with the element itself.

pub fn get_logical_parent(&self) -> Option<Ref<StyledElement>>

The logical parent of the element.

pub fn get_logical_parent_of_type<T>(&self) -> Option<Ref<T>>

where T: ObjectType,

The logical parent of the element, if it is of class T.

pub fn get_logical_siblings(&self) -> Rc<Vec<Ref<StyledElement>>>

The children of the logical parent of the element, including the element itself; empty when the element has no logical parent.

pub fn is_logical_ancestor_of(&self, target: Option<&StyledElement>) -> bool

Whether the element is a logical ancestor of target.

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

Returns a strong reference to this object.

pub fn begin_init(&self)

Signals the beginning of a batch of initialization: styling is deferred until the matching end_init.

pub fn try_end_init(&self) -> Result<(), InitializationError>

Signals the end of a batch of initialization: the element is styled (if it is attached to a rooted logical tree) and initialized. A style or control theme that cannot be applied (two setters for the same property) is an error, the counterpart of the invalid operation EndInit raises in the managed original; what follows the failure is skipped. This is the overridable member; end_init is the form that panics on the error.

pub fn logical_children_collection_changed( &self, e: &NotifyCollectionChangedEventArgs<'_, Ref<StyledElement>>, )

Called when the logical children collection changes.

pub fn on_attached_to_logical_tree(&self, e: &LogicalTreeAttachmentEventArgs)

Called when the styled element is added to a rooted logical tree.

pub fn on_detached_from_logical_tree(&self, e: &LogicalTreeAttachmentEventArgs)

Called when the styled element is removed from a rooted logical tree.

pub fn on_data_context_changed(&self)

Called when the data context changes.

pub fn on_data_context_begin_update(&self)

Called when the data context begins updating.

pub fn on_data_context_end_update(&self)

Called when the data context finishes updating.

pub fn on_initialized(&self)

Called when the control finishes initialization.

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

The type by which the element is styled. Defaults to the element’s own type; override to be styled as a base class.

pub fn on_control_theme_changed(&self)

Called when the control theme changes.

pub fn on_templated_parent_control_theme_changed(&self)

Called when the templated parent’s control theme changes.

pub fn invalidate_styles(&self, recurse: bool)

Detaches all styles from the element (and optionally from its inheritance children) so that they are re-applied.

pub fn is_logical_root(&self) -> bool

Whether the element is the root of a logical tree.

pub fn styling_parent(&self) -> Option<StyleHostRef>

The parent style host of the element: by default the inheritance parent, when it is a styled element. The root of a tree overrides this to return the host of the global styles.

pub fn notify_child_resources_changed(&self, e: ResourcesChangedEventArgs)

Notifies the children of the element that the resources visible to them have changed. The base method notifies the logical children.

pub fn child_index_provider(&self) -> Option<Rc<dyn IChildIndexProvider>>

The child index provider implemented by the element, if any. Used to match the children of the element by their position.

pub fn is_theme_variant_root(&self) -> bool

Whether the element is a root of theme variant resolution: at a root the default theme variant resolves to the variant of the platform instead of being inherited.

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

Raised when the styled element is attached to a rooted logical tree.

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

Raised when the styled element is detached from a rooted logical tree.

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

Occurs when the data context property changes.

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

Occurs when the styled element has finished initialization.

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

Raised when the resources change on the element or an ancestor of the element.

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

Raised when the theme variant in effect for the element changes.

pub fn name(&self) -> Option<String>

The name of the styled element.

An element’s name is used to uniquely identify it within its name scope. Once the element has been styled its name may not be changed.

pub fn has_name(&self, name: &str) -> bool

Whether the name of the styled element is name, without a copy of the name (the name selectors of styles test it for every element they are evaluated on).

pub fn set_name(&self, value: Option<String>)

pub fn classes(&self) -> Classes

The styled element’s classes.

The collection is returned by handle: clones refer to the same collection.

pub fn pseudo_classes(&self) -> &dyn IPseudoClasses

The pseudoclasses of the element, settable by the control itself.

pub fn data_context(&self) -> Option<Rc<dyn AnyValue>>

The control’s data context.

The data context is an inherited property that specifies the default object that will be used for data binding.

pub fn set_data_context(&self, value: Option<Rc<dyn AnyValue>>)

pub fn is_initialized(&self) -> bool

Whether the element has finished initialization.

For more information about when this happens, see the initialized event.

pub fn styles(&self) -> Ref<Styles>

The styles for the styled element.

Styles for the entire application are added to the application’s styles collection.

pub fn is_styles_initialized(&self) -> bool

Whether the styles collection of the element has been created.

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

The type by which the element is styled.

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

The styled element’s resource dictionary.

pub fn resources_if_created(&self) -> Option<Ref<ResourceDictionary>>

The resource dictionary of the element if it has been created; unlike resources, this does not create one.

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

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

The theme to be applied to the element.

By default the theme is looked up as a resource keyed by the element’s style key; setting this property takes precedence over that lookup.

pub fn set_theme(&self, value: impl Into<Nullable<ControlTheme>>)

pub fn actual_theme_variant(&self) -> Option<ThemeVariant>

The UI theme variant that is currently used by the element, which might be different than the requested theme variant. None until a theme variant has been established for the element or an ancestor.

pub fn has_resources(&self) -> bool

Whether the element or its styles have resources.

pub fn try_get_resource( &self, key: &ResourceKey, theme: Option<&ThemeVariant>, ) -> Option<Option<Rc<dyn AnyValue>>>

Tries to find a resource within the element: in its resource dictionary, then in its styles.

pub fn try_find_resource( &self, key: &ResourceKey, theme: Option<&ThemeVariant>, ) -> Option<Option<Rc<dyn AnyValue>>>

Tries to find a resource by searching up the logical tree and then the global styles.

pub fn find_resource(&self, key: &ResourceKey) -> Option<Rc<dyn AnyValue>>

Finds a resource by searching up the logical tree and then the global styles. Returns the unset value marker if it is not found.

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

The styled element whose lookless template this element is part of.

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

Sets the templated parent. Called by the template that creates the element.

pub fn logical_children(&self) -> &FerroList<Ref<StyledElement>>

The styled element’s logical children.

pub fn is_attached_to_logical_tree(&self) -> bool

Whether the element is attached to a rooted logical tree.

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

The styled element’s logical parent.

pub fn apply_styling(&self) -> bool

Applies styling to the control if the control is initialized and styling is not already applied.

The styling system will automatically apply styling when required, so this method need only be called by tests or in rare special cases.

Returns true if styling is applied to the control, false if the control is still initializing.

pub fn try_apply_styling(&self) -> Result<bool, DuplicateSetterError>

As apply_styling, reporting a style or control theme that cannot be applied (two setters for the same property: the invalid operation of the managed original) instead of panicking. After an error the styling pass is ended and the element is not marked as styled, as when the managed original throws.

pub fn end_init(&self)

Signals the end of a batch of initialization (try_end_init). A style or control theme that cannot be applied panics with the message of the error.

pub fn initialize_if_needed(&self)

Marks the element as initialized and raises the initialization notifications, if initialization is complete.

pub fn set_parent(&self, parent: impl Into<Nullable<StyledElement>>)

Sets the element’s logical parent.

You should not usually need to call this method: it is called when an element is added to or removed from a logical children collection.

pub fn notify_attached_to_logical_tree( &self, e: &LogicalTreeAttachmentEventArgs, )

Notifies the element that it has been attached to a rooted logical tree. Called by a parent for children that are part of its logical tree without being in its logical children collection (the template child of a templated control).

pub fn notify_detached_from_logical_tree( &self, e: &LogicalTreeAttachmentEventArgs, )

Notifies the element that it has been detached from a rooted logical tree. See notify_attached_to_logical_tree.

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

The theme in effect for the element: the Theme property if set, otherwise the control theme resource keyed by the element’s style key that is visible to the element (a resource holding a Ref<ControlTheme>).

pub fn styles_added(&self, styles: &[Rc<dyn IStyle>])

Called when styles are added to the styles collection of the element or a nested styles collection.

pub fn styles_removed(&self, styles: &[Rc<dyn IStyle>])

Called when styles are removed from the styles collection of the element or a nested styles collection.

pub fn notify_resources_changed( &self, e: ResourcesChangedEventArgs, propagate: bool, )

Notifies the element, and with propagate its children, that the resources visible to it have changed.

pub fn set_data_context_with_priority( &self, value: Option<Rc<dyn AnyValue>>, priority: BindingPriority, ) -> Option<Rc<dyn IDisposable>>

The priority-aware setter used by templates.

pub fn bind_class( &self, class_name: &str, source: &dyn BindingBase, anchor: Option<&Ref<FerroObject>>, ) -> Rc<dyn BindingExpressionBase>

Binds the presence of the class class_name on this element to source. anchor provides the context the binding locates its source with when the element cannot.

Methods from Deref<Target = Animatable>

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

Returns a strong reference to this object.

pub fn clock(&self) -> Option<Rc<dyn IClock>>

The clock which controls the animations and transitions on the object and, by inheritance, on its descendants. The global clock is used when there is none.

pub fn set_clock(&self, value: Option<Rc<dyn IClock>>)

pub fn transitions(&self) -> Option<Transitions>

The property transitions of the object.

pub fn set_transitions(&self, value: Option<Transitions>)

pub fn enable_transitions(&self)

Enables transitions for the object.

This is called when the object is attached to the visual tree, so that transitions do not run on its initial property values.

pub fn disable_transitions(&self)

Disables transitions for the object.

This is called when the object is detached from the visual tree.

pub fn try_get_transition_instance( &self, transition: &Rc<dyn ITransition>, ) -> Option<Rc<TransitionInstance>>

The progress of the transition that transition is currently running on this object: the instance created when the transition was last applied. None when the transition is not one of the object’s transitions or has not been applied.

pub fn take_transition_interruption_state<T>(&self) -> Option<Rc<T>>

where T: Any,

Takes state left by the preceding application of the same transition on this object.

This is only available synchronously inside ITransition::apply. A spring transition can retain its last sampled velocity here, without storing mutable animation state in a transition definition that may be shared by several controls. Removal or visual-tree detachment discards the state. Normal duration-based transitions do not use this hook.

pub fn report_transition_interruption_state<T>(&self, state: Rc<T>)

where T: Any,

Reports state to carry into the next application of this transition on this object.

Call only from ITransition::apply. The state may be updated by the running animation, but must not strongly own the target object. Outside a transition application this has no effect. Store zero velocity when an animation completes or is accessibility-canceled.

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 Deref for ButtonOpenFolderPickerBehavior

type Target = OpenFolderPickerBehaviorBase

The resulting type after dereferencing.

fn deref(&self) -> &OpenFolderPickerBehaviorBase

Dereferences the value.

impl FerroObjectImpl for ButtonOpenFolderPickerBehavior

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 ButtonOpenFolderPickerBehavior

type Parent = OpenFolderPickerBehaviorBase

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

type VTable = <OpenFolderPickerBehaviorBase 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 OpenFolderPickerBehaviorBaseImpl for ButtonOpenFolderPickerBehavior

fn on_pick(this: &Self, args: &FolderPickerEventArgs)

Raises the pick event.

impl StaticType for ButtonOpenFolderPickerBehavior

const TYPE: &'static TypeInfo

The runtime type.

impl StyledElementBehaviorImpl for ButtonOpenFolderPickerBehavior

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(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_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 StyledElementImpl for ButtonOpenFolderPickerBehavior

fn begin_init(this: &Self)

Signals the beginning of a batch of initialization: styling is deferred until the matching end_init.

fn try_end_init(this: &Self) -> Result<(), InitializationError>

Signals the end of a batch of initialization: the element is styled (if it is attached to a rooted logical tree) and initialized. A style or control theme that cannot be applied (two setters for the same property) is an error, the counterpart of the invalid operation EndInit raises in the managed original; what follows the failure is skipped. This is the overridable member; end_init is the form that panics on the error.

fn logical_children_collection_changed( this: &Self, e: &NotifyCollectionChangedEventArgs<'_, Ref<StyledElement>>, )

Called when the logical children collection changes.

fn on_attached_to_logical_tree(this: &Self, e: &LogicalTreeAttachmentEventArgs)

Called when the styled element is added to a rooted logical tree.

fn on_detached_from_logical_tree( this: &Self, e: &LogicalTreeAttachmentEventArgs, )

Called when the styled element is removed from a rooted logical tree.

fn on_data_context_changed(this: &Self)

Called when the data context changes.

fn on_data_context_begin_update(this: &Self)

Called when the data context begins updating.

fn on_data_context_end_update(this: &Self)

Called when the data context finishes updating.

fn on_initialized(this: &Self)

Called when the control finishes initialization.

fn style_key_override(this: &Self) -> &'static TypeInfo

The type by which the element is styled. Defaults to the element’s own type; override to be styled as a base class.

fn on_control_theme_changed(this: &Self)

Called when the control theme changes.

fn on_templated_parent_control_theme_changed(this: &Self)

Called when the templated parent’s control theme changes.

fn invalidate_styles(this: &Self, recurse: bool)

Detaches all styles from the element (and optionally from its inheritance children) so that they are re-applied.

fn is_logical_root(this: &Self) -> bool

Whether the element is the root of a logical tree.

fn styling_parent(this: &Self) -> Option<StyleHostRef>

The parent style host of the element: by default the inheritance parent, when it is a styled element. The root of a tree overrides this to return the host of the global styles.

fn notify_child_resources_changed(this: &Self, e: ResourcesChangedEventArgs)

Notifies the children of the element that the resources visible to them have changed. The base method notifies the logical children.

fn child_index_provider(this: &Self) -> Option<Rc<dyn IChildIndexProvider>>

The child index provider implemented by the element, if any. Used to match the children of the element by their position.

fn is_theme_variant_root(this: &Self) -> bool

Whether the element is a root of theme variant resolution: at a root the default theme variant resolves to the variant of the platform instead of being inherited.

impl<T> Subclassable<T> for ButtonOpenFolderPickerBehavior

where OpenFolderPickerBehaviorBase: Subclassable<T>,

impl Upcast<ButtonOpenFolderPickerBehavior> for ButtonOpenFolderPickerBehavior

fn upcast(&self) -> &ButtonOpenFolderPickerBehavior

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

where OpenFolderPickerBehaviorBase: Upcast<T>,

fn upcast(&self) -> &T