Skip to main content

Menu

Struct Menu 

Source
pub struct Menu { /* private fields */ }
Expand description

A menu, which contains zero or more items

Implementations§

Source§

impl Menu

Source

pub fn name(&self) -> String

Returns the name of this menu

Source

pub fn set_name<S: AsRef<str>>(&self, name: S) -> Result<(), NulError>

Sets the name of this menu

§Errors

Returns an error if the name contains a NUL byte

Source

pub fn add_child<R, C>(&self, child: R)
where R: Into<Rc<C>>, Rc<C>: Into<Item>,

Adds a child to this menu The child argument may be a Menu, ActionItem, CheckItem, or Separator, or an Rc containing one of these types.

Source

pub fn add_to_plugins_menu(&self) -> Result<(), MenuError>

Adds this menu as a child of the plugins menu

§Errors

This function will error if this Menu is already in a menu.

Source

pub fn remove_from_plugins_menu(&self) -> Result<(), MenuError>

Removes this menu from the plugins menu

§Errors

This function will error if this Menu is not in the plugins menu, or if it is not in any menu at all.

Trait Implementations§

Source§

impl Debug for Menu

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Drop for Menu

Removes this menu from X-Plane, to prevent the menu handler from running and accessing a dangling pointer. Also drops all child items.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl !Freeze for Menu

§

impl !RefUnwindSafe for Menu

§

impl !Send for Menu

§

impl !Sync for Menu

§

impl !UnwindSafe for Menu

§

impl Unpin for Menu

§

impl UnsafeUnpin for Menu

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.