Struct Flyout 

pub struct Flyout { /* private fields */ }

A flyout that displays arbitrary content.

Implementations

impl Flyout

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

The runtime type of this class.

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

Returns a strong reference to this object.

impl Flyout

pub fn content_property() -> &'static StyledProperty<Option<BoxedValue>>

Defines the Content property.

pub fn content_template_property() -> &'static StyledProperty<Option<Rc<dyn IDataTemplate>>>

Defines the ContentTemplate property.

pub fn flyout_presenter_theme_property() -> &'static StyledProperty<Option<Ref<ControlTheme>>>

Defines the FlyoutPresenterTheme property.

impl Flyout

pub fn construct() -> Self

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

pub fn new() -> Ref<Self>

Creates a flyout.

pub fn flyout_presenter_classes(&self) -> Classes

The classes collection to apply to the flyout presenter this flyout is hosting.

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

The control theme that is applied to the container element generated for the flyout presenter.

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

pub fn content(&self) -> Option<BoxedValue>

The content to display in this flyout.

pub fn set_content(&self, value: Option<BoxedValue>)

pub fn content_template(&self) -> Option<Rc<dyn IDataTemplate>>

The data template used to display the content of the flyout.

pub fn set_content_template(&self, value: Option<Rc<dyn IDataTemplate>>)

Methods from Deref<Target = PopupFlyoutBase>

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

Returns a strong reference to this object.

pub fn hide_core(&self, can_cancel: bool) -> bool

Hides the flyout; can_cancel tells whether the Closing event is raised and may cancel. Returns true if the action was handled.

pub fn show_at_core( &self, placement_target: &Control, show_at_pointer: bool, ) -> bool

Shows the flyout at the given control, at the pointer location when show_at_pointer. Returns true if the action was handled.

pub fn on_opening(&self, args: &CancelEventArgs)

Raises the Opening event.

pub fn on_closing(&self, args: &CancelEventArgs)

Raises the Closing event.

pub fn create_presenter(&self) -> Ref<Control>

Used to create the content the flyout displays.

pub fn popup(&self) -> Ref<Popup>

The popup the flyout is shown in, created on first use. For derived classes.

pub fn placement(&self) -> PlacementMode

The desired placement of the flyout in relation to its target.

pub fn set_placement(&self, value: PlacementMode)

pub fn placement_gravity(&self) -> PopupGravity

Defines in what direction the flyout should open when the placement is PlacementMode::AnchorAndGravity.

pub fn set_placement_gravity(&self, value: PopupGravity)

pub fn placement_anchor(&self) -> PopupAnchor

The anchor point on the placement rect when the placement is PlacementMode::AnchorAndGravity.

pub fn set_placement_anchor(&self, value: PopupAnchor)

pub fn horizontal_offset(&self) -> f64

The horizontal offset of the flyout in relation to its target.

pub fn set_horizontal_offset(&self, value: f64)

pub fn vertical_offset(&self) -> f64

The vertical offset of the flyout in relation to its target.

pub fn set_vertical_offset(&self, value: f64)

pub fn custom_popup_placement_callback( &self, ) -> Option<CustomPopupPlacementCallback>

The callback that positions the flyout when the placement is PlacementMode::Custom.

pub fn set_custom_popup_placement_callback( &self, value: Option<CustomPopupPlacementCallback>, )

pub fn show_mode(&self) -> FlyoutShowMode

The desired show mode.

pub fn set_show_mode(&self, value: FlyoutShowMode)

pub fn overlay_dismiss_event_pass_through(&self) -> bool

Whether the event that closes the flyout is passed through to the parent window.

Clicks outside the popup cause the popup to close. When this is false, these clicks will be handled by the popup and not be registered by the parent window. When true, the events will be passed through to the parent window.

pub fn set_overlay_dismiss_event_pass_through(&self, value: bool)

pub fn overlay_input_pass_through_element(&self) -> Option<Ref<InputElement>>

An element that should receive pointer input events even when underneath the flyout’s overlay.

pub fn set_overlay_input_pass_through_element( &self, value: impl Into<Nullable<InputElement>>, )

pub fn placement_constraint_adjustment( &self, ) -> PopupPositionerConstraintAdjustment

Describes how the flyout position will be adjusted if the unadjusted position would result in the flyout being partly constrained.

pub fn set_placement_constraint_adjustment( &self, value: PopupPositionerConstraintAdjustment, )

pub fn to_popup_host_provider(&self) -> Rc<dyn IPopupHostProvider>

The flyout as a popup host provider (the diagnostics contract it implements in the reference).

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

Raised before the flyout closes; the close can be cancelled. Disposing the returned handle unsubscribes.

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

Raised before the flyout opens; the opening can be cancelled. Disposing the returned handle unsubscribes.

pub fn show_at_with(&self, placement_target: &Control, show_at_pointer: bool)

Shows the flyout for the given control at the current pointer location when show_at_pointer, as in a context flyout.

Methods from Deref<Target = FlyoutBase>

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

Returns a strong reference to this object.

pub fn show_at(&self, placement_target: &Control)

Shows the flyout at the given control.

pub fn hide(&self)

Hides the flyout.

pub fn on_opened(&self)

Raises the Opened event.

pub fn on_closed(&self)

Raises the Closed event.

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

Raised when the flyout is opened. Disposing the returned handle unsubscribes.

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

Raised when the flyout is closed. Disposing the returned handle unsubscribes.

pub fn is_open(&self) -> bool

Whether this flyout is currently open.

Setting this property to true will show the flyout at the last known placement target. If no target has been set via show_at, setting this to true will have no effect.

pub fn set_is_open(&self, value: bool)

pub fn target(&self) -> Option<Ref<Control>>

The target used for showing the flyout.

pub fn set_target(&self, value: impl Into<Nullable<Control>>)

Sets the target used for showing the flyout. For derived classes.

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 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 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 Flyout

type Target = PopupFlyoutBase

The resulting type after dereferencing.

fn deref(&self) -> &PopupFlyoutBase

Dereferences the value.

impl FerroObjectImpl for Flyout

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 FlyoutBaseImpl for Flyout

fn show_at(this: &Self, placement_target: &Control)

Shows the flyout at the given control.

fn hide(this: &Self)

Hides the flyout.

fn on_opened(this: &Self)

Raises the Opened event.

fn on_closed(this: &Self)

Raises the Closed event.

impl ObjectType for Flyout

type Parent = PopupFlyoutBase

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

type VTable = <PopupFlyoutBase 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 PopupFlyoutBaseImpl for Flyout

fn create_presenter(this: &Self) -> Ref<Control>

Used to create the content the flyout displays.

fn on_opening(this: &Self, args: &CancelEventArgs)

Raises the Opening event.

fn hide_core(this: &Self, can_cancel: bool) -> bool

Hides the flyout; can_cancel tells whether the Closing event is raised and may cancel. Returns true if the action was handled.

fn show_at_core( this: &Self, placement_target: &Control, show_at_pointer: bool, ) -> bool

Shows the flyout at the given control, at the pointer location when show_at_pointer. Returns true if the action was handled.

fn on_closing(this: &Self, args: &CancelEventArgs)

Raises the Closing event.

impl StaticType for Flyout

const TYPE: &'static TypeInfo

The runtime type.

impl<T> Subclassable<T> for Flyout

where PopupFlyoutBase: Subclassable<T>,

impl Upcast<Flyout> for Flyout

fn upcast(&self) -> &Flyout

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

where PopupFlyoutBase: Upcast<T>,

fn upcast(&self) -> &T