Struct UIColor

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

Available on crate feature UIColor only.

Apple’s documentation

Implementations

impl UIColor

UIAccessibility.

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

Available on crate feature UIAccessibilityAdditions only.

impl UIColor

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

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

pub unsafe fn colorWithDisplayP3Red_green_blue_alpha( display_p3_red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<UIColor>

Available on crate feature objc2-core-foundation only.

pub unsafe fn colorWithCGColor(cg_color: &CGColor) -> Retained<UIColor>

Available on crate feature objc2-core-graphics only.

pub unsafe fn colorWithPatternImage(image: &UIImage) -> Retained<UIColor>

Available on crate feature UIImage only.

pub unsafe fn colorWithCIColor(ci_color: &CIColor) -> Retained<UIColor>

Available on crate feature objc2-core-image and non-watchOS only.

pub unsafe fn initWithWhite_alpha( this: Allocated<Self>, white: CGFloat, alpha: CGFloat, ) -> Retained<UIColor>

Available on crate feature objc2-core-foundation only.

pub unsafe fn initWithHue_saturation_brightness_alpha( this: Allocated<Self>, hue: CGFloat, saturation: CGFloat, brightness: CGFloat, alpha: CGFloat, ) -> Retained<UIColor>

Available on crate feature objc2-core-foundation only.

pub unsafe fn initWithRed_green_blue_alpha( this: Allocated<Self>, red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<UIColor>

Available on crate feature objc2-core-foundation only.

pub unsafe fn initWithDisplayP3Red_green_blue_alpha( this: Allocated<Self>, display_p3_red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat, ) -> Retained<UIColor>

Available on crate feature objc2-core-foundation only.

pub unsafe fn initWithCGColor( this: Allocated<Self>, cg_color: &CGColor, ) -> Retained<UIColor>

Available on crate feature objc2-core-graphics only.

pub unsafe fn initWithPatternImage( this: Allocated<Self>, image: &UIImage, ) -> Retained<UIColor>

Available on crate feature UIImage only.

pub unsafe fn initWithCIColor( this: Allocated<Self>, ci_color: &CIColor, ) -> Retained<UIColor>

Available on crate feature objc2-core-image and non-watchOS only.

pub unsafe fn blackColor() -> Retained<UIColor>

pub unsafe fn darkGrayColor() -> Retained<UIColor>

pub unsafe fn lightGrayColor() -> Retained<UIColor>

pub unsafe fn whiteColor() -> Retained<UIColor>

pub unsafe fn grayColor() -> Retained<UIColor>

pub unsafe fn redColor() -> Retained<UIColor>

pub unsafe fn greenColor() -> Retained<UIColor>

pub unsafe fn blueColor() -> Retained<UIColor>

pub unsafe fn cyanColor() -> Retained<UIColor>

pub unsafe fn yellowColor() -> Retained<UIColor>

pub unsafe fn magentaColor() -> Retained<UIColor>

pub unsafe fn orangeColor() -> Retained<UIColor>

pub unsafe fn purpleColor() -> Retained<UIColor>

pub unsafe fn brownColor() -> Retained<UIColor>

pub unsafe fn clearColor() -> Retained<UIColor>

pub unsafe fn set(&self)

pub unsafe fn setFill(&self)

pub unsafe fn setStroke(&self)

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

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, ) -> bool

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, ) -> bool

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

pub unsafe fn CGColor(&self) -> Retained<CGColor>

Available on crate feature objc2-core-graphics only.

pub unsafe fn CIColor(&self) -> Retained<CIColor>

Available on crate feature objc2-core-image and non-watchOS only.

impl UIColor

Methods declared on superclass NSObject.

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

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

impl UIColor

UINSItemProvider.

This impl block contains no items.

impl UIColor

UIColorNamedColors.

pub unsafe fn colorNamed(name: &NSString) -> Option<Retained<UIColor>>

pub unsafe fn colorNamed_inBundle_compatibleWithTraitCollection( name: &NSString, bundle: Option<&NSBundle>, trait_collection: Option<&UITraitCollection>, ) -> Option<Retained<UIColor>>

Available on crate feature UITraitCollection only.

impl UIColor

DynamicColors.

pub unsafe fn colorWithDynamicProvider( dynamic_provider: &Block<dyn Fn(NonNull<UITraitCollection>) -> NonNull<UIColor>>, ) -> Retained<UIColor>

Available on crate features UITraitCollection and block2 only.

pub unsafe fn initWithDynamicProvider( this: Allocated<Self>, dynamic_provider: &Block<dyn Fn(NonNull<UITraitCollection>) -> NonNull<UIColor>>, ) -> Retained<UIColor>

Available on crate features UITraitCollection and block2 only.

pub unsafe fn resolvedColorWithTraitCollection( &self, trait_collection: &UITraitCollection, ) -> Retained<UIColor>

Available on crate feature UITraitCollection only.

impl UIColor

ProminenceSupport.

pub unsafe fn colorWithProminence( &self, prominence: UIColorProminence, ) -> Retained<UIColor>

pub unsafe fn prominence(&self) -> UIColorProminence

impl UIColor

UIColorSystemColors.

pub unsafe fn systemRedColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGreenColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemBlueColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemOrangeColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemYellowColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemPinkColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemPurpleColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemTealColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemIndigoColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemBrownColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemMintColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemCyanColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGrayColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGray2Color() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGray3Color() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGray4Color() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGray5Color() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGray6Color() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn tintColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn labelColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn secondaryLabelColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn tertiaryLabelColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn quaternaryLabelColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn linkColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn placeholderTextColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn separatorColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn opaqueSeparatorColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemBackgroundColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn secondarySystemBackgroundColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn tertiarySystemBackgroundColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemGroupedBackgroundColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn secondarySystemGroupedBackgroundColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn tertiarySystemGroupedBackgroundColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn systemFillColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn secondarySystemFillColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn tertiarySystemFillColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn quaternarySystemFillColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn lightTextColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn darkTextColor() -> Retained<UIColor>

Available on crate feature UIInterface only.

pub unsafe fn groupTableViewBackgroundColor() -> Retained<UIColor>

👎Deprecated

Available on crate feature UIInterface only.

pub unsafe fn viewFlipsideBackgroundColor() -> Retained<UIColor>

👎Deprecated

Available on crate feature UIInterface only.

pub unsafe fn scrollViewTexturedBackgroundColor() -> Retained<UIColor>

👎Deprecated

Available on crate feature UIInterface only.

pub unsafe fn underPageBackgroundColor() -> Retained<UIColor>

👎Deprecated

Available on crate feature UIInterface only.

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 UIIndirectScribbleInteraction only.

Dynamically find the class of this object.

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 UIIndirectScribbleInteraction 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 UIIndirectScribbleInteraction 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 UIColor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIColor

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIColor> for UIColor

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIColor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIColor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIColor

const NAME: &'static str = "UIColor"

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

type Super = NSObject

The superclass of this class.

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

type Result = UIColor

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

impl Debug for UIColor

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

Formats the value using the given formatter.

impl Deref for UIColor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIColor

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 UIColor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIColor

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for UIColor

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 NSItemProviderReading for UIColor

unsafe fn readableTypeIdentifiersForItemProvider() -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

Available on crate features NSArray and NSString only.

unsafe fn objectWithItemProviderData_typeIdentifier_error( data: &NSData, type_identifier: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

where Self: Sized + ClassType,

Available on crate features NSData and NSError and NSString only.

impl NSItemProviderWriting for UIColor

unsafe fn writableTypeIdentifiersForItemProvider_class() -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

Available on crate features NSArray and NSString only.

unsafe fn writableTypeIdentifiersForItemProvider( &self, ) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

Available on crate features NSArray and NSString only.

unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier_class( type_identifier: &NSString, ) -> NSItemProviderRepresentationVisibility

where Self: Sized + ClassType,

Available on crate feature NSString only.

unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier( &self, type_identifier: &NSString, ) -> NSItemProviderRepresentationVisibility

where Self: Sized + Message,

Available on crate feature NSString only.

impl NSObjectProtocol for UIColor

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 NSSecureCoding for UIColor

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UIColor

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 UIColor

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

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

impl DowncastTarget for UIColor

impl Eq for UIColor

impl Send for UIColor

impl Sync for UIColor