Struct NativeMenu 

pub struct NativeMenu { /* private fields */ }

A menu that is shown by the platform: the menu of a window or of the application, the menu of a tray icon or of the dock.

Implementations

impl NativeMenu

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

The runtime type of this class.

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

Returns a strong reference to this object.

impl NativeMenu

pub fn parent_property() -> &'static DirectProperty<NativeMenu, Option<Ref<NativeMenuItem>>>

Defines the Parent property.

impl NativeMenu

pub fn construct() -> Self

Creates the class data; see FerroObject::construct.

pub fn new() -> Ref<Self>

pub fn items(&self) -> FerroList<Ref<NativeMenuItemBase>>

The items of the menu.

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

Raised when the menu requests an update.

Use this event to add, remove or modify menu items before a menu is shown or a hotkey is pressed.

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

Raised before the menu is opened.

Do not update the menu in this event; use needs_update.

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

Raised after the menu is closed.

Do not update the menu in this event; use needs_update.

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

The item the menu is the submenu of.

pub fn to_exporter_events_bridge( &self, ) -> Rc<dyn INativeMenuExporterEventsImplBridge>

The menu viewed as the contract through which the platform exporter of the menu raises its events.

pub fn add(&self, item: impl IntoRef<NativeMenuItemBase>)

Adds an item to the menu.

pub fn iter(&self) -> IntoIter<Ref<NativeMenuItemBase>>

Enumerates the items of the menu.

impl NativeMenu

pub fn is_native_menu_exported_property() -> &'static AttachedProperty<bool>

Defines the IsNativeMenuExported attached property.

pub fn menu_property() -> &'static AttachedProperty<Option<Ref<NativeMenu>>>

Defines the Menu attached property.

impl NativeMenu

pub fn get_is_native_menu_exported(tl: &TopLevel) -> bool

Whether the native menu of the top-level is exported to the platform.

pub fn set_menu(o: &FerroObject, menu: Option<Ref<NativeMenu>>)

Sets the native menu of an object: a top-level, the application or an object that provides a native menu exporter.

pub fn get_menu(o: &FerroObject) -> Option<Ref<NativeMenu>>

Gets the native menu of an 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 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 NativeMenu

type Target = FerroObject

The resulting type after dereferencing.

fn deref(&self) -> &FerroObject

Dereferences the value.

impl FerroObjectImpl for NativeMenu

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 IntoIterator for &NativeMenu

type Item = Ref<NativeMenuItemBase>

The type of the elements being iterated over.

type IntoIter = IntoIter<Ref<NativeMenuItemBase>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ObjectType for NativeMenu

type Parent = FerroObject

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

type VTable = <FerroObject 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 NativeMenu

const TYPE: &'static TypeInfo

The runtime type.

impl<T> Subclassable<T> for NativeMenu

where FerroObject: Subclassable<T>,

impl Upcast<NativeMenu> for NativeMenu

fn upcast(&self) -> &NativeMenu

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

where FerroObject: Upcast<T>,

fn upcast(&self) -> &T