Struct NSColor 

pub struct NSColor { /* private fields */ }

Available on crate feature NSColor only.

Apple’s documentation

Implementations

impl NSColor

This impl block contains no items.

NSAccessibilityColorConformance.

impl NSColor

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

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

Safety

coder possibly has further requirements.

pub unsafe fn colorWithColorSpace_components_count( space: &NSColorSpace, components: NonNull<CGFloat>, number_of_components: NSInteger, ) -> Retained<NSColor>

Available on crate features NSColorSpace and objc2-core-foundation only.

Safety

components must be a valid pointer.

pub fn colorWithSRGBRed_green_blue_alpha( red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithGenericGamma22White_alpha( white: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithDisplayP3Red_green_blue_alpha( red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithWhite_alpha(white: CGFloat, alpha: CGFloat) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithRed_green_blue_alpha( red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithHue_saturation_brightness_alpha( hue: CGFloat, saturation: CGFloat, brightness: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithColorSpace_hue_saturation_brightness_alpha( space: &NSColorSpace, hue: CGFloat, saturation: CGFloat, brightness: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate features NSColorSpace and objc2-core-foundation only.

pub fn colorWithCatalogName_colorName( list_name: &NSColorListName, color_name: &NSColorName, ) -> Option<Retained<NSColor>>

Available on crate feature NSColorList only.

pub fn colorNamed_bundle( name: &NSColorName, bundle: Option<&NSBundle>, ) -> Option<Retained<NSColor>>

Available on crate feature NSColorList only.

pub fn colorNamed(name: &NSColorName) -> Option<Retained<NSColor>>

Available on crate feature NSColorList only.

pub unsafe fn colorWithName_dynamicProvider( color_name: Option<&NSColorName>, dynamic_provider: &DynBlock<dyn Fn(NonNull<NSAppearance>) -> NonNull<NSColor>>, ) -> Retained<NSColor>

Available on crate features NSAppearance and NSColorList and block2 only.

Safety

dynamic_provider block’s return must be a valid pointer.

pub fn colorWithDeviceWhite_alpha( white: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithDeviceRed_green_blue_alpha( red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithDeviceHue_saturation_brightness_alpha( hue: CGFloat, saturation: CGFloat, brightness: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithDeviceCyan_magenta_yellow_black_alpha( cyan: CGFloat, magenta: CGFloat, yellow: CGFloat, black: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithCalibratedWhite_alpha( white: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithCalibratedRed_green_blue_alpha( red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithCalibratedHue_saturation_brightness_alpha( hue: CGFloat, saturation: CGFloat, brightness: CGFloat, alpha: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn colorWithPatternImage(image: &NSImage) -> Retained<NSColor>

Available on crate feature NSImage only.

pub fn type(&self) -> NSColorType

pub fn colorUsingType(&self, type: NSColorType) -> Option<Retained<NSColor>>

pub fn colorUsingColorSpace( &self, space: &NSColorSpace, ) -> Option<Retained<NSColor>>

Available on crate feature NSColorSpace only.

pub fn colorWithRed_green_blue_alpha_exposure( red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, exposure: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

Generates an HDR color in the extended sRGB colorspace by applying an exposure to the SDR color defined by the red, green, and blue components. The red, green, and blue components have a nominal range of [0..1], exposure is a value >= 0. To produce an HDR color, we process the given color in a linear color space, multiplying component values by 2^exposure. The produced color will have a contentHeadroom equal to the linearized exposure value. Each whole value of exposure produces a color that is twice as bright.

pub fn colorWithRed_green_blue_alpha_linearExposure( red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, linear_exposure: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

Generates an HDR color in the extended sRGB colorspace by applying an exposure to the SDR color defined by the red, green, and blue components. The red, green, and blue components have a nominal range of [0..1], linearExposure is a value >= 1. To produce an HDR color, we process the given color in a linear color space, multiplying component values by linearExposure . The produced color will have a contentHeadroom equal to linearExposure. Each doubling of linearExposure produces a color that is twice as bright.

pub fn colorByApplyingContentHeadroom( &self, content_headroom: CGFloat, ) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

Reinterpret the color by applying a new contentHeadroom without changing the color components. Changing the contentHeadroom redefines the color relative to a different peak white, changing its behavior under tone mapping and the result of calling standardDynamicRangeColor. The new color will have a contentHeadroom >= 1.0. If called on a color with a color space that does not support extended range, or does not have an equivalent extended range counterpart, this will return self.

pub fn standardDynamicRangeColor(&self) -> Retained<NSColor>

In some cases it is useful to recover the color that was base the SDR color that was exposed to generate an HDR color. If a color’s linearExposure is > 1, then this will return the base SDR color. If the color is not an HDR color, this will return self.

pub fn blackColor() -> Retained<NSColor>

pub fn darkGrayColor() -> Retained<NSColor>

pub fn lightGrayColor() -> Retained<NSColor>

pub fn whiteColor() -> Retained<NSColor>

pub fn grayColor() -> Retained<NSColor>

pub fn redColor() -> Retained<NSColor>

pub fn greenColor() -> Retained<NSColor>

pub fn blueColor() -> Retained<NSColor>

pub fn cyanColor() -> Retained<NSColor>

pub fn yellowColor() -> Retained<NSColor>

pub fn magentaColor() -> Retained<NSColor>

pub fn orangeColor() -> Retained<NSColor>

pub fn purpleColor() -> Retained<NSColor>

pub fn brownColor() -> Retained<NSColor>

pub fn clearColor() -> Retained<NSColor>

pub fn labelColor() -> Retained<NSColor>

pub fn secondaryLabelColor() -> Retained<NSColor>

pub fn tertiaryLabelColor() -> Retained<NSColor>

pub fn quaternaryLabelColor() -> Retained<NSColor>

pub fn quinaryLabelColor() -> Retained<NSColor>

pub fn linkColor() -> Retained<NSColor>

Used for large scale images or subtle decorative elements; not for general foreground content.

pub fn placeholderTextColor() -> Retained<NSColor>

pub fn windowFrameTextColor() -> Retained<NSColor>

pub fn selectedMenuItemTextColor() -> Retained<NSColor>

pub fn alternateSelectedControlTextColor() -> Retained<NSColor>

pub fn headerTextColor() -> Retained<NSColor>

pub fn separatorColor() -> Retained<NSColor>

pub fn gridColor() -> Retained<NSColor>

pub fn windowBackgroundColor() -> Retained<NSColor>

pub fn underPageBackgroundColor() -> Retained<NSColor>

pub fn controlBackgroundColor() -> Retained<NSColor>

pub fn selectedContentBackgroundColor() -> Retained<NSColor>

pub fn unemphasizedSelectedContentBackgroundColor() -> Retained<NSColor>

pub fn alternatingContentBackgroundColors() -> Retained<NSArray<NSColor>>

pub fn findHighlightColor() -> Retained<NSColor>

pub fn textColor() -> Retained<NSColor>

pub fn textBackgroundColor() -> Retained<NSColor>

pub fn textInsertionPointColor() -> Retained<NSColor>

pub fn selectedTextColor() -> Retained<NSColor>

pub fn selectedTextBackgroundColor() -> Retained<NSColor>

pub fn unemphasizedSelectedTextBackgroundColor() -> Retained<NSColor>

pub fn unemphasizedSelectedTextColor() -> Retained<NSColor>

pub fn controlColor() -> Retained<NSColor>

pub fn controlTextColor() -> Retained<NSColor>

pub fn selectedControlColor() -> Retained<NSColor>

pub fn selectedControlTextColor() -> Retained<NSColor>

pub fn disabledControlTextColor() -> Retained<NSColor>

pub fn keyboardFocusIndicatorColor() -> Retained<NSColor>

pub fn scrubberTexturedBackgroundColor() -> Retained<NSColor>

pub fn systemRedColor() -> Retained<NSColor>

pub fn systemGreenColor() -> Retained<NSColor>

pub fn systemBlueColor() -> Retained<NSColor>

pub fn systemOrangeColor() -> Retained<NSColor>

pub fn systemYellowColor() -> Retained<NSColor>

pub fn systemBrownColor() -> Retained<NSColor>

pub fn systemPinkColor() -> Retained<NSColor>

pub fn systemPurpleColor() -> Retained<NSColor>

pub fn systemGrayColor() -> Retained<NSColor>

pub fn systemTealColor() -> Retained<NSColor>

pub fn systemIndigoColor() -> Retained<NSColor>

pub fn systemMintColor() -> Retained<NSColor>

pub fn systemCyanColor() -> Retained<NSColor>

pub fn systemFillColor() -> Retained<NSColor>

Fill colors for UI elements. These are meant to be used over the background colors, since their alpha component is less than 1.

systemFillColor is appropriate for filling thin shapes, such as the track of a slider.

pub fn secondarySystemFillColor() -> Retained<NSColor>

secondarySystemFillColor is appropriate for filling small-size shapes, such as the backing of a progress indicator.

pub fn tertiarySystemFillColor() -> Retained<NSColor>

tertiarySystemFillColor is appropriate for filling medium-size shapes, such as the backing of a switch.

pub fn quaternarySystemFillColor() -> Retained<NSColor>

quaternarySystemFillColor is appropriate for filling large areas, such as a group box or tab pane.

pub fn quinarySystemFillColor() -> Retained<NSColor>

quinarySystemFillColor is appropriate for filling large areas that require subtle emphasis, such as content of a form..

pub fn controlAccentColor() -> Retained<NSColor>

A dynamic color that reflects the user’s current preferred accent color. This color automatically updates when the accent color preference changes. Do not make assumptions about the color space of this color, which may change across releases.

pub fn currentControlTint() -> NSControlTint

Available on crate feature NSCell only.

pub fn colorForControlTint(control_tint: NSControlTint) -> Retained<NSColor>

👎Deprecated: NSControlTint does not describe the full range of available control accent colors. Use +[NSColor controlAccentColor] instead.

Available on crate feature NSCell only.

pub fn highlightColor() -> Retained<NSColor>

pub fn shadowColor() -> Retained<NSColor>

pub fn highlightWithLevel(&self, val: CGFloat) -> Option<Retained<NSColor>>

Available on crate feature objc2-core-foundation only.

pub fn shadowWithLevel(&self, val: CGFloat) -> Option<Retained<NSColor>>

Available on crate feature objc2-core-foundation only.

pub fn colorWithSystemEffect( &self, system_effect: NSColorSystemEffect, ) -> Retained<NSColor>

Returns a color representing the base color with a system defined effect applied to it. This color is safe to create before draw time, as the resolution of the final color only happens when being -set, retrieving its CGColor, resolving with -colorWithType:, etc. The return color type is .named.

pub fn set(&self)

pub fn setFill(&self)

pub fn setStroke(&self)

pub fn blendedColorWithFraction_ofColor( &self, fraction: CGFloat, color: &NSColor, ) -> Option<Retained<NSColor>>

Available on crate feature objc2-core-foundation only.

pub fn colorWithAlphaComponent(&self, alpha: CGFloat) -> Retained<NSColor>

Available on crate feature objc2-core-foundation only.

pub fn catalogNameComponent(&self) -> Retained<NSColorListName>

Available on crate feature NSColorList only.

• Methods to get various components of colors. Not all of the methods apply to all colors; if called, they raise. **

pub fn colorNameComponent(&self) -> Retained<NSColorName>

Available on crate feature NSColorList only.

pub fn localizedCatalogNameComponent(&self) -> Retained<NSString>

pub fn localizedColorNameComponent(&self) -> Retained<NSString>

pub fn redComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn greenComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn blueComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn getRed_green_blue_alpha( &self, red: *mut CGFloat, green: *mut CGFloat, blue: *mut CGFloat, alpha: *mut CGFloat, )

Available on crate feature objc2-core-foundation only.

Safety

• red must be a valid pointer or null.
• green must be a valid pointer or null.
• blue must be a valid pointer or null.
• alpha must be a valid pointer or null.

pub fn hueComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn saturationComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn brightnessComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn getHue_saturation_brightness_alpha( &self, hue: *mut CGFloat, saturation: *mut CGFloat, brightness: *mut CGFloat, alpha: *mut CGFloat, )

Available on crate feature objc2-core-foundation only.

Safety

• hue must be a valid pointer or null.
• saturation must be a valid pointer or null.
• brightness must be a valid pointer or null.
• alpha must be a valid pointer or null.

pub fn whiteComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn getWhite_alpha(&self, white: *mut CGFloat, alpha: *mut CGFloat)

Available on crate feature objc2-core-foundation only.

Safety

• white must be a valid pointer or null.
• alpha must be a valid pointer or null.

pub fn cyanComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn magentaComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn yellowComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn blackComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn getCyan_magenta_yellow_black_alpha( &self, cyan: *mut CGFloat, magenta: *mut CGFloat, yellow: *mut CGFloat, black: *mut CGFloat, alpha: *mut CGFloat, )

Available on crate feature objc2-core-foundation only.

Safety

• cyan must be a valid pointer or null.
• magenta must be a valid pointer or null.
• yellow must be a valid pointer or null.
• black must be a valid pointer or null.
• alpha must be a valid pointer or null.

pub fn colorSpace(&self) -> Retained<NSColorSpace>

Available on crate feature NSColorSpace only.

pub fn numberOfComponents(&self) -> NSInteger

pub unsafe fn getComponents(&self, components: NonNull<CGFloat>)

Available on crate feature objc2-core-foundation only.

Safety

components must be a valid pointer.

pub fn patternImage(&self) -> Retained<NSImage>

Available on crate feature NSImage only.

pub fn alphaComponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn linearExposure(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

For HDR colors, the linear brightness multiplier that was applied when generating the color. Colors created with an exposure by NSColor create CGColors that are tagged with a contentHeadroom value. While CGColors created without a contentHeadroom tag will return 0 from CGColorGetHeadroom, NSColors generated in a similar fashion return a linearExposure of 1.0.

pub fn colorFromPasteboard( paste_board: &NSPasteboard, ) -> Option<Retained<NSColor>>

Available on crate feature NSPasteboard only.

pub fn writeToPasteboard(&self, paste_board: &NSPasteboard)

Available on crate feature NSPasteboard only.

pub fn drawSwatchInRect(&self, rect: NSRect)

pub fn ignoresAlpha(mtm: MainThreadMarker) -> bool

👎Deprecated: Use showsAlpha in NSColorPanel and supportsAlpha in NSColorWell to control alpha behavior for individual controls.

pub fn setIgnoresAlpha(ignores_alpha: bool, mtm: MainThreadMarker)

👎Deprecated: Use showsAlpha in NSColorPanel and supportsAlpha in NSColorWell to control alpha behavior for individual controls.

Setter for ignoresAlpha.

impl NSColor

Methods declared on superclass NSObject.

pub fn new() -> Retained<Self>

impl NSColor

NSDeprecated.

pub fn controlHighlightColor() -> Retained<NSColor>

👎Deprecated: Use a color that matches the semantics being used, such as separatorColor

Historically used as the inner border highlight color for beveled buttons. No longer used.

pub fn controlLightHighlightColor() -> Retained<NSColor>

👎Deprecated: Use a color that matches the semantics being used, such as separatorColor

Historically used as the outer border highlight color for beveled buttons. No longer used.

pub fn controlShadowColor() -> Retained<NSColor>

👎Deprecated: Use a color that matches the semantics being used, such as separatorColor

Historically used as the inner border shadow color for beveled buttons. No longer used.

pub fn controlDarkShadowColor() -> Retained<NSColor>

👎Deprecated: Use a color that matches the semantics being used, such as separatorColor

Historically used as the outer border shadow color for beveled buttons. No longer used.

pub fn scrollBarColor() -> Retained<NSColor>

👎Deprecated: Use NSScroller instead

Historically used as the color of scroll bars. No longer used.

pub fn knobColor() -> Retained<NSColor>

👎Deprecated: Use NSScroller instead

Historically used as the color of scroll bar knobs. No longer used.

pub fn selectedKnobColor() -> Retained<NSColor>

👎Deprecated: Use NSScroller instead

Historically used as the color of scroll bar knobs being dragged. No longer used.

pub fn windowFrameColor() -> Retained<NSColor>

👎Deprecated: Use NSVisualEffectMaterialTitlebar

Historically used as the color of the window chrome, which is no longer able to be represented by a color. No longer used.

pub fn selectedMenuItemColor() -> Retained<NSColor>

👎Deprecated: Use NSVisualEffectMaterialSelection

Historically used as the color of selected menu items, which is no longer a color but a tinted blur effect. No longer used.

pub fn headerColor() -> Retained<NSColor>

👎Deprecated: Use NSVisualEffectMaterialHeaderView

Historically used as the color of table headers, which is no longer a color but a tinted blur effect.

pub fn secondarySelectedControlColor() -> Retained<NSColor>

👎Deprecated

The background color of selected content or text that is unemphasized. Older alias for +unemphasizedSelectedContentBackgroundColor and +unemphasizedSelectedTextBackgroundColor

pub fn alternateSelectedControlColor() -> Retained<NSColor>

👎Deprecated

The background color of selected and emphasized (focused) content: table views rows, collection views, etc. Older alias for +selectedContentBackgroundColor

pub fn controlAlternatingRowBackgroundColors() -> Retained<NSArray<NSColor>>

👎Deprecated

The background colors for alternating content items: such as table view rows, collection view items. Older alias for +alternatingContentBackgroundColors

pub fn colorSpaceName(&self) -> Retained<NSColorSpaceName>

👎Deprecated: Use -type and NSColorType instead

Available on crate feature NSGraphics only.

pub unsafe fn colorUsingColorSpaceName_device( &self, name: Option<&NSColorSpaceName>, device_description: Option<&NSDictionary<NSDeviceDescriptionKey, AnyObject>>, ) -> Option<Retained<NSColor>>

👎Deprecated: Use -colorUsingType: or -colorUsingColorSpace: instead

Available on crate feature NSGraphics only.

Safety

device_description generic should be of the correct type.

pub fn colorUsingColorSpaceName( &self, name: &NSColorSpaceName, ) -> Option<Retained<NSColor>>

👎Deprecated: Use -colorUsingType: or -colorUsingColorSpace: instead

Available on crate feature NSGraphics only.

impl NSColor

This impl block contains no items.

NSQuartzCoreAdditions.

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 NSColor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSColor> for NSColor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSColor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSColor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSColor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSColor

const NAME: &'static str = "NSColor"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSColor 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 CopyingHelper for NSColor

type Result = NSColor

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NSColor

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

Formats the value using the given formatter.

impl DefaultRetained for NSColor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSColor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSColor

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 NSColor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSAccessibilityColor for NSColor

Available on crate feature NSAccessibilityColor only.

fn accessibilityName(&self) -> Retained<NSString>

where Self: Sized + Message,

Returns a localized description of the color for use in accessibility attributes.

impl NSCoding for NSColor

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSCopying for NSColor

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSColor

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 NSPasteboardReading for NSColor

fn readableTypesForPasteboard( pasteboard: &NSPasteboard, ) -> Retained<NSArray<NSPasteboardType>>

where Self: Sized + ClassType,

Available on crate feature NSPasteboard only.

fn readingOptionsForType_pasteboard( type: &NSPasteboardType, pasteboard: &NSPasteboard, ) -> NSPasteboardReadingOptions

where Self: Sized + ClassType,

Available on crate feature NSPasteboard only.

unsafe fn initWithPasteboardPropertyList_ofType( this: Allocated<Self>, property_list: &AnyObject, type: &NSPasteboardType, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate feature NSPasteboard only.

Safety

impl NSPasteboardWriting for NSColor

fn writableTypesForPasteboard( &self, pasteboard: &NSPasteboard, ) -> Retained<NSArray<NSPasteboardType>>

where Self: Sized + Message,

Available on crate feature NSPasteboard only.

fn writingOptionsForType_pasteboard( &self, type: &NSPasteboardType, pasteboard: &NSPasteboard, ) -> NSPasteboardWritingOptions

where Self: Sized + Message,

Available on crate feature NSPasteboard only.

fn pasteboardPropertyListForType( &self, type: &NSPasteboardType, ) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

Available on crate feature NSPasteboard only.

impl NSSecureCoding for NSColor

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSColor

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 NSColor

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

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

impl DowncastTarget for NSColor

impl Eq for NSColor

impl Send for NSColor

impl Sync for NSColor