pub struct MenuIsOwned<const OWNED: bool>(/* private fields */);
Expand description
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
’snew()
orBuildable::builder()
(if available) to create an instance of this class. - See C++
wxMenu
class’s documentation for more details.
Implementations§
Source§impl<const OWNED: bool> MenuIsOwned<OWNED>
impl<const OWNED: bool> MenuIsOwned<OWNED>
Sourcepub fn new() -> MenuIsOwned<OWNED>
pub fn new() -> MenuIsOwned<OWNED>
Constructs a wxMenu object.
Sourcepub fn new_with_long(style: c_long) -> MenuIsOwned<OWNED>
pub fn new_with_long(style: c_long) -> MenuIsOwned<OWNED>
Constructs a wxMenu object.
Sourcepub fn new_with_str(title: &str, style: c_long) -> MenuIsOwned<OWNED>
pub fn new_with_str(title: &str, style: c_long) -> MenuIsOwned<OWNED>
Constructs a wxMenu object with a title.
pub fn none() -> Option<&'static Self>
Trait Implementations§
Source§impl<const OWNED: bool> Clone for MenuIsOwned<OWNED>
impl<const OWNED: bool> Clone for MenuIsOwned<OWNED>
Source§impl<const OWNED: bool> DynamicCast for MenuIsOwned<OWNED>
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,
Source§impl<const OWNED: bool> EvtHandlerMethods for MenuIsOwned<OWNED>
impl<const OWNED: bool> EvtHandlerMethods for MenuIsOwned<OWNED>
Source§fn queue_event<E>(&self, event: Option<&E>)where
E: EventMethods,
fn queue_event<E>(&self, event: Option<&E>)where
E: EventMethods,
Queue event for a later processing. Read more
Source§fn add_pending_event<E>(&self, event: &E)where
E: EventMethods,
fn add_pending_event<E>(&self, event: &E)where
E: EventMethods,
Post an event to be processed later. Read more
Source§fn process_event<E>(&self, event: &E) -> boolwhere
E: EventMethods,
fn process_event<E>(&self, event: &E) -> boolwhere
E: EventMethods,
Processes an event, searching event tables and calling zero or more suitable event handler function(s). Read more
Source§fn process_event_locally<E>(&self, event: &E) -> boolwhere
E: EventMethods,
fn process_event_locally<E>(&self, event: &E) -> boolwhere
E: EventMethods,
Try to process the event in this handler and all those chained to it. Read more
Source§fn safely_process_event<E>(&self, event: &E) -> boolwhere
E: EventMethods,
fn safely_process_event<E>(&self, event: &E) -> boolwhere
E: EventMethods,
Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. Read more
Source§fn process_pending_events(&self)
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. Read more
Source§fn delete_pending_events(&self)
fn delete_pending_events(&self)
Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent(). Read more
Source§fn get_client_object(&self) -> Option<ClientDataIsOwned<false>>
fn get_client_object(&self) -> Option<ClientDataIsOwned<false>>
Returns a pointer to the user-supplied client data object. Read more
Source§fn set_client_object<C>(&self, data: Option<&C>)where
C: ClientDataMethods,
fn set_client_object<C>(&self, data: Option<&C>)where
C: ClientDataMethods,
Set the client data object. Read more
Source§fn get_evt_handler_enabled(&self) -> bool
fn get_evt_handler_enabled(&self) -> bool
Returns true if the event handler is enabled, false otherwise. Read more
Source§fn get_next_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>
fn get_next_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>
Returns the pointer to the next handler in the chain. Read more
Source§fn get_previous_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>
fn get_previous_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>
Returns the pointer to the previous handler in the chain. Read more
Source§fn set_evt_handler_enabled(&self, enabled: bool)
fn set_evt_handler_enabled(&self, enabled: bool)
Enables or disables the event handler. Read more
Source§fn set_next_handler<E>(&self, handler: Option<&E>)where
E: EvtHandlerMethods,
fn set_next_handler<E>(&self, handler: Option<&E>)where
E: EvtHandlerMethods,
Sets the pointer to the next handler. Read more
Source§fn set_previous_handler<E>(&self, handler: Option<&E>)where
E: EvtHandlerMethods,
fn set_previous_handler<E>(&self, handler: Option<&E>)where
E: EvtHandlerMethods,
Sets the pointer to the previous handler. Read more
Source§fn unlink(&self)
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). Read more
Source§fn is_unlinked(&self) -> bool
fn is_unlinked(&self) -> bool
Returns true if the next and the previous handler pointers of this event handler instance are NULL. Read more
Source§impl<const OWNED: bool> From<MenuIsOwned<OWNED>> for EvtHandlerIsOwned<OWNED>
impl<const OWNED: bool> From<MenuIsOwned<OWNED>> for EvtHandlerIsOwned<OWNED>
Source§fn from(o: MenuIsOwned<OWNED>) -> Self
fn from(o: MenuIsOwned<OWNED>) -> Self
Converts to this type from the input type.
Source§impl<const OWNED: bool> From<MenuIsOwned<OWNED>> for ObjectIsOwned<OWNED>
impl<const OWNED: bool> From<MenuIsOwned<OWNED>> for ObjectIsOwned<OWNED>
Source§fn from(o: MenuIsOwned<OWNED>) -> Self
fn from(o: MenuIsOwned<OWNED>) -> Self
Converts to this type from the input type.
Source§impl<const OWNED: bool> MenuMethods for MenuIsOwned<OWNED>
impl<const OWNED: bool> MenuMethods for MenuIsOwned<OWNED>
Source§fn append_int_str(
&self,
id: c_int,
item: &str,
help_string: &str,
kind: c_int,
) -> Option<MenuItemIsOwned<false>>
fn append_int_str( &self, id: c_int, item: &str, help_string: &str, kind: c_int, ) -> Option<MenuItemIsOwned<false>>
Adds a menu item. Read more
Adds a submenu. Read more
Adds a menu item object. Read more
Source§fn append_check_item(
&self,
id: c_int,
item: &str,
help: &str,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Source§fn append_radio_item(
&self,
id: c_int,
item: &str,
help: &str,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Source§fn append_separator(&self) -> Option<MenuItemIsOwned<false>>
fn append_separator(&self) -> Option<MenuItemIsOwned<false>>
Adds a separator to the end of the menu. Read more
Adds the given submenu to this menu. Read more
Source§fn break_(&self)
fn break_(&self)
Inserts a break in a menu, causing the next appended item to appear in a new column. Read more
Deletes the menu item from the menu. Read more
Deletes the menu item from the menu. Read more
Source§fn enable(&self, id: c_int, enable: bool)
fn enable(&self, id: c_int, enable: bool)
Enables or disables (greys out) a menu item. Read more
Source§fn find_child_item(
&self,
id: c_int,
pos: *mut c_void,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Source§fn find_item_str(&self, item_string: &str) -> c_int
fn find_item_str(&self, item_string: &str) -> c_int
Finds the menu id for a menu item string. Read more
Source§fn find_item_int<M: MenuMethods>(
&self,
id: c_int,
menu: Option<&M>,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Source§fn find_item_by_position(
&self,
position: usize,
) -> Option<MenuItemIsOwned<false>>
fn find_item_by_position( &self, position: usize, ) -> Option<MenuItemIsOwned<false>>
Returns the wxMenuItem given a position in the menu. Read more
Source§fn get_help_string(&self, id: c_int) -> String
fn get_help_string(&self, id: c_int) -> String
Returns the help string associated with a menu item. Read more
Source§fn get_label_text(&self, id: c_int) -> String
fn get_label_text(&self, id: c_int) -> String
Returns a menu item label, without any of the original mnemonics and accelerators. Read more
Returns the number of items in the menu. Read more
Inserts the given item before the position pos. Read more
Source§fn insert_int_str(
&self,
pos: usize,
id: c_int,
item: &str,
help_string: &str,
kind: c_int,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Inserts the given submenu before the position pos. Read more
Source§fn insert_check_item(
&self,
pos: usize,
id: c_int,
item: &str,
help_string: &str,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Source§fn insert_radio_item(
&self,
pos: usize,
id: c_int,
item: &str,
help_string: &str,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Source§fn insert_separator(&self, pos: usize) -> Option<MenuItemIsOwned<false>>
fn insert_separator(&self, pos: usize) -> Option<MenuItemIsOwned<false>>
Inserts a separator at the given position. Read more
Inserts the given item at position 0, i.e. before all the other existing items. Read more
Source§fn prepend_int_str(
&self,
id: c_int,
item: &str,
help_string: &str,
kind: c_int,
) -> Option<MenuItemIsOwned<false>>
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. Read more
Inserts the given submenu at position 0. Read more
Source§fn prepend_check_item(
&self,
id: c_int,
item: &str,
help_string: &str,
) -> Option<MenuItemIsOwned<false>>
fn prepend_check_item( &self, id: c_int, item: &str, help_string: &str, ) -> Option<MenuItemIsOwned<false>>
Inserts a checkable item at position 0. Read more
Source§fn prepend_radio_item(
&self,
id: c_int,
item: &str,
help_string: &str,
) -> Option<MenuItemIsOwned<false>>
fn prepend_radio_item( &self, id: c_int, item: &str, help_string: &str, ) -> Option<MenuItemIsOwned<false>>
Inserts a radio item at position 0. Read more
Source§fn prepend_separator(&self) -> Option<MenuItemIsOwned<false>>
fn prepend_separator(&self) -> Option<MenuItemIsOwned<false>>
Inserts a separator at position 0. Read more
Source§fn remove_int(&self, id: c_int) -> Option<MenuItemIsOwned<false>>
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. Read more
Removes the menu item from the menu but doesn’t delete the associated C++ object. Read more
Source§fn update_ui<E: EvtHandlerMethods>(&self, source: Option<&E>)
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. Read more
Source§fn set_invoking_window<W: WindowMethods>(&self, win: Option<&W>)
fn set_invoking_window<W: WindowMethods>(&self, win: Option<&W>)
Source§fn get_invoking_window(&self) -> WeakRef<Window>
fn get_invoking_window(&self) -> WeakRef<Window>
Source§fn get_window(&self) -> WeakRef<Window>
fn get_window(&self) -> WeakRef<Window>
Source§fn set_parent<M: MenuMethods>(&self, parent: Option<&M>)
fn set_parent<M: MenuMethods>(&self, parent: Option<&M>)
Source§fn get_parent(&self) -> WeakRef<Menu>
fn get_parent(&self) -> WeakRef<Menu>
Source§fn is_attached(&self) -> bool
fn is_attached(&self) -> bool
Source§impl<const OWNED: bool> ObjectMethods for MenuIsOwned<OWNED>
impl<const OWNED: bool> ObjectMethods for MenuIsOwned<OWNED>
Source§fn get_class_info(&self) -> Option<ClassInfoIsOwned<false>>
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). Read more
Source§fn get_ref_data(&self) -> Option<ObjectRefDataIsOwned<false>>
fn get_ref_data(&self) -> Option<ObjectRefDataIsOwned<false>>
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. Read more
Source§fn is_kind_of<C>(&self, info: Option<&C>) -> boolwhere
C: ClassInfoMethods,
fn is_kind_of<C>(&self, info: Option<&C>) -> boolwhere
C: ClassInfoMethods,
Determines whether this class is a subclass of (or the same class as) the given class. Read more
Source§fn is_same_as<O>(&self, obj: &O) -> boolwhere
O: ObjectMethods,
fn is_same_as<O>(&self, obj: &O) -> boolwhere
O: ObjectMethods,
Returns true if this object has the same data pointer as obj. Read more
Source§fn ref_<O>(&self, clone: &O)where
O: ObjectMethods,
fn ref_<O>(&self, clone: &O)where
O: ObjectMethods,
Makes this object refer to the data in clone. Read more
Source§fn set_ref_data<O>(&self, data: Option<&O>)where
O: ObjectRefDataMethods,
fn set_ref_data<O>(&self, data: Option<&O>)where
O: ObjectRefDataMethods,
Sets the wxObject::m_refData pointer. Read more
Source§fn un_ref(&self)
fn un_ref(&self)
Decrements the reference count in the associated data, and if it is zero, deletes the data. Read more
This is the same of AllocExclusive() but this method is public. Read more
Source§impl<const OWNED: bool> WxRustMethods for MenuIsOwned<OWNED>
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,
Auto Trait Implementations§
impl<const OWNED: bool> Freeze for MenuIsOwned<OWNED>
impl<const OWNED: bool> RefUnwindSafe for MenuIsOwned<OWNED>
impl<const OWNED: bool> !Send for MenuIsOwned<OWNED>
impl<const OWNED: bool> !Sync for MenuIsOwned<OWNED>
impl<const OWNED: bool> Unpin for MenuIsOwned<OWNED>
impl<const OWNED: bool> UnwindSafe for MenuIsOwned<OWNED>
Blanket Implementations§
Source§impl<T> Bindable for Twhere
T: EvtHandlerMethods,
impl<T> Bindable for Twhere
T: EvtHandlerMethods,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more