Struct UIButtonConfiguration

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

Available on crate feature UIButtonConfiguration only.

Apple’s documentation

Implementations

impl UIButtonConfiguration

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

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

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

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

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

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

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

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

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

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

pub unsafe fn updatedConfigurationForButton( &self, button: &UIButton, ) -> Retained<Self>

Available on crate features UIButton and UIControl and UIResponder and UIView only.

Returns a copy of the configuration updated based on the given button, by applying the configuration’s default values for that button’s state to any properties that have not been customized.

pub unsafe fn background(&self) -> Retained<UIBackgroundConfiguration>

Available on crate feature UIBackgroundConfiguration only.

A UIBackgroundConfiguration describing the button’s background. UIKit provides a value by default with values appropriate for a UIButton.

pub unsafe fn setBackground(&self, background: &UIBackgroundConfiguration)

Available on crate feature UIBackgroundConfiguration only.

Setter for background.

pub unsafe fn cornerStyle(&self) -> UIButtonConfigurationCornerStyle

The corner style controls how background.cornerRadius is interpreted by the button. Defaults to Dynamic.

pub unsafe fn setCornerStyle( &self, corner_style: UIButtonConfigurationCornerStyle, )

Setter for cornerStyle.

pub unsafe fn buttonSize(&self) -> UIButtonConfigurationSize

Determines the metrics and ideal size of the button. Clients may resize the button arbitrarily regardless of this value.

pub unsafe fn setButtonSize(&self, button_size: UIButtonConfigurationSize)

Setter for buttonSize.

pub unsafe fn macIdiomStyle(&self) -> UIButtonConfigurationMacIdiomStyle

pub unsafe fn setMacIdiomStyle( &self, mac_idiom_style: UIButtonConfigurationMacIdiomStyle, )

Setter for macIdiomStyle.

pub unsafe fn baseForegroundColor(&self) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

The base color to use for foreground elements. This color may be modified before being passed to a transformer, and finally applied to specific elements. Setting nil will cede full control to the configuration to select a color appropriate to the style.

pub unsafe fn setBaseForegroundColor( &self, base_foreground_color: Option<&UIColor>, )

Available on crate feature UIColor only.

Setter for baseForegroundColor.

pub unsafe fn baseBackgroundColor(&self) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

The base color to use for background elements. This color may be modified before being passed to a transformer, and finally applied to specific elements. Setting nil will cede full control to the configuration to select a color appropriate to the style.

pub unsafe fn setBaseBackgroundColor( &self, base_background_color: Option<&UIColor>, )

Available on crate feature UIColor only.

Setter for baseBackgroundColor.

pub unsafe fn image(&self) -> Option<Retained<UIImage>>

Available on crate feature UIImage only.

pub unsafe fn setImage(&self, image: Option<&UIImage>)

Available on crate feature UIImage only.

Setter for image.

pub unsafe fn imageColorTransformer(&self) -> UIConfigurationColorTransformer

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

pub unsafe fn setImageColorTransformer( &self, image_color_transformer: UIConfigurationColorTransformer, )

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for imageColorTransformer.

pub unsafe fn preferredSymbolConfigurationForImage( &self, ) -> Option<Retained<UIImageSymbolConfiguration>>

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

pub unsafe fn setPreferredSymbolConfigurationForImage( &self, preferred_symbol_configuration_for_image: Option<&UIImageSymbolConfiguration>, )

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

Setter for preferredSymbolConfigurationForImage.

pub unsafe fn showsActivityIndicator(&self) -> bool

Shows an activity indicator in place of an image. Its placement is controlled by the imagePlacement property.

pub unsafe fn setShowsActivityIndicator(&self, shows_activity_indicator: bool)

Setter for showsActivityIndicator.

pub unsafe fn activityIndicatorColorTransformer( &self, ) -> UIConfigurationColorTransformer

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

pub unsafe fn setActivityIndicatorColorTransformer( &self, activity_indicator_color_transformer: UIConfigurationColorTransformer, )

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for activityIndicatorColorTransformer.

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

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

Setter for title.

pub unsafe fn attributedTitle(&self) -> Option<Retained<NSAttributedString>>

pub unsafe fn setAttributedTitle( &self, attributed_title: Option<&NSAttributedString>, )

Setter for attributedTitle.

pub unsafe fn titleTextAttributesTransformer( &self, ) -> UIConfigurationTextAttributesTransformer

Available on crate feature block2 only.

pub unsafe fn setTitleTextAttributesTransformer( &self, title_text_attributes_transformer: UIConfigurationTextAttributesTransformer, )

Available on crate feature block2 only.

Setter for titleTextAttributesTransformer.

pub unsafe fn titleLineBreakMode(&self) -> NSLineBreakMode

Available on crate feature NSParagraphStyle only.

Default is WordWrapping. WordWrapping and CharWrapping both allow for multi-line text, other modes will restrict the title to a single line of text.

pub unsafe fn setTitleLineBreakMode( &self, title_line_break_mode: NSLineBreakMode, )

Available on crate feature NSParagraphStyle only.

Setter for titleLineBreakMode.

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

pub unsafe fn setSubtitle(&self, subtitle: Option<&NSString>)

Setter for subtitle.

pub unsafe fn attributedSubtitle(&self) -> Option<Retained<NSAttributedString>>

pub unsafe fn setAttributedSubtitle( &self, attributed_subtitle: Option<&NSAttributedString>, )

Setter for attributedSubtitle.

pub unsafe fn subtitleTextAttributesTransformer( &self, ) -> UIConfigurationTextAttributesTransformer

Available on crate feature block2 only.

pub unsafe fn setSubtitleTextAttributesTransformer( &self, subtitle_text_attributes_transformer: UIConfigurationTextAttributesTransformer, )

Available on crate feature block2 only.

Setter for subtitleTextAttributesTransformer.

pub unsafe fn subtitleLineBreakMode(&self) -> NSLineBreakMode

Available on crate feature NSParagraphStyle only.

Default is WordWrapping. WordWrapping and CharWrapping both allow for multi-line text, other modes will restrict the subtitle to a single line of text.

pub unsafe fn setSubtitleLineBreakMode( &self, subtitle_line_break_mode: NSLineBreakMode, )

Available on crate feature NSParagraphStyle only.

Setter for subtitleLineBreakMode.

pub unsafe fn indicator(&self) -> UIButtonConfigurationIndicator

What kind of indicator should the button show. Default value is .automatic.

pub unsafe fn setIndicator(&self, indicator: UIButtonConfigurationIndicator)

Setter for indicator.

pub unsafe fn indicatorColorTransformer( &self, ) -> UIConfigurationColorTransformer

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

pub unsafe fn setIndicatorColorTransformer( &self, indicator_color_transformer: UIConfigurationColorTransformer, )

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for indicatorColorTransformer.

pub unsafe fn contentInsets(&self) -> NSDirectionalEdgeInsets

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

Insets from the bounds of the button to create the content region. Defaults styles provide insets based on the button size.

pub unsafe fn setContentInsets(&self, content_insets: NSDirectionalEdgeInsets)

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

Setter for contentInsets.

pub unsafe fn setDefaultContentInsets(&self)

Restore the default content insets.

pub unsafe fn imagePlacement(&self) -> NSDirectionalRectEdge

Available on crate feature UIGeometry only.

Defaults to Leading, only single edge values (top/leading/bottom/trailing) are supported.

pub unsafe fn setImagePlacement(&self, image_placement: NSDirectionalRectEdge)

Available on crate feature UIGeometry only.

Setter for imagePlacement.

pub unsafe fn imagePadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

When a button has both image and text content, this value is the padding between the image and the text.

pub unsafe fn setImagePadding(&self, image_padding: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for imagePadding.

pub unsafe fn titlePadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

When a button has both a title & subtitle, this value is the padding between those titles.

pub unsafe fn setTitlePadding(&self, title_padding: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for titlePadding.

pub unsafe fn titleAlignment(&self) -> UIButtonConfigurationTitleAlignment

The alignment to use for relative layout between title & subtitle.

pub unsafe fn setTitleAlignment( &self, title_alignment: UIButtonConfigurationTitleAlignment, )

Setter for titleAlignment.

pub unsafe fn automaticallyUpdateForSelection(&self) -> bool

If the style should automatically update when the button is selected. Default varies by style. Disable to customize selection behavior.

pub unsafe fn setAutomaticallyUpdateForSelection( &self, automatically_update_for_selection: bool, )

Setter for automaticallyUpdateForSelection.

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.

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 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 UIButtonConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIButtonConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIButtonConfiguration> for UIButtonConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIButtonConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIButtonConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIButtonConfiguration

const NAME: &'static str = "UIButtonConfiguration"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 UIButtonConfiguration

type Result = UIButtonConfiguration

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

impl Debug for UIButtonConfiguration

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

Formats the value using the given formatter.

impl Deref for UIButtonConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIButtonConfiguration

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 UIButtonConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIButtonConfiguration

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 NSCopying for UIButtonConfiguration

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 UIButtonConfiguration

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 UIButtonConfiguration

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UIButtonConfiguration

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 UIButtonConfiguration

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

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

impl DowncastTarget for UIButtonConfiguration

impl Eq for UIButtonConfiguration