Struct CLLocationButton 

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

Available on crate features CLLocationButton and objc2-ui-kit only.

A button that grants one-time location authorization.

CLLocationButton simplifies requesting one-time authorization to access location data. Add this button to your user interface in situations when users may want to grant temporary access to their location data each time they use a particular feature of your app.

The first time a user taps this button, <doc ://com.apple.documentation/documentation/corelocation> asks the user to confirm that they’re comfortable using this UI element when they want to grant temporary access to their location data. If the user agrees, the app receives temporary <doc ://com.apple.documentation/documentation/corelocation/clauthorizationstatus/authorizedwheninuse> authorization, like when the user chooses Allow Once in response to your app’s standard location authorization request. This temporary authorization expires when your app is no longer in use.

After the user agrees to using CLLocationButton, the button becomes approved to request future authorizations without displaying an additional alert to the user. The next time the user taps it, this button simply grants one-time authorization without requiring confirmation.

After you receive this temporary authorization, fetch the user’s location using the <doc ://com.apple.documentation/documentation/corelocation> API and perform any app-specific tasks related to that location data. Connect the button to initiate the tasks you want to perform after getting authorization by adding a target and action to the button. Keep in mind that this action activates every time the user taps this button, regardless of whether the app already has location authorization.

Create a CLLocationButton in Interface Builder or in code, like this:

let locationButton = CLLocationButton()
locationButton.icon = .arrowFilled
locationButton.label = .currentLocation
locationButton.cornerRadius = 25.0
locationButton.addTarget(self, action: #selector(userPressedLocationButton), for: .touchUpInside)

• Important: When a user taps the button, it only provides one-time authorization to fetch location data — not the location data itself. For more details about fetching location data, see <doc ://com.apple.documentation/documentation/corelocation/configuring_your_app_to_use_location_services>.

Configure the button’s content by specifying its CLLocationButton/icon and CLLocationButton/label styles. Customize its appearance using the CLLocationButton/cornerRadius and CLLocationButton/fontSize properties, or the standard view appearance properties <doc ://com.apple.documentation/documentation/uikit/uiview/1622591-backgroundcolor> and <doc ://com.apple.documentation/documentation/uikit/uiview/1622467-tintcolor>. For design guidance, see Human Interface Guidelines.

See also Apple’s documentation

Implementations

impl CLLocationButton

pub unsafe fn icon(&self) -> CLLocationButtonIcon

The style of the location arrow icon on the button.

pub unsafe fn setIcon(&self, icon: CLLocationButtonIcon)

Setter for icon.

pub unsafe fn label(&self) -> CLLocationButtonLabel

The text of the button label.

pub unsafe fn setLabel(&self, label: CLLocationButtonLabel)

Setter for label.

pub unsafe fn fontSize(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The font size of the text on the button.

pub unsafe fn setFontSize(&self, font_size: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for fontSize.

pub unsafe fn cornerRadius(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The corner radius of the button.

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

Available on crate feature objc2-core-foundation only.

Setter for cornerRadius.

impl CLLocationButton

Methods declared on superclass UIControl.

pub unsafe fn initWithFrame( this: Allocated<Self>, frame: CGRect, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

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

pub unsafe fn initWithFrame_primaryAction( this: Allocated<Self>, frame: CGRect, primary_action: Option<&UIAction>, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initializes the control and adds primaryAction for the UIControlEventPrimaryActionTriggered control event. Subclasses of UIControl may alter or add behaviors around the usage of primaryAction, see subclass documentation of this initializer for additional information.

impl CLLocationButton

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = UIControl>

pub unsafe fn isEnabled(&self) -> bool

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub unsafe fn isSelected(&self) -> bool

pub unsafe fn setSelected(&self, selected: bool)

Setter for isSelected.

pub unsafe fn isHighlighted(&self) -> bool

pub unsafe fn setHighlighted(&self, highlighted: bool)

Setter for isHighlighted.

pub unsafe fn contentVerticalAlignment( &self, ) -> UIControlContentVerticalAlignment

pub unsafe fn setContentVerticalAlignment( &self, content_vertical_alignment: UIControlContentVerticalAlignment, )

Setter for contentVerticalAlignment.

pub unsafe fn contentHorizontalAlignment( &self, ) -> UIControlContentHorizontalAlignment

pub unsafe fn setContentHorizontalAlignment( &self, content_horizontal_alignment: UIControlContentHorizontalAlignment, )

Setter for contentHorizontalAlignment.

pub unsafe fn effectiveContentHorizontalAlignment( &self, ) -> UIControlContentHorizontalAlignment

pub unsafe fn state(&self) -> UIControlState

pub unsafe fn isTracking(&self) -> bool

pub unsafe fn isTouchInside(&self) -> bool

pub unsafe fn addTarget_action_forControlEvents( &self, target: Option<&AnyObject>, action: Sel, control_events: UIControlEvents, )

pub unsafe fn removeTarget_action_forControlEvents( &self, target: Option<&AnyObject>, action: Option<Sel>, control_events: UIControlEvents, )

pub unsafe fn addAction_forControlEvents( &self, action: &UIAction, control_events: UIControlEvents, )

Adds the UIAction to a given event. UIActions are uniqued based on their identifier, and subsequent actions with the same identifier replace previously added actions. You may add multiple UIActions for corresponding controlEvents, and you may add the same action to multiple controlEvents.

pub unsafe fn removeAction_forControlEvents( &self, action: &UIAction, control_events: UIControlEvents, )

Removes the action from the set of passed control events.

pub unsafe fn removeActionForIdentifier_forControlEvents( &self, action_identifier: &NSString, control_events: UIControlEvents, )

Removes the action with the provided identifier from the set of passed control events.

pub unsafe fn performPrimaryAction(&self)

Performs the control’s primary action.

pub unsafe fn allTargets(&self) -> Retained<NSSet>

pub unsafe fn allControlEvents(&self) -> UIControlEvents

pub unsafe fn actionsForTarget_forControlEvent( &self, target: Option<&AnyObject>, control_event: UIControlEvents, ) -> Option<Retained<NSArray<NSString>>>

pub unsafe fn sendAction(&self, action: &UIAction)

Like -sendAction:to:forEvent:, this method is called by -sendActionsForControlEvents:. You may override this method to observe or modify behavior. If you override this method, you should call super precisely once to dispatch the action, or not call super to suppress sending that action.

pub unsafe fn sendActionsForControlEvents( &self, control_events: UIControlEvents, )

send all actions associated with the given control events

pub unsafe fn isContextMenuInteractionEnabled(&self) -> bool

Specifies if the context menu interaction is enabled. NO by default.

pub unsafe fn setContextMenuInteractionEnabled( &self, context_menu_interaction_enabled: bool, )

Setter for isContextMenuInteractionEnabled.

pub unsafe fn showsMenuAsPrimaryAction(&self) -> bool

If the contextMenuInteraction is the primary action of the control, invoked on touch-down. NO by default.

pub unsafe fn setShowsMenuAsPrimaryAction( &self, shows_menu_as_primary_action: bool, )

Setter for showsMenuAsPrimaryAction.

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

Assigning a value to this property causes the tool tip to be displayed for the view. Setting the property to nil cancels the display of the tool tip for the view.

pub unsafe fn setToolTip(&self, tool_tip: Option<&NSString>)

Setter for toolTip.

pub unsafe fn isSymbolAnimationEnabled(&self) -> bool

Whether or not symbol animations are enabled for this control. The default value varies depending on the control.

pub unsafe fn setSymbolAnimationEnabled(&self, symbol_animation_enabled: bool)

Setter for isSymbolAnimationEnabled.

Methods from Deref<Target = UIView>

pub unsafe fn isUserInteractionEnabled(&self) -> bool

pub unsafe fn setUserInteractionEnabled(&self, user_interaction_enabled: bool)

Setter for isUserInteractionEnabled.

pub unsafe fn tag(&self) -> isize

pub unsafe fn setTag(&self, tag: isize)

Setter for tag.

pub unsafe fn canBecomeFocused(&self) -> bool

pub unsafe fn isFocused(&self) -> bool

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

The identifier of the focus group that this view belongs to. If this is nil, subviews inherit their superview’s focus group.

pub unsafe fn setFocusGroupIdentifier( &self, focus_group_identifier: Option<&NSString>, )

Setter for focusGroupIdentifier.

pub unsafe fn focusGroupPriority(&self) -> isize

The priority this item has in its focus group. The higher the priority, the more likely it is to get picked when focus moves into this group. Note: this method can only be used to increase an item’s priority, not decrease it. For example if an item is currently selected, the actual priority of this item will be determined by MAX(focusGroupPriority, UIFocusGroupPrioritySelected).

pub unsafe fn setFocusGroupPriority(&self, focus_group_priority: isize)

Setter for focusGroupPriority.

pub unsafe fn semanticContentAttribute(&self) -> UISemanticContentAttribute

pub unsafe fn setSemanticContentAttribute( &self, semantic_content_attribute: UISemanticContentAttribute, )

Setter for semanticContentAttribute.

pub unsafe fn isMultipleTouchEnabled(&self) -> bool

pub fn setMultipleTouchEnabled(&self, multiple_touch_enabled: bool)

Setter for isMultipleTouchEnabled.

pub unsafe fn isExclusiveTouch(&self) -> bool

pub unsafe fn setExclusiveTouch(&self, exclusive_touch: bool)

Setter for isExclusiveTouch.

pub unsafe fn autoresizesSubviews(&self) -> bool

pub unsafe fn setAutoresizesSubviews(&self, autoresizes_subviews: bool)

Setter for autoresizesSubviews.

pub unsafe fn autoresizingMask(&self) -> UIViewAutoresizing

pub unsafe fn setAutoresizingMask(&self, autoresizing_mask: UIViewAutoresizing)

Setter for autoresizingMask.

pub unsafe fn sizeToFit(&self)

pub fn superview(&self) -> Option<Retained<UIView>>

pub fn subviews(&self) -> Retained<NSArray<UIView>>

pub unsafe fn removeFromSuperview(&self)

pub unsafe fn insertSubview_atIndex(&self, view: &UIView, index: isize)

pub unsafe fn exchangeSubviewAtIndex_withSubviewAtIndex( &self, index1: isize, index2: isize, )

pub unsafe fn addSubview(&self, view: &UIView)

pub unsafe fn insertSubview_belowSubview( &self, view: &UIView, sibling_subview: &UIView, )

pub unsafe fn insertSubview_aboveSubview( &self, view: &UIView, sibling_subview: &UIView, )

pub unsafe fn bringSubviewToFront(&self, view: &UIView)

pub unsafe fn sendSubviewToBack(&self, view: &UIView)

pub unsafe fn didAddSubview(&self, subview: &UIView)

pub unsafe fn willRemoveSubview(&self, subview: &UIView)

pub unsafe fn willMoveToSuperview(&self, new_superview: Option<&UIView>)

pub unsafe fn didMoveToSuperview(&self)

pub unsafe fn didMoveToWindow(&self)

pub unsafe fn isDescendantOfView(&self, view: &UIView) -> bool

pub unsafe fn viewWithTag(&self, tag: isize) -> Option<Retained<UIView>>

pub unsafe fn setNeedsLayout(&self)

pub unsafe fn layoutIfNeeded(&self)

pub unsafe fn layoutSubviews(&self)

pub unsafe fn preservesSuperviewLayoutMargins(&self) -> bool

pub unsafe fn setPreservesSuperviewLayoutMargins( &self, preserves_superview_layout_margins: bool, )

Setter for preservesSuperviewLayoutMargins.

pub unsafe fn insetsLayoutMarginsFromSafeArea(&self) -> bool

pub unsafe fn setInsetsLayoutMarginsFromSafeArea( &self, insets_layout_margins_from_safe_area: bool, )

Setter for insetsLayoutMarginsFromSafeArea.

pub unsafe fn layoutMarginsDidChange(&self)

pub unsafe fn safeAreaInsetsDidChange(&self)

pub fn setNeedsDisplay(&self)

pub unsafe fn clipsToBounds(&self) -> bool

pub unsafe fn setClipsToBounds(&self, clips_to_bounds: bool)

Setter for clipsToBounds.

pub unsafe fn isOpaque(&self) -> bool

pub unsafe fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

pub unsafe fn clearsContextBeforeDrawing(&self) -> bool

pub unsafe fn setClearsContextBeforeDrawing( &self, clears_context_before_drawing: bool, )

Setter for clearsContextBeforeDrawing.

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

pub unsafe fn contentMode(&self) -> UIViewContentMode

pub unsafe fn setContentMode(&self, content_mode: UIViewContentMode)

Setter for contentMode.

pub unsafe fn maskView(&self) -> Option<Retained<UIView>>

pub unsafe fn setMaskView(&self, mask_view: Option<&UIView>)

Setter for maskView.

pub unsafe fn tintAdjustmentMode(&self) -> UIViewTintAdjustmentMode

pub unsafe fn setTintAdjustmentMode( &self, tint_adjustment_mode: UIViewTintAdjustmentMode, )

Setter for tintAdjustmentMode.

pub unsafe fn tintColorDidChange(&self)

pub unsafe fn updateConstraintsIfNeeded(&self)

pub unsafe fn updateConstraints(&self)

pub unsafe fn needsUpdateConstraints(&self) -> bool

pub unsafe fn setNeedsUpdateConstraints(&self)

pub unsafe fn translatesAutoresizingMaskIntoConstraints(&self) -> bool

pub unsafe fn setTranslatesAutoresizingMaskIntoConstraints( &self, translates_autoresizing_mask_into_constraints: bool, )

Setter for translatesAutoresizingMaskIntoConstraints.

pub unsafe fn viewForBaselineLayout(&self) -> Retained<UIView>

👎Deprecated: Override -viewForFirstBaselineLayout or -viewForLastBaselineLayout as appropriate, instead

pub unsafe fn viewForFirstBaselineLayout(&self) -> Retained<UIView>

pub unsafe fn viewForLastBaselineLayout(&self) -> Retained<UIView>

pub unsafe fn invalidateIntrinsicContentSize(&self)

pub unsafe fn hasAmbiguousLayout(&self) -> bool

pub unsafe fn exerciseAmbiguityInLayout(&self)

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

pub unsafe fn setRestorationIdentifier( &self, restoration_identifier: Option<&NSString>, )

Setter for restorationIdentifier.

pub unsafe fn encodeRestorableStateWithCoder(&self, coder: &NSCoder)

pub unsafe fn decodeRestorableStateWithCoder(&self, coder: &NSCoder)

pub unsafe fn snapshotViewAfterScreenUpdates( &self, after_updates: bool, ) -> Option<Retained<UIView>>

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

Will return a string with a log of all the superviews of this view, alongside with what content size category each view has and if that view has limits applied. This is for debugging purposes only.

pub unsafe fn traitOverrides( &self, ) -> Retained<ProtocolObject<dyn UITraitOverrides>>

pub unsafe fn updateTraitsIfNeeded(&self)

Forces an immediate trait update for this view (and its view controller, if applicable) and any subviews, including any view controllers or views in its subtree. Any trait change callbacks are sent synchronously.

Methods from Deref<Target = UIResponder>

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

pub unsafe fn canBecomeFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn canResignFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn isFirstResponder(&self) -> bool

pub unsafe fn canPerformAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> bool

pub unsafe fn targetForAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

pub unsafe fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub unsafe fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

pub unsafe fn inputView(&self) -> Option<Retained<UIView>>

pub unsafe fn inputAccessoryView(&self) -> Option<Retained<UIView>>

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

pub unsafe fn reloadInputViews(&self)

pub unsafe fn userActivity(&self) -> Option<Retained<NSUserActivity>>

pub unsafe fn setUserActivity(&self, user_activity: Option<&NSUserActivity>)

Setter for userActivity.

pub unsafe fn updateUserActivityState(&self, activity: &NSUserActivity)

pub unsafe fn restoreUserActivityState(&self, activity: &NSUserActivity)

pub unsafe fn captureTextFromCamera(&self, sender: Option<&AnyObject>)

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

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.

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,

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 CLLocationButton

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CLLocationButton> for CLLocationButton

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CLLocationButton

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIControl> for CLLocationButton

fn as_ref(&self) -> &UIControl

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

impl AsRef<UIResponder> for CLLocationButton

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UIView> for CLLocationButton

fn as_ref(&self) -> &UIView

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

impl Borrow<AnyObject> for CLLocationButton

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CLLocationButton

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIControl> for CLLocationButton

fn borrow(&self) -> &UIControl

Immutably borrows from an owned value.

impl Borrow<UIResponder> for CLLocationButton

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIView> for CLLocationButton

fn borrow(&self) -> &UIView

Immutably borrows from an owned value.

impl CALayerDelegate for CLLocationButton

unsafe fn displayLayer(&self, layer: &CALayer)

where Self: Sized + Message,

unsafe fn layerWillDraw(&self, layer: &CALayer)

where Self: Sized + Message,

unsafe fn layoutSublayersOfLayer(&self, layer: &CALayer)

where Self: Sized + Message,

unsafe fn actionForLayer_forKey( &self, layer: &CALayer, event: &NSString, ) -> Option<Retained<ProtocolObject<dyn CAAction>>>

where Self: Sized + Message,

impl ClassType for CLLocationButton

const NAME: &'static str = "CLLocationButton"

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

type Super = UIControl

The superclass of this class.

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

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

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for CLLocationButton

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

Formats the value using the given formatter.

impl Deref for CLLocationButton

type Target = UIControl

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CLLocationButton

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 CLLocationButton

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for CLLocationButton

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for CLLocationButton

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 CLLocationButton

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CLLocationButton

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 CLLocationButton

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

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

impl UIAppearance for CLLocationButton

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

where Self: Sized + ClassType,

unsafe fn appearanceWhenContainedInInstancesOfClasses( container_types: &NSArray<AnyClass>, mtm: MainThreadMarker, ) -> Retained<Self>

where Self: Sized + ClassType,

unsafe fn appearanceForTraitCollection( trait: &UITraitCollection, mtm: MainThreadMarker, ) -> Retained<Self>

where Self: Sized + ClassType,

unsafe fn appearanceForTraitCollection_whenContainedInInstancesOfClasses( trait: &UITraitCollection, container_types: &NSArray<AnyClass>, mtm: MainThreadMarker, ) -> Retained<Self>

where Self: Sized + ClassType,

impl UIDynamicItem for CLLocationButton

unsafe fn collisionBoundsType(&self) -> UIDynamicItemCollisionBoundsType

where Self: Sized + Message,

The collision type represents how the dynamics system will evaluate collisions with respect to the dynamic item. defaults to UIDynamicItemCollisionBoundsTypeRectangle

impl UIFocusEnvironment for CLLocationButton

unsafe fn preferredFocusEnvironments( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

The preferred focus environments define where to search for the default focused item in an environment, such as when focus updates programmatically. Starting from the target environment, each preferred focus environment is recursively searched in the order of the array until an eligible, focusable item is found. Preferred focus environments can include focusable and non-focusable items, in addition to non-item environments. Returning an empty array is equivalent to returning an array containing only ‘self’.

unsafe fn parentFocusEnvironment( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

The parent focus environment of this environment, or nil if no parent exists. NOTE: If you implement this method, you must return a non-nil value for parent focus environment, otherwise your focus environment will not participate in focus interactions.

unsafe fn focusItemContainer( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusItemContainer>>>

where Self: Sized + Message,

The container of any child focus items in this focus environment, or nil if no container exists.

unsafe fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

Marks this environment as needing a focus update, which if accepted will attempt to reset focus to this environment, or one of its preferred focus environments, on the next update cycle. If this environment does not currently contain the focused item, then calling this method has no effect. If a parent of this environment is also requesting focus, then this environment’s request is rejected in favor of the parent’s. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] requestFocusUpdateToEnvironment:self];

unsafe fn updateFocusIfNeeded(&self)

where Self: Sized + Message,

Forces focus to be updated immediately. If there is an environment that has requested a focus update via -setNeedsFocusUpdate, and the request was accepted, then focus will be updated to that environment or one of its preferred focus environments. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] updateFocusIfNeeded];.

unsafe fn shouldUpdateFocusInContext( &self, context: &UIFocusUpdateContext, ) -> bool

where Self: Sized + Message,

Asks whether the system should allow a focus update to occur.

unsafe fn soundIdentifierForFocusUpdateInContext( &self, context: &UIFocusUpdateContext, ) -> Option<Retained<NSString>>

where Self: Sized + Message,

Specifies an identifier corresponding to a sound that should be played for a focus update. Return UIFocusSoundIdentifierNone to opt out of sounds, UIFocusSoundIdentifierDefault for the system default sounds, a previously registered identifier for a custom sound, or nil to defer the decision to the parent.

unsafe fn preferredFocusedView(&self) -> Option<Retained<UIView>>

where Self: Sized + Message,

👎Deprecated

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

where Self: Sized + Message,

The identifier of the focus group that this view belongs to. If this is nil, subviews inherit their superview’s focus group.

impl UIFocusItem for CLLocationButton

unsafe fn canBecomeFocused(&self) -> bool

where Self: Sized + Message,

Indicates whether or not this item is currently allowed to become focused. Returning NO restricts the item from being focusable, even if it is visible in the user interface. For example, UIControls return NO if they are disabled.

unsafe fn focusGroupPriority(&self) -> isize

where Self: Sized + Message,

The priority this item has in its focus group. The higher the priority, the more likely it is to get picked when focus moves into this group. Note: this method can only be used to increase an item’s priority, not decrease it. For example if an item is currently selected, the actual priority of this item will be determined by MAX(focusGroupPriority, UIFocusGroupPrioritySelected).

unsafe fn focusItemDeferralMode(&self) -> UIFocusItemDeferralMode

where Self: Sized + Message,

If this property is present and returns UIFocusItemDeferralModeNever, the focus deferral will not be enabled again after the user engagement timeout has expired if this item is currently focused and programmatic focus updates pointing to this item will be executed immediatly. If it returns UIFocusItemDeferralModeAlways focus will always be deferred when this item is supposed to be focused. Does nothing when focus deferral is not supported on the platform.

unsafe fn isTransparentFocusItem(&self) -> bool

where Self: Sized + Message,

If this returns YES, the focus item is considered transparent in terms of occlusion. Items that are behind it are focusable. This value is ignored when the item is focusable, in which case the item is never considered transparent.

impl UIFocusItemContainer for CLLocationButton

unsafe fn coordinateSpace( &self, ) -> Retained<ProtocolObject<dyn UICoordinateSpace>>

where Self: Sized + Message,

The coordinate space of the focus items contained in this container. The focus items returned by focusItemsInRect: should report their frames in this coordinate space. If you are implementing this protocol, you may find it convenient to return the UIScreen as your coordinate space, and ensure that your contained items report their frames in screen space. Similarly, you might find that your focus items’ containing UIView or UIWindow is the most convenient coordinate space to use. You may also choose to implement your own object that conforms to UICoordinateSpace, if that is the most natural solution for your architecture.

impl UIResponderStandardEditActions for CLLocationButton

unsafe fn cut(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn copy(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn paste(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn pasteAndMatchStyle(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn pasteAndGo(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn pasteAndSearch(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn select(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn selectAll(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn delete(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn makeTextWritingDirectionLeftToRight(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn makeTextWritingDirectionRightToLeft(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn toggleBoldface(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn toggleItalics(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn toggleUnderline(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn increaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn decreaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn find(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn findAndReplace(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn findNext(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn findPrevious(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn useSelectionForFind(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn print(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn rename(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn duplicate(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn move(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn export(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

unsafe fn showWritingTools(&self, sender: &AnyObject)

where Self: Sized + Message,

impl UITraitEnvironment for CLLocationButton

fn traitCollection(&self) -> Retained<UITraitCollection>

where Self: Sized + Message,

unsafe fn traitCollectionDidChange( &self, previous_trait_collection: Option<&UITraitCollection>, )

where Self: Sized + Message,

👎Deprecated: Use the trait change registration APIs declared in the UITraitChangeObservable protocol

To be overridden as needed to provide custom behavior when the environment’s traits change.

impl DowncastTarget for CLLocationButton

impl Eq for CLLocationButton

impl UIAppearanceContainer for CLLocationButton

impl UICoordinateSpace for CLLocationButton