Struct NSSplitViewItem

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

Available on crate feature NSSplitViewItem only.

NSSplitViewItem implements the items used in an NSSplitViewController. The item describes a child ViewController’s state in a SplitViewController, e.g. its collapsibility, holding priority and other metrics, and collapsed state.

See also Apple’s documentation

Implementations

impl NSSplitViewItem

pub unsafe fn splitViewItemWithViewController( view_controller: &NSViewController, ) -> Retained<Self>

Available on crate features NSResponder and NSViewController only.

Creates an autoreleased SplitViewItem that represents the provided ViewController. All other properties are left at their default.

Parameter viewController: The view controller used to set the viewController property

Returns: An autoreleased SplitViewItem.

pub unsafe fn sidebarWithViewController( view_controller: &NSViewController, ) -> Retained<Self>

Available on crate features NSResponder and NSViewController only.

Creates a split view item representing a sidebar for the provided ViewController. Sidebars have standard system behavior, specifically:

• Translucent material background
• The ability to collapse/uncollapse on split view size changes
• The ability to overlay at small split view sizes when in fullscreen
• canCollapse is set to YES
• minimumThickness and maximumThickness are set to the standard minimum and maximum sidebar size
• preferredThicknessFraction is set to the standard fraction for sidebars (0.15)
• springLoaded is set to YES

Parameter viewController: The view controller used to set the viewController property

Returns: An autoreleased SplitViewItem that acts as a sidebar.

pub unsafe fn contentListWithViewController( view_controller: &NSViewController, ) -> Retained<Self>

Available on crate features NSResponder and NSViewController only.

Creates a split view item representing a content list for the provided ViewController, akin to Mail’s message list, Note’s note list. Content lists have system standard defaults, specifically:

• minimumThickness and maximumThickness are set to the system standard for content lists
• automaticMaximumThickness is set to the system standard for content lists
• preferredThicknessFraction is set to the standard fraction for content lists (0.28 when a neighbor sidebar is visible, 0.33 if not)

Parameter viewController: The view controller used to set the viewController property

Returns: An autoreleased SplitViewItem that acts as a content list.

pub unsafe fn inspectorWithViewController( view_controller: &NSViewController, ) -> Retained<Self>

Available on crate features NSResponder and NSViewController only.

Creates a split view item representing an inspector for the provided ViewController. On macOS 14.0 and above inspectors have the following standard system behavior:

• canCollapse is set to YES
• minimumThickness and maximumThickness are set to the standard inspector size (270) and are not resizable by default

Parameter viewController: The view controller used to set the viewController property

Returns: An autoreleased SplitViewItem that acts as an inspector.

pub unsafe fn behavior(&self) -> NSSplitViewItemBehavior

The standard behavior type of the receiver. See initializers for descriptions of each behavior.

pub unsafe fn viewController( &self, mtm: MainThreadMarker, ) -> Retained<NSViewController>

Available on crate features NSResponder and NSViewController only.

The view controller represented by the SplitViewItem. An exception will be thrown if a new viewController is set while the receiving SplitViewItem is added to a SplitViewController.

pub unsafe fn setViewController(&self, view_controller: &NSViewController)

Available on crate features NSResponder and NSViewController only.

Setter for viewController.

pub unsafe fn isCollapsed(&self) -> bool

Whether or not the child ViewController corresponding to the SplitViewItem is collapsed in the SplitViewController. The default is NO.This can be set with the animator proxy to animate the collapse or uncollapse. The exact animation used can be customized by setting it in the -animations dictionary with a key of “collapsed”. If this is set to YES before it is added to the SplitViewController, it will be initially collapsed and the SplitViewController will not cause the view to be loaded until it is uncollapsed. This is KVC/KVO compliant and will be updated if the value changes from user interaction.

pub unsafe fn setCollapsed(&self, collapsed: bool)

Setter for isCollapsed.

pub unsafe fn canCollapse(&self) -> bool

Whether or not the child view controller is collapsible from user interaction - whether by dragging or double clicking a divider. The default is NO.

pub unsafe fn setCanCollapse(&self, can_collapse: bool)

Setter for canCollapse.

pub unsafe fn collapseBehavior(&self) -> NSSplitViewItemCollapseBehavior

The resize behavior when the receiver toggles its collapsed state programmatically, both animatedly and not. Defaults to .Default.

pub unsafe fn setCollapseBehavior( &self, collapse_behavior: NSSplitViewItemCollapseBehavior, )

Setter for collapseBehavior.

pub unsafe fn minimumThickness(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

A convenience to set the minimum thickness of the split view item – width for “vertical” split views, height otherwise. If NSSplitViewItemUnspecifiedDimension, no minimum size is enforced by the SplitViewItem, although constraints in the contained view hierarchy might have constraints specify some minimum size on their own. Defaults to NSSplitViewItemUnspecifiedDimension.

pub unsafe fn setMinimumThickness(&self, minimum_thickness: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumThickness.

pub unsafe fn maximumThickness(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

A convenience to set the maximum thickness of the split view item – width for “vertical” split views, height otherwise. If NSSplitViewItemUnspecifiedDimension, no maximum size is enforced by the SplitViewItem, although constraints in the contained view hierarchy might have constraints specify some maximum size on their own. Defaults to NSSplitViewItemUnspecifiedDimension.

pub unsafe fn setMaximumThickness(&self, maximum_thickness: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for maximumThickness.

pub unsafe fn preferredThicknessFraction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The percentage of the contained NSSplitView that the NSSplitViewItem prefers to encompass. This is used when double-clicking on a neighbor divider to return to that standard ratio. As well as after entering fullscreen to determine the initial size of the receiver. Defaults to NSSplitViewItemUnspecifiedDimension, which means no resize will occur on double-clicks, and the absolute size is preserved when entering fullscreen.

pub unsafe fn setPreferredThicknessFraction( &self, preferred_thickness_fraction: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredThicknessFraction.

pub unsafe fn holdingPriority(&self) -> NSLayoutPriority

Available on crate feature NSLayoutConstraint only.

Sets the priority under which a SplitViewItem will hold its width (for a vertical split view) or height (for a horizontal split view). The view with the lowest priority will be the first to take on additional width if the split view grows or shrinks. The default is NSLayoutPriorityDefaultLow.

pub unsafe fn setHoldingPriority(&self, holding_priority: NSLayoutPriority)

Available on crate feature NSLayoutConstraint only.

Setter for holdingPriority.

pub unsafe fn automaticMaximumThickness(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The maximum thickness of the split view item when resizing due to automatic sizing, such as entering fullscreen with a set preferredThicknessFraction or proportional sizing. The user can still resize up to the absolute maximum size by dragging the divider or otherwise. If NSSplitViewItemUnspecifiedDimension, no automatic maximum is enforced. Defaults to NSSplitViewItemUnspecifiedDimension.

pub unsafe fn setAutomaticMaximumThickness( &self, automatic_maximum_thickness: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for automaticMaximumThickness.

pub unsafe fn isSpringLoaded(&self) -> bool

If YES, the split view item can be temporarily uncollapsed during a drag by hovering or deep clicking on its neighboring divider. Defaults to NO.

pub unsafe fn setSpringLoaded(&self, spring_loaded: bool)

Setter for isSpringLoaded.

pub unsafe fn canCollapseFromWindowResize(&self) -> bool

If YES, the item can be collapsed from a window resize. This can differ from canCollapse, to allow divider collapsing but not window resize collapsing or vice versa. Defaults to YES for Sidebars and NO for Inspectors.

• Note: Setting canCollapse for sidebars will reset this value to that new value.

pub unsafe fn setCanCollapseFromWindowResize( &self, can_collapse_from_window_resize: bool, )

Setter for canCollapseFromWindowResize.

pub unsafe fn allowsFullHeightLayout(&self) -> bool

Whether or not a sidebar or inspector is allowed to be full height in the window when the NSFullSizeContentViewWindowMask style mask is also set. Only applies to NSSplitViewItemBehaviorSidebar and NSSplitViewItemBehaviorInspector. Defaults to YES.

pub unsafe fn setAllowsFullHeightLayout(&self, allows_full_height_layout: bool)

Setter for allowsFullHeightLayout.

pub unsafe fn titlebarSeparatorStyle(&self) -> NSTitlebarSeparatorStyle

Available on crate feature NSWindow only.

Specifies a preference for the style of separator displayed between the titlebar and the content of the split view item.

For this value to be applicable, the item’s view must be associated with its own titlebar section (see NSTrackingSeparatorToolbarItem for more info). The default value is NSTitlebarSeparatorStyleAutomatic. This value is subject to the containing window’s preference and can be overridden.

pub unsafe fn setTitlebarSeparatorStyle( &self, titlebar_separator_style: NSTitlebarSeparatorStyle, )

Available on crate feature NSWindow only.

Setter for titlebarSeparatorStyle.

impl NSSplitViewItem

Methods declared on superclass NSObject.

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

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Available on crate feature NSAccessibilityConstants only.

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

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.

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`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NSSplitViewItem

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for NSSplitViewItem

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSSplitViewItem> for NSSplitViewItem

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for NSSplitViewItem

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSSplitViewItem

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSSplitViewItem

const NAME: &'static str = "NSSplitViewItem"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSSplitViewItem as ClassType>::Super as ClassType>::ThreadKind

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

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for NSSplitViewItem

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

Formats the value using the given formatter.

impl Deref for NSSplitViewItem

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for NSSplitViewItem

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for NSSplitViewItem

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSAnimatablePropertyContainer for NSSplitViewItem

unsafe fn animator(&self) -> Retained<Self>

where Self: Sized + Message,

Available on crate feature NSAnimation only.

unsafe fn animations( &self, ) -> Retained<NSDictionary<NSAnimatablePropertyKey, AnyObject>>

where Self: Sized + Message,

Available on crate feature NSAnimation only.

unsafe fn setAnimations( &self, animations: &NSDictionary<NSAnimatablePropertyKey, AnyObject>, )

where Self: Sized + Message,

Available on crate feature NSAnimation only.

Setter for animations.

unsafe fn animationForKey( &self, key: &NSAnimatablePropertyKey, ) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

Available on crate feature NSAnimation only.

unsafe fn defaultAnimationForKey( key: &NSAnimatablePropertyKey, ) -> Option<Retained<AnyObject>>

where Self: Sized + ClassType,

Available on crate feature NSAnimation only.

impl NSCoding for NSSplitViewItem

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for NSSplitViewItem

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

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

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

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

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for NSSplitViewItem

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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

impl RefEncode for NSSplitViewItem

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

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

impl DowncastTarget for NSSplitViewItem

impl Eq for NSSplitViewItem