Struct NSMenu

Source

#[repr(C)]
pub struct NSMenu { /* private fields */ }

Available on crate feature NSMenu only.

Expand description

Available on crate feature NSMenuItem only.

Source

pub unsafe fn removeItemAtIndex(&self, index: NSInteger)

Source

pub unsafe fn removeItem(&self, item: &NSMenuItem)

Available on crate feature NSMenuItem only.

Source

pub unsafe fn setSubmenu_forItem( &self, menu: Option<&NSMenu>, item: &NSMenuItem, )

Available on crate feature NSMenuItem only.

Source

pub unsafe fn removeAllItems(&self)

Source

pub unsafe fn itemArray(&self) -> Retained<NSArray<NSMenuItem>>

Available on crate feature NSMenuItem only.

Source

pub unsafe fn setItemArray(&self, item_array: &NSArray<NSMenuItem>)

Available on crate feature NSMenuItem only.

Setter for itemArray.

Source

pub unsafe fn numberOfItems(&self) -> NSInteger

Source

pub unsafe fn itemAtIndex( &self, index: NSInteger, ) -> Option<Retained<NSMenuItem>>

Available on crate feature NSMenuItem only.

Source

pub unsafe fn indexOfItem(&self, item: &NSMenuItem) -> NSInteger

Available on crate feature NSMenuItem only.

Available on crate feature NSMenuItem only.

Available on crate feature NSMenuItem only.

Source

pub unsafe fn performActionForItemAtIndex(&self, index: NSInteger)

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSMenuDelegate>>>

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSMenuDelegate>>, )

This is a weak property. Setter for delegate.

Source

pub unsafe fn menuBarHeight(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub unsafe fn cancelTracking(&self)

Source

pub unsafe fn cancelTrackingWithoutAnimation(&self)

Source

pub unsafe fn highlightedItem(&self) -> Option<Retained<NSMenuItem>>

Available on crate feature NSMenuItem only.

Source

pub unsafe fn minimumWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub unsafe fn setMinimumWidth(&self, minimum_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumWidth.

Source

pub unsafe fn size(&self) -> NSSize

Source

pub unsafe fn font(&self) -> Option<Retained<NSFont>>

Available on crate feature NSFont only.

Source

pub unsafe fn setFont(&self, font: Option<&NSFont>)

Available on crate feature NSFont only.

pub unsafe fn setUserInterfaceLayoutDirection( &self, user_interface_layout_direction: NSUserInterfaceLayoutDirection, )

Available on crate feature NSUserInterfaceLayout only.

Setter for userInterfaceLayoutDirection.

Source §

impl NSMenu

Methods declared on superclass NSObject.

Source

pub fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn setSelectedItems(&self, selected_items: &NSArray<NSMenuItem>)

Available on crate feature NSMenuItem only.

Setter for selectedItems.

Source §

impl NSMenu

NSSubmenuAction.

Source

pub unsafe fn submenuAction(&self, sender: Option<&AnyObject>)

Source §

impl NSMenu

NSMenuPropertiesToUpdate.

Source

👎Deprecated

Setter for menuChangedMessagesEnabled.

Source

pub unsafe fn helpRequested(&self, event_ptr: &NSEvent)

👎Deprecated

Available on crate feature NSEvent only.

Source

pub unsafe fn isTornOff(&self) -> bool

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature NSAccessibilityConstants only.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Available on crate feature NSAccessibilityConstants only.

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

The name of the Objective-C class that this type represents. Read more

Source §

type Super = NSObject

The superclass of this class. Read more

Source §

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread. Read more

Source §

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more

Dereferences the value.

Source §

impl Hash for NSMenu

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for NSMenu

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

Available on crate feature NSAccessibilityConstants only.

Source §

unsafe fn setAccessibilitySubrole( &self, accessibility_subrole: Option<&NSAccessibilitySubrole>, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

unsafe fn setAccessibilityOrientation( &self, accessibility_orientation: NSAccessibilityOrientation, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

unsafe fn setAccessibilityRole( &self, accessibility_role: Option<&NSAccessibilityRole>, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

unsafe fn setAccessibilityCustomRotors( &self, accessibility_custom_rotors: &NSArray<NSAccessibilityCustomRotor>, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityCustomRotor only.

unsafe fn setAccessibilityHorizontalUnits( &self, accessibility_horizontal_units: NSAccessibilityUnits, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

Setter for accessibilityHorizontalUnits.

Source §

unsafe fn accessibilityVerticalUnits(&self) -> NSAccessibilityUnits
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

Source §

unsafe fn setAccessibilityVerticalUnits( &self, accessibility_vertical_units: NSAccessibilityUnits, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

unsafe fn setAccessibilityUnits( &self, accessibility_units: NSAccessibilityUnits, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

Setter for accessibilityUnits.

Source §

unsafe fn accessibilityUnitDescription(&self) -> Option<Retained<NSString>>
where Self: Sized + Message,

Source §

unsafe fn setAccessibilityUnitDescription( &self, accessibility_unit_description: Option<&NSString>, )
where Self: Sized + Message,

Setter for accessibilityUnitDescription.

Source §

unsafe fn accessibilityRulerMarkerType(&self) -> NSAccessibilityRulerMarkerType
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

Source §

unsafe fn setAccessibilityRulerMarkerType( &self, accessibility_ruler_marker_type: NSAccessibilityRulerMarkerType, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

unsafe fn setAccessibilitySortDirection( &self, accessibility_sort_direction: NSAccessibilitySortDirection, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityConstants only.

unsafe fn accessibilityCustomActions( &self, ) -> Option<Retained<NSArray<NSAccessibilityCustomAction>>>
where Self: Sized + Message,

Available on crate feature NSAccessibilityCustomAction only.

Source §

unsafe fn setAccessibilityCustomActions( &self, accessibility_custom_actions: Option<&NSArray<NSAccessibilityCustomAction>>, )
where Self: Sized + Message,

Available on crate feature NSAccessibilityCustomAction only.

Setter for accessibilityCustomActions.

unsafe fn accessibilityFrame(&self) -> NSRect
where Self: Sized + Message,

Source §

unsafe fn accessibilityParent(&self) -> Option<Retained<AnyObject>>
where Self: Sized + Message,

Source §

Check if the object is an instance of the class, or one of its subclasses. Read more

Source §

fn is_kind_of<T>(&self) -> bool
where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl RefEncode for NSMenu

Source §

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type. Read more

Source §

impl DowncastTarget for NSMenu

Source §

impl Eq for NSMenu

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

Struct NSMenuCopy item path

Implementations§

impl NSMenu

pub unsafe fn initWithTitle( this: Allocated<Self>, title: &NSString, ) -> Retained<Self>

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Retained<Self>

pub unsafe fn title(&self) -> Retained<NSString>

pub unsafe fn setTitle(&self, title: &NSString)

pub unsafe fn popUpContextMenu_withEvent_forView( menu: &NSMenu, event: &NSEvent, view: &NSView, )

pub unsafe fn popUpContextMenu_withEvent_forView_withFont( menu: &NSMenu, event: &NSEvent, view: &NSView, font: Option<&NSFont>, )

pub unsafe fn popUpMenuPositioningItem_atLocation_inView( &self, item: Option<&NSMenuItem>, location: NSPoint, view: Option<&NSView>, ) -> bool

pub unsafe fn setMenuBarVisible(visible: bool, mtm: MainThreadMarker)

pub unsafe fn menuBarVisible(mtm: MainThreadMarker) -> bool

pub unsafe fn supermenu(&self) -> Option<Retained<NSMenu>>

pub unsafe fn setSupermenu(&self, supermenu: Option<&NSMenu>)

pub unsafe fn insertItem_atIndex(&self, new_item: &NSMenuItem, index: NSInteger)

pub fn addItem(&self, new_item: &NSMenuItem)

pub unsafe fn insertItemWithTitle_action_keyEquivalent_atIndex( &self, string: &NSString, selector: Option<Sel>, char_code: &NSString, index: NSInteger, ) -> Retained<NSMenuItem>

pub unsafe fn addItemWithTitle_action_keyEquivalent( &self, string: &NSString, selector: Option<Sel>, char_code: &NSString, ) -> Retained<NSMenuItem>

pub unsafe fn removeItemAtIndex(&self, index: NSInteger)

pub unsafe fn removeItem(&self, item: &NSMenuItem)

pub unsafe fn setSubmenu_forItem( &self, menu: Option<&NSMenu>, item: &NSMenuItem, )

pub unsafe fn removeAllItems(&self)

pub unsafe fn itemArray(&self) -> Retained<NSArray<NSMenuItem>>

pub unsafe fn setItemArray(&self, item_array: &NSArray<NSMenuItem>)

pub unsafe fn numberOfItems(&self) -> NSInteger

pub unsafe fn itemAtIndex( &self, index: NSInteger, ) -> Option<Retained<NSMenuItem>>

pub unsafe fn indexOfItem(&self, item: &NSMenuItem) -> NSInteger

pub unsafe fn indexOfItemWithTitle(&self, title: &NSString) -> NSInteger

pub unsafe fn indexOfItemWithTag(&self, tag: NSInteger) -> NSInteger

pub unsafe fn indexOfItemWithRepresentedObject( &self, object: Option<&AnyObject>, ) -> NSInteger

pub unsafe fn indexOfItemWithSubmenu( &self, submenu: Option<&NSMenu>, ) -> NSInteger

pub unsafe fn indexOfItemWithTarget_andAction( &self, target: Option<&AnyObject>, action_selector: Option<Sel>, ) -> NSInteger

pub unsafe fn itemWithTitle( &self, title: &NSString, ) -> Option<Retained<NSMenuItem>>

pub unsafe fn itemWithTag(&self, tag: NSInteger) -> Option<Retained<NSMenuItem>>

pub unsafe fn autoenablesItems(&self) -> bool

pub unsafe fn setAutoenablesItems(&self, autoenables_items: bool)

pub unsafe fn update(&self)

pub unsafe fn performKeyEquivalent(&self, event: &NSEvent) -> bool

pub unsafe fn itemChanged(&self, item: &NSMenuItem)

pub unsafe fn performActionForItemAtIndex(&self, index: NSInteger)

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSMenuDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSMenuDelegate>>, )

pub unsafe fn menuBarHeight(&self) -> CGFloat

pub unsafe fn cancelTracking(&self)

pub unsafe fn cancelTrackingWithoutAnimation(&self)

pub unsafe fn highlightedItem(&self) -> Option<Retained<NSMenuItem>>

pub unsafe fn minimumWidth(&self) -> CGFloat

pub unsafe fn setMinimumWidth(&self, minimum_width: CGFloat)

pub unsafe fn size(&self) -> NSSize

pub unsafe fn font(&self) -> Option<Retained<NSFont>>

pub unsafe fn setFont(&self, font: Option<&NSFont>)

pub unsafe fn allowsContextMenuPlugIns(&self) -> bool

pub unsafe fn setAllowsContextMenuPlugIns( &self, allows_context_menu_plug_ins: bool, )

pub unsafe fn automaticallyInsertsWritingToolsItems(&self) -> bool

pub unsafe fn setAutomaticallyInsertsWritingToolsItems( &self, automatically_inserts_writing_tools_items: bool, )

pub unsafe fn showsStateColumn(&self) -> bool

pub unsafe fn setShowsStateColumn(&self, shows_state_column: bool)

pub unsafe fn userInterfaceLayoutDirection( &self, ) -> NSUserInterfaceLayoutDirection

pub unsafe fn setUserInterfaceLayoutDirection( &self, user_interface_layout_direction: NSUserInterfaceLayoutDirection, )

impl NSMenu

pub fn init(this: Allocated<Self>) -> Retained<Self>

pub fn new(mtm: MainThreadMarker) -> Retained<Self>

impl NSMenu

pub unsafe fn paletteMenuWithColors_titles_selectionHandler( colors: &NSArray<NSColor>, item_titles: &NSArray<NSString>, on_selection_change: Option<&Block<dyn Fn(NonNull<NSMenu>)>>, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn paletteMenuWithColors_titles_templateImage_selectionHandler( colors: &NSArray<NSColor>, item_titles: &NSArray<NSString>, image: &NSImage, on_selection_change: Option<&Block<dyn Fn(NonNull<NSMenu>)>>, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn presentationStyle(&self) -> NSMenuPresentationStyle

pub unsafe fn setPresentationStyle( &self, presentation_style: NSMenuPresentationStyle, )

pub unsafe fn selectionMode(&self) -> NSMenuSelectionMode

pub unsafe fn setSelectionMode(&self, selection_mode: NSMenuSelectionMode)

pub unsafe fn selectedItems(&self) -> Retained<NSArray<NSMenuItem>>

pub unsafe fn setSelectedItems(&self, selected_items: &NSArray<NSMenuItem>)

impl NSMenu

pub unsafe fn submenuAction(&self, sender: Option<&AnyObject>)

impl NSMenu

pub unsafe fn propertiesToUpdate(&self) -> NSMenuProperties

impl NSMenu

pub unsafe fn setMenuRepresentation(&self, menu_rep: Option<&AnyObject>)

pub unsafe fn menuRepresentation(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setContextMenuRepresentation(&self, menu_rep: Option<&AnyObject>)

pub unsafe fn contextMenuRepresentation(&self) -> Option<Retained<AnyObject>>

Struct NSMenu

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

fn retain(&self) -> Retained<Self>
where Self: Sized,

unsafe fn isAccessibilityElement(&self) -> bool
where Self: Sized + Message,

unsafe fn setAccessibilityElement(&self, accessibility_element: bool)
where Self: Sized + Message,

unsafe fn accessibilityFrame(&self) -> NSRect
where Self: Sized + Message,

unsafe fn setAccessibilityFrame(&self, accessibility_frame: NSRect)
where Self: Sized + Message,

unsafe fn isAccessibilityFocused(&self) -> bool
where Self: Sized + Message,

unsafe fn setAccessibilityFocused(&self, accessibility_focused: bool)
where Self: Sized + Message,

unsafe fn accessibilityActivationPoint(&self) -> NSPoint
where Self: Sized + Message,