Struct WKWebExtensionAction

Source

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

Available on crate feature WKWebExtensionAction only.

Expand description

A WKWebExtensionAction object encapsulates the properties for an individual web extension action.

Provides access to action properties such as popup, icon, and title, with tab-specific values.

Implementations§

Source §

pub unsafe fn webExtensionContext( &self, ) -> Option<Retained<WKWebExtensionContext>>

Available on crate feature WKWebExtensionContext only.

The extension context to which this action is related.

Source

pub unsafe fn associatedTab( &self, ) -> Option<Retained<ProtocolObject<dyn WKWebExtensionTab>>>

Available on crate feature WKWebExtensionTab only.

The tab that this action is associated with, or nil if it is the default action.

When this property is nil, it indicates that the action is the default action and not associated with a specific tab.

Source

pub unsafe fn iconForSize(&self, size: CGSize) -> Option<Retained<NSImage>>

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

Source

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

The localized display label for the action.

Source

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

The badge text for the action.

Provides the text that appears on the badge for the action. An empty string signifies that no badge should be shown.

Source

pub unsafe fn hasUnreadBadgeText(&self) -> bool

A Boolean value indicating whether the badge text is unread.

This property is automatically set to YES when badgeText changes and is not empty. If badgeText becomes empty or the popup associated with the action is presented, this property is automatically set to NO. Additionally, it should be set to NO by the app when the badge has been presented to the user. This property is useful for higher-level notification badges when extensions might be hidden behind an action sheet.

Source

pub unsafe fn setHasUnreadBadgeText(&self, has_unread_badge_text: bool)

Setter for hasUnreadBadgeText.

Source

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

The name shown when inspecting the popup web view.

This is the text that will appear when inspecting the popup web view.

Source

pub unsafe fn setInspectionName(&self, inspection_name: Option<&NSString>)

Setter for inspectionName.

Source

pub unsafe fn isEnabled(&self) -> bool

A Boolean value indicating whether the action is enabled.

Source

pub unsafe fn menuItems(&self) -> Retained<NSArray<NSMenuItem>>

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

Source

pub unsafe fn presentsPopup(&self) -> bool

A Boolean value indicating whether the action has a popup.

Use this property to check if the action has a popup before attempting to show any popup views.

Source

pub unsafe fn popupPopover(&self) -> Option<Retained<NSPopover>>

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

A popover that presents a web view loaded with the popup page for this action, or nil if no popup is specified.

This popover contains a view controller with a web view preloaded with the popup page. It automatically adjusts its size to fit the web view’s content size. The presentsPopup property should be checked to determine the availability of a popup before using this property. Dismissing the popover will close the popup and unload the web view.

pub unsafe fn popupWebView(&self) -> Option<Retained<WKWebView>>

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

A web view loaded with the popup page for this action, or nil if no popup is specified.

The web view will be preloaded with the popup page upon first access or after it has been unloaded. Use the presentsPopup property to determine whether a popup should be displayed before using this property.

pub unsafe fn closePopup(&self)

Triggers the dismissal process of the popup.

Invoke this method to manage the popup’s lifecycle, ensuring the web view is unloaded and resources are released once the popup closes. This method is automatically called upon the dismissal of the action’s UIViewController or NSPopover. For custom scenarios where the popup’s lifecycle is manually managed, it must be explicitly invoked to ensure proper closure.

Source §

impl WKWebExtensionAction

Methods declared on superclass NSObject.

Source

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

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