Struct NSScrubberFlowLayout

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

Available on crate feature NSScrubberLayout only.

NSScrubberFlowLayoutis a concrete layout object that arranges items end-to-end in a linear strip. It supports a fixed inter-item spacing and both fixed- and variable-sized items.

If the associated scrubber’s delegateconforms to NSScrubberFlowLayoutDelegate,and it implements the scrubber:layout:sizeForItemAtIndex:method, NSScrubberFlowLayoutwill obtain the item size from the delegate. If the delegate does not implement that method, or if the method returns NSZeroSize,it will fall back to using the layout’s itemSizeproperty. By default, NSScrubberFlowLayout does not invalidate its layout on selection change, highlight change, or visible rectangle change.

See also Apple’s documentation

Implementations

impl NSScrubberFlowLayout

pub unsafe fn itemSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The amount of horizontal spacing between items in points. The default value is 0.0.

pub unsafe fn setItemSpacing(&self, item_spacing: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for itemSpacing.

pub unsafe fn itemSize(&self) -> NSSize

The frame size for each item, if not provided by the scrubber’s delegate. The default value is { 50.0, 30.0 }.

pub unsafe fn setItemSize(&self, item_size: NSSize)

Setter for itemSize.

pub unsafe fn invalidateLayoutForItemsAtIndexes( &self, invalid_item_indexes: &NSIndexSet, )

impl NSScrubberFlowLayout

Methods declared on superclass NSScrubberLayout.

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

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

impl NSScrubberFlowLayout

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSScrubberLayout>

pub unsafe fn scrubber(&self) -> Option<Retained<NSScrubber>>

Available on crate features NSResponder and NSScrubber and NSView only.

The NSScrubber control that this layout is assigned to, or nilif the receiver is not assigned to a scrubber.

pub unsafe fn visibleRect(&self) -> NSRect

The currently visible rectangle, in the coordinate space of the scrubber content. Returns NSZeroRectif the receiver is not assigned to a scrubber.

pub unsafe fn invalidateLayout(&self)

Signals that layout has been invalidated and the NSScrubber should run a fresh layout pass. Subclasses may define more granular invalidation methods suitable for their own data structures, but those methods should always call up to -invalidateLayout.

pub unsafe fn prepareLayout(&self)

Following any invalidation in layout, NSScrubberwill call prepareLayouton its layout object prior to requesting any other layout information. Subclasses should use this method to perform upfront calculations and caching. The base implementation of this method does nothing.

pub unsafe fn scrubberContentSize(&self) -> NSSize

Returns the content size for all elements within the scrubber. The base implementation returns NSZeroSize.

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

Returns the layout attributes for a single item within the scrubber. The base implementation returns nil.

pub unsafe fn layoutAttributesForItemsInRect( &self, rect: NSRect, ) -> Retained<NSSet<NSScrubberLayoutAttributes>>

Returns the set of layout attributes for all items within the provided rectangle. The base implementation returns an empty set.

pub unsafe fn shouldInvalidateLayoutForSelectionChange(&self) -> bool

If YES,the scrubber will invalidate its layout when the selection changes. The default value is NO.Subclasses should return YESif the selection index affects the item layout.

pub unsafe fn shouldInvalidateLayoutForHighlightChange(&self) -> bool

If YES,the scrubber will invalidate its layout when an item is highlighted. The default value is NO.Subclasses should return YESif the highlight state affects the item layout.

pub unsafe fn shouldInvalidateLayoutForChangeFromVisibleRect_toVisibleRect( &self, from_visible_rect: NSRect, to_visible_rect: NSRect, ) -> bool

If YES,the scrubber will invalidate its layout in response to a change in the visible region. The default value is NO.Subclasses which rely on the size or origin of the visible region should return YES.

pub unsafe fn automaticallyMirrorsInRightToLeftLayout(&self) -> bool

If YES,the layout object will automatically have its inputs and outputs mirrored in right-to-left interfaces. The default value is YES.Subclasses that wish to handle RTL layout manually should return NO.

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 NSScrubberFlowLayout

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSScrubberFlowLayout

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSScrubberFlowLayout> for NSScrubberFlowLayout

fn as_ref(&self) -> &Self

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

impl AsRef<NSScrubberLayout> for NSScrubberFlowLayout

fn as_ref(&self) -> &NSScrubberLayout

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

impl Borrow<AnyObject> for NSScrubberFlowLayout

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSScrubberFlowLayout

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSScrubberLayout> for NSScrubberFlowLayout

fn borrow(&self) -> &NSScrubberLayout

Immutably borrows from an owned value.

impl ClassType for NSScrubberFlowLayout

const NAME: &'static str = "NSScrubberFlowLayout"

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

type Super = NSScrubberLayout

The superclass of this class.

type ThreadKind = <<NSScrubberFlowLayout 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 NSScrubberFlowLayout

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

Formats the value using the given formatter.

impl Deref for NSScrubberFlowLayout

type Target = NSScrubberLayout

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSScrubberFlowLayout

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 NSScrubberFlowLayout

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSScrubberFlowLayout

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 NSScrubberFlowLayout

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 NSScrubberFlowLayout

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 NSScrubberFlowLayout

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

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

impl DowncastTarget for NSScrubberFlowLayout

impl Eq for NSScrubberFlowLayout