Struct MenuIsOwned

pub struct MenuIsOwned<const OWNED: bool>(/* private fields */);

A menu is a popup (or pull down) list of items, one of which may be selected before the menu goes away (clicking elsewhere dismisses the menu).

• Menu represents a C++ wxMenu class instance which your code has ownership, MenuIsOwned<false> represents one which don’t own.
• Use Menu’s new() or Buildable::builder() (if available) to create an instance of this class.
• See C++ wxMenu class’s documentation for more details.

Implementations

impl<const OWNED: bool> MenuIsOwned<OWNED>

pub fn new() -> MenuIsOwned<OWNED>

Constructs a wxMenu object.

See C++ wxMenu::wxMenu()’s documentation.

pub fn new_with_long(style: c_long) -> MenuIsOwned<OWNED>

Constructs a wxMenu object.

See C++ wxMenu::wxMenu()’s documentation.

pub fn new_with_str(title: &str, style: c_long) -> MenuIsOwned<OWNED>

Constructs a wxMenu object with a title.

See C++ wxMenu::wxMenu()’s documentation.

pub fn none() -> Option<&'static Self>

Trait Implementations

impl<const OWNED: bool> Clone for MenuIsOwned<OWNED>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const OWNED: bool> DynamicCast for MenuIsOwned<OWNED>

fn class_info() -> ClassInfoIsOwned<false>

fn as_unowned<T>(&self) -> Option<<T as WxRustMethods>::Unowned>

where T: DynamicCast,

impl<const OWNED: bool> EvtHandlerMethods for MenuIsOwned<OWNED>

fn queue_event<E>(&self, event: Option<&E>)

where E: EventMethods,

Queue event for a later processing.

fn add_pending_event<E>(&self, event: &E)

where E: EventMethods,

Post an event to be processed later.

fn process_event<E>(&self, event: &E) -> bool

where E: EventMethods,

Processes an event, searching event tables and calling zero or more suitable event handler function(s).

fn process_event_locally<E>(&self, event: &E) -> bool

where E: EventMethods,

Try to process the event in this handler and all those chained to it.

fn safely_process_event<E>(&self, event: &E) -> bool

where E: EventMethods,

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

fn process_pending_events(&self)

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

fn delete_pending_events(&self)

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

fn get_client_object(&self) -> Option<ClientDataIsOwned<false>>

Returns a pointer to the user-supplied client data object.

fn set_client_object<C>(&self, data: Option<&C>)

where C: ClientDataMethods,

Set the client data object.

fn get_evt_handler_enabled(&self) -> bool

Returns true if the event handler is enabled, false otherwise.

fn get_next_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>

Returns the pointer to the next handler in the chain.

fn get_previous_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>

Returns the pointer to the previous handler in the chain.

fn set_evt_handler_enabled(&self, enabled: bool)

Enables or disables the event handler.

fn set_next_handler<E>(&self, handler: Option<&E>)

where E: EvtHandlerMethods,

Sets the pointer to the next handler.

fn set_previous_handler<E>(&self, handler: Option<&E>)

where E: EvtHandlerMethods,

Sets the pointer to the previous handler.

fn unlink(&self)

Unlinks this event handler from the chain it’s part of (if any); then links the “previous” event handler to the “next” one (so that the chain won’t be interrupted).

fn is_unlinked(&self) -> bool

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

fn add_filter(filter: *mut c_void)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

fn remove_filter(filter: *mut c_void)

Remove a filter previously installed with AddFilter().

impl<const OWNED: bool> From<MenuIsOwned<OWNED>> for EvtHandlerIsOwned<OWNED>

fn from(o: MenuIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<MenuIsOwned<OWNED>> for ObjectIsOwned<OWNED>

fn from(o: MenuIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> MenuMethods for MenuIsOwned<OWNED>

fn append_int_str( &self, id: c_int, item: &str, help_string: &str, kind: c_int, ) -> Option<MenuItemIsOwned<false>>

Adds a menu item.

fn append_int_menu<M: MenuMethods>( &self, id: c_int, item: &str, sub_menu: Option<&M>, help_string: &str, ) -> Option<MenuItemIsOwned<false>>

Adds a submenu.

fn append_menuitem<M: MenuItemMethods>( &self, menu_item: Option<&M>, ) -> Option<MenuItemIsOwned<false>>

Adds a menu item object.

fn append_check_item( &self, id: c_int, item: &str, help: &str, ) -> Option<MenuItemIsOwned<false>>

Adds a checkable item to the end of the menu.

fn append_radio_item( &self, id: c_int, item: &str, help: &str, ) -> Option<MenuItemIsOwned<false>>

Adds a radio item to the end of the menu.

fn append_separator(&self) -> Option<MenuItemIsOwned<false>>

Adds a separator to the end of the menu.

fn append_sub_menu<M: MenuMethods>( &self, submenu: Option<&M>, text: &str, help: &str, ) -> Option<MenuItemIsOwned<false>>

Adds the given submenu to this menu.

fn break_(&self)

Inserts a break in a menu, causing the next appended item to appear in a new column.

fn check(&self, id: c_int, check: bool)

Checks or unchecks the menu item.

fn delete_int(&self, id: c_int) -> bool

Deletes the menu item from the menu.

fn delete_menuitem<M: MenuItemMethods>(&self, item: Option<&M>) -> bool

Deletes the menu item from the menu.

fn destroy_int(&self, id: c_int) -> bool

Deletes the menu item from the menu.

fn destroy_menuitem<M: MenuItemMethods>(&self, item: Option<&M>) -> bool

Deletes the menu item from the menu.

fn enable(&self, id: c_int, enable: bool)

Enables or disables (greys out) a menu item.

fn find_child_item( &self, id: c_int, pos: *mut c_void, ) -> Option<MenuItemIsOwned<false>>

Finds the menu item object associated with the given menu item identifier and, optionally, the position of the item in the menu.

fn find_item_str(&self, item_string: &str) -> c_int

Finds the menu id for a menu item string.

fn find_item_int<M: MenuMethods>( &self, id: c_int, menu: Option<&M>, ) -> Option<MenuItemIsOwned<false>>

Finds the menu item object associated with the given menu item identifier and, optionally, the (sub)menu it belongs to.

fn find_item_by_position( &self, position: usize, ) -> Option<MenuItemIsOwned<false>>

Returns the wxMenuItem given a position in the menu.

fn get_help_string(&self, id: c_int) -> String

Returns the help string associated with a menu item.

fn get_label(&self, id: c_int) -> String

Returns a menu item label.

fn get_label_text(&self, id: c_int) -> String

Returns a menu item label, without any of the original mnemonics and accelerators.

fn get_menu_item_count(&self) -> usize

Returns the number of items in the menu.

fn get_title(&self) -> String

Returns the title of the menu.

fn insert_menuitem<M: MenuItemMethods>( &self, pos: usize, menu_item: Option<&M>, ) -> Option<MenuItemIsOwned<false>>

Inserts the given item before the position pos.

fn insert_int_str( &self, pos: usize, id: c_int, item: &str, help_string: &str, kind: c_int, ) -> Option<MenuItemIsOwned<false>>

Inserts the given item before the position pos.

fn insert_int_menu<M: MenuMethods>( &self, pos: usize, id: c_int, text: &str, submenu: Option<&M>, help: &str, ) -> Option<MenuItemIsOwned<false>>

Inserts the given submenu before the position pos.

fn insert_check_item( &self, pos: usize, id: c_int, item: &str, help_string: &str, ) -> Option<MenuItemIsOwned<false>>

Inserts a checkable item at the given position.

fn insert_radio_item( &self, pos: usize, id: c_int, item: &str, help_string: &str, ) -> Option<MenuItemIsOwned<false>>

Inserts a radio item at the given position.

fn insert_separator(&self, pos: usize) -> Option<MenuItemIsOwned<false>>

Inserts a separator at the given position.

fn is_checked(&self, id: c_int) -> bool

Determines whether a menu item is checked.

fn is_enabled(&self, id: c_int) -> bool

Determines whether a menu item is enabled.

fn prepend_menuitem<M: MenuItemMethods>( &self, item: Option<&M>, ) -> Option<MenuItemIsOwned<false>>

Inserts the given item at position 0, i.e. before all the other existing items.

fn prepend_int_str( &self, id: c_int, item: &str, help_string: &str, kind: c_int, ) -> Option<MenuItemIsOwned<false>>

Inserts the given item at position 0, i.e. before all the other existing items.

fn prepend_int_menu<M: MenuMethods>( &self, id: c_int, text: &str, submenu: Option<&M>, help: &str, ) -> Option<MenuItemIsOwned<false>>

Inserts the given submenu at position 0.

fn prepend_check_item( &self, id: c_int, item: &str, help_string: &str, ) -> Option<MenuItemIsOwned<false>>

Inserts a checkable item at position 0.

fn prepend_radio_item( &self, id: c_int, item: &str, help_string: &str, ) -> Option<MenuItemIsOwned<false>>

Inserts a radio item at position 0.

fn prepend_separator(&self) -> Option<MenuItemIsOwned<false>>

Inserts a separator at position 0.

fn remove_int(&self, id: c_int) -> Option<MenuItemIsOwned<false>>

Removes the menu item from the menu but doesn’t delete the associated C++ object.

fn remove_menuitem<M: MenuItemMethods>( &self, item: Option<&M>, ) -> Option<MenuItemIsOwned<false>>

Removes the menu item from the menu but doesn’t delete the associated C++ object.

fn set_help_string(&self, id: c_int, help_string: &str)

Sets an item’s help string.

fn set_label(&self, id: c_int, label: &str)

Sets the label of a menu item.

fn set_title(&self, title: &str)

Sets the title of the menu.

fn update_ui<E: EvtHandlerMethods>(&self, source: Option<&E>)

Update the state of all menu items, recursively, by generating wxEVT_UPDATE_UI events for them.

fn set_invoking_window<W: WindowMethods>(&self, win: Option<&W>)

See C++ wxMenu::SetInvokingWindow()’s documentation.

fn get_invoking_window(&self) -> WeakRef<Window>

See C++ wxMenu::GetInvokingWindow()’s documentation.

fn get_window(&self) -> WeakRef<Window>

See C++ wxMenu::GetWindow()’s documentation.

fn get_style(&self) -> c_long

See C++ wxMenu::GetStyle()’s documentation.

fn set_parent<M: MenuMethods>(&self, parent: Option<&M>)

See C++ wxMenu::SetParent()’s documentation.

fn get_parent(&self) -> WeakRef<Menu>

See C++ wxMenu::GetParent()’s documentation.

fn attach<M: MenuBarMethods>(&self, menubar: Option<&M>)

See C++ wxMenu::Attach()’s documentation.

fn detach(&self)

See C++ wxMenu::Detach()’s documentation.

fn is_attached(&self) -> bool

See C++ wxMenu::IsAttached()’s documentation.

impl<const OWNED: bool> ObjectMethods for MenuIsOwned<OWNED>

fn get_class_info(&self) -> Option<ClassInfoIsOwned<false>>

This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

fn get_ref_data(&self) -> Option<ObjectRefDataIsOwned<false>>

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

fn is_kind_of<C>(&self, info: Option<&C>) -> bool

where C: ClassInfoMethods,

Determines whether this class is a subclass of (or the same class as) the given class.

fn is_same_as<O>(&self, obj: &O) -> bool

where O: ObjectMethods,

Returns true if this object has the same data pointer as obj.

fn ref_<O>(&self, clone: &O)

where O: ObjectMethods,

Makes this object refer to the data in clone.

fn set_ref_data<O>(&self, data: Option<&O>)

where O: ObjectRefDataMethods,

Sets the wxObject::m_refData pointer.

fn un_ref(&self)

Decrements the reference count in the associated data, and if it is zero, deletes the data.

fn un_share(&self)

This is the same of AllocExclusive() but this method is public.

impl<const OWNED: bool> WxRustMethods for MenuIsOwned<OWNED>

type Unowned = MenuIsOwned<false>

unsafe fn as_ptr(&self) -> *mut c_void

unsafe fn from_ptr(ptr: *mut c_void) -> Self

unsafe fn from_unowned_ptr(ptr: *mut c_void) -> Self::Unowned

unsafe fn with_ptr<F: Fn(&Self)>(ptr: *mut c_void, closure: F)

unsafe fn option_from(ptr: *mut c_void) -> Option<Self::Unowned>

where Self: Sized,