Struct PKPaymentButton

Source

pub struct PKPaymentButton { /* private fields */ }

Available on macOS and crate feature objc2-app-kit and crate feature PKPaymentButton only.

Expand description

Apple’s documentation

Implementations§

Source §

Available on crate feature objc2-core-foundation only.

Setter for cornerRadius.

Source §

impl PKPaymentButton

Methods declared on superclass NSButton.

Source

pub unsafe fn buttonWithTitle_image_target_action( title: &NSString, image: &NSImage, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Creates a standard push button with a title and image.

Parameter title: The localized title string that is displayed on the button.

Parameter image: The image that is displayed alongside the title. In left-to-right localizations, the image is displayed to the left of the title. In right-to-left localizations, it is displayed to the right.

Parameter target: The target object that receives action messages from the control.

Parameter action: The action message sent by the control.

Returns: An initialized button object.

§Safety

target should be of the correct type.
action must be a valid selector.

Source

pub unsafe fn buttonWithTitle_target_action( title: &NSString, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Creates a standard push button with the provided title.

Parameter title: The localized title string that is displayed on the button.

Parameter target: The target object that receives action messages from the control.

Parameter action: The action message sent by the control.

Returns: An initialized button object.

§Safety

target should be of the correct type.
action must be a valid selector.

Source

pub unsafe fn buttonWithImage_target_action( image: &NSImage, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Creates a standard push button with the provided image. Set the image’s accessibilityDescription property to ensure accessibility for this control.

Parameter image: The image to display in the body of the button.

Parameter target: The target object that receives action messages from the control.

Parameter action: The action message sent by the control.

Returns: An initialized button object.

§Safety

target should be of the correct type.
action must be a valid selector.

Source

pub unsafe fn checkboxWithTitle_target_action( title: &NSString, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Creates a standard checkbox with the provided title.

Parameter title: The localized title string that is displayed alongside the checkbox.

Parameter target: The target object that receives action messages from the control.

Parameter action: The action message sent by the control.

Returns: An initialized button object.

§Safety

target should be of the correct type.
action must be a valid selector.

Source

pub unsafe fn radioButtonWithTitle_target_action( title: &NSString, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Creates a standard radio button with the provided title.

Parameter title: The localized title string that is displayed alongside the radio button.

Parameter target: The target object that receives action messages from the control.

Parameter action: The action message sent by the control.

Returns: An initialized button object.

§Safety

target should be of the correct type.
action must be a valid selector.

Source §

impl PKPaymentButton

Methods declared on superclass NSControl.

Source

pub unsafe fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

Source

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

§Safety

coder possibly has further requirements.

Source §

impl PKPaymentButton

Available on crate features NSControl and NSResponder and NSView only.

Gets the initial delay and repeat interval, in seconds, for repeated action messages sent when continuous is YES. Both parameters to this method must not be NULL.

§Safety

delay must be a valid pointer.
interval must be a valid pointer.

Source

pub fn isBordered(&self) -> bool

Available on crate features NSControl and NSResponder and NSView only.

A Boolean value that determines whether the button draws a border.

Source

pub fn setBordered(&self, bordered: bool)

Available on crate features NSControl and NSResponder and NSView only.

Setter for isBordered.

Source

pub fn isTransparent(&self) -> bool

Available on crate features NSControl and NSResponder and NSView only.

A Boolean value that indicates whether the button is transparent. A transparent button never draws itself, but it receives mouse events, sends its action, and tracks the mouse properly.

Source

pub fn setTransparent(&self, transparent: bool)

Available on crate features NSControl and NSResponder and NSView only.

Setter for isTransparent.

Source

Available on crate features NSControl and NSImage and NSResponder and NSView only.

Available on crate features NSControl and NSResponder and NSView only.

Setter for keyEquivalent.

pub unsafe fn setTitleWithMnemonic( &self, string_with_ampersand: Option<&NSString>, )

👎Deprecated:

Mnemonics are not used on macOS. Set the title property directly instead.

Available on crate features NSControl and NSResponder and NSView only.

§Safety

string_with_ampersand might not allow None.

Methods from Deref<Target = NSControl>§

Source

pub fn target(&self) -> Option<Retained<AnyObject>>

Available on crate features NSResponder and NSView only.

Source

pub unsafe fn setTarget(&self, target: Option<&AnyObject>)

Available on crate features NSResponder and NSView only.

Available on crate features NSResponder and NSView only.

Source

pub fn setStringValue(&self, string_value: &NSString)

Available on crate features NSResponder and NSView only.

Setter for stringValue.

This is copied when set.

Source

pub fn attributedStringValue(&self) -> Retained<NSAttributedString>

Available on crate features NSResponder and NSView only.

Source

pub fn setAttributedStringValue( &self, attributed_string_value: &NSAttributedString, )

Available on crate features NSResponder and NSView only.

Available on crate features NSResponder and NSView only.

Source

pub fn setUsesSingleLineMode(&self, uses_single_line_mode: bool)

Available on crate features NSResponder and NSView only.

Setter for usesSingleLineMode.

Source

pub fn allowsExpansionToolTips(&self) -> bool

Available on crate features NSResponder and NSView only.

Source

pub fn setAllowsExpansionToolTips(&self, allows_expansion_tool_tips: bool)

Available on crate features NSResponder and NSView only.

pub fn selectedTag(&self) -> isize

Available on crate features NSResponder and NSView only.

Source

pub fn setNeedsDisplay(&self)

👎Deprecated:

Set the needsDisplay property to YES instead

Available on crate features NSResponder and NSView only.

Source

pub fn calcSize(&self)

👎Deprecated:

pub fn setSubviews(&self, subviews: &NSArray<NSView>)

Available on crate feature NSResponder only.

Setter for subviews.

This is copied when set.

Source

pub fn isDescendantOf(&self, view: &NSView) -> bool

Available on crate feature NSResponder only.

Source

pub fn ancestorSharedWithView(&self, view: &NSView) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

Source

pub unsafe fn opaqueAncestor(&self) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub fn isHidden(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setHidden(&self, hidden: bool)

Available on crate feature NSResponder only.

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Available on crate feature NSResponder only.

Source

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

Available on crate feature NSResponder only.

§Safety

rects must be a valid pointer or null.
count must be a valid pointer or null.

§Safety

compare must be implemented correctly.
context must be a valid pointer or null.

Setter for postsFrameChangedNotifications.

Source

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Source

pub fn frame(&self) -> CGRect

Available on crate feature NSResponder only.

Source

pub fn setFrame(&self, frame: CGRect)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Setter for canDrawConcurrently.

Source

pub fn canDraw(&self) -> bool

👎Deprecated:

If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Available on crate feature NSResponder only.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Available on crate feature NSResponder only.

Source

pub fn needsDisplay(&self) -> bool

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

The portion of the view that isn’t clipped by its superviews.

Visibility, as reflected by this property, doesn’t account for whether other view or window objects overlap the current view or whether the current view is installed in a window at all. This value of this property is NSZeroRect if the current view is effectively hidden.

Use allowedTouchTypes instead

Available on crate feature NSResponder only.

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated:

Use allowedTouchTypes instead

Available on crate feature NSResponder only.

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Available on crate feature NSResponder only.

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Available on crate feature NSResponder only.

Source

pub fn allowsVibrancy(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn viewDidChangeEffectiveAppearance(&self)

Available on crate feature NSResponder only.

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

pub unsafe fn nextKeyView(&self) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Source

pub fn setAdditionalSafeAreaInsets( &self, additional_safe_area_insets: NSEdgeInsets, )

Available on crate feature NSResponder only.

Setter for additionalSafeAreaInsets.

Source

Available on crate feature NSResponder only.

Source

pub fn discardCursorRects(&self)

Available on crate feature NSResponder only.

Source

pub fn resetCursorRects(&self)

Available on crate feature NSResponder only.

Source

pub unsafe fn addTrackingRect_owner_userData_assumeInside( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, flag: bool, ) -> isize

Available on crate feature NSResponder only.

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Source

👎Deprecated:

This has always returned NO and had no effect on macOS

Available on crate feature NSResponder only.

Source

pub fn shouldDrawColor(&self) -> bool

👎Deprecated:

This method no longer does anything

Available on crate feature NSResponder only.

Source

pub fn gState(&self) -> isize

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn allocateGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn setUpGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn renewGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Methods from Deref<Target = NSResponder>§

Source

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

Source

pub unsafe fn presentError_modalForWindow_delegate_didPresentSelector_contextInfo( &self, error: &NSError, window: &NSWindow, delegate: Option<&AnyObject>, did_present_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate feature NSWindow only.

§Safety

delegate should be of the correct type.
did_present_selector must be a valid selector.
context_info must be a valid pointer or null.

Source

pub fn presentError(&self, error: &NSError) -> bool

Source

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

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());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated:

this is difficult to use correctly, use Ivar::load instead.

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.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

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

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

Source §

type Super = NSButton

The superclass of this class. Read more

Source §

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

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

Source §

fn class() -> &'static AnyClass

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

Dereferences the value.

Source §

impl Hash for PKPaymentButton

Source §

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for PKPaymentButton

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

Source §

Safety Read more

Setter for animations. Read more

Source §

fn hash(&self) -> usize
where Self: Sized + Message,

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

Source §

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. Read more

Source §

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

impl NSUserInterfaceValidations for PKPaymentButton

Source §

fn validateUserInterfaceItem( &self, item: &ProtocolObject<dyn NSValidatedUserInterfaceItem>, ) -> bool
where Self: Sized + Message,

Source §

impl PartialEq for PKPaymentButton

Source §

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

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

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

Struct PKPaymentButton Copy item path

Implementations§

impl PKPaymentButton

pub unsafe fn buttonWithType_style( button_type: PKPaymentButtonType, button_style: PKPaymentButtonStyle, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn initWithPaymentButtonType_paymentButtonStyle( this: Allocated<Self>, type: PKPaymentButtonType, style: PKPaymentButtonStyle, ) -> Retained<Self>

pub unsafe fn buttonWithType_style_disableCardArt( button_type: PKPaymentButtonType, button_style: PKPaymentButtonStyle, disable_card_art: bool, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn initWithPaymentButtonType_paymentButtonStyle_disableCardArt( this: Allocated<Self>, type: PKPaymentButtonType, style: PKPaymentButtonStyle, disable_card_art: bool, ) -> Retained<Self>

pub unsafe fn cornerRadius(&self) -> CGFloat

pub unsafe fn setCornerRadius(&self, corner_radius: CGFloat)

impl PKPaymentButton

pub unsafe fn buttonWithTitle_image_target_action( title: &NSString, image: &NSImage, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

§Safety

pub unsafe fn buttonWithTitle_target_action( title: &NSString, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

§Safety

pub unsafe fn buttonWithImage_target_action( image: &NSImage, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

§Safety

pub unsafe fn checkboxWithTitle_target_action( title: &NSString, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

§Safety

pub unsafe fn radioButtonWithTitle_target_action( title: &NSString, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

§Safety

impl PKPaymentButton

pub unsafe fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

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

§Safety

impl PKPaymentButton

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

impl PKPaymentButton

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

Methods from Deref<Target = NSButton>§

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

pub fn setTitle(&self, title: &NSString)

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

pub fn setAttributedTitle(&self, attributed_title: &NSAttributedString)

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

pub fn setAlternateTitle(&self, alternate_title: &NSString)

pub fn attributedAlternateTitle(&self) -> Retained<NSAttributedString>

pub fn setAttributedAlternateTitle( &self, attributed_alternate_title: &NSAttributedString, )

pub fn hasDestructiveAction(&self) -> bool

pub fn setHasDestructiveAction(&self, has_destructive_action: bool)

pub fn isSpringLoaded(&self) -> bool

pub fn setSpringLoaded(&self, spring_loaded: bool)

pub fn maxAcceleratorLevel(&self) -> isize

pub fn setMaxAcceleratorLevel(&self, max_accelerator_level: isize)

pub fn setPeriodicDelay_interval(&self, delay: f32, interval: f32)

pub unsafe fn getPeriodicDelay_interval( &self, delay: NonNull<f32>, interval: NonNull<f32>, )

§Safety

pub fn isBordered(&self) -> bool

pub fn setBordered(&self, bordered: bool)

pub fn isTransparent(&self) -> bool

pub fn setTransparent(&self, transparent: bool)

pub fn showsBorderOnlyWhileMouseInside(&self) -> bool

pub fn setShowsBorderOnlyWhileMouseInside( &self, shows_border_only_while_mouse_inside: bool, )

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

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

pub fn alternateImage(&self) -> Option<Retained<NSImage>>

pub fn setAlternateImage(&self, alternate_image: Option<&NSImage>)

pub fn imageHugsTitle(&self) -> bool

pub fn setImageHugsTitle(&self, image_hugs_title: bool)

pub fn symbolConfiguration( &self, ) -> Option<Retained<NSImageSymbolConfiguration>>

pub fn setSymbolConfiguration( &self, symbol_configuration: Option<&NSImageSymbolConfiguration>, )

pub fn allowsMixedState(&self) -> bool

pub fn setAllowsMixedState(&self, allows_mixed_state: bool)

pub fn setNextState(&self)

pub fn highlight(&self, flag: bool)

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

pub fn setKeyEquivalent(&self, key_equivalent: &NSString)

pub fn compressWithPrioritizedCompressionOptions( &self, prioritized_options: &NSArray<NSUserInterfaceCompressionOptions>, )

pub fn minimumSizeWithPrioritizedCompressionOptions( &self, prioritized_options: &NSArray<NSUserInterfaceCompressionOptions>, ) -> CGSize

pub fn activeCompressionOptions( &self, ) -> Retained<NSUserInterfaceCompressionOptions>

pub fn borderShape(&self) -> NSControlBorderShape

pub fn setBorderShape(&self, border_shape: NSControlBorderShape)

pub unsafe fn setTitleWithMnemonic( &self, string_with_ampersand: Option<&NSString>, )

§Safety

Methods from Deref<Target = NSControl>§

pub fn target(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setTarget(&self, target: Option<&AnyObject>)

§Safety

pub fn action(&self) -> Option<Sel>

pub unsafe fn setAction(&self, action: Option<Sel>)

§Safety

Struct PKPaymentButton