Struct SFCertificatePanel

Source

pub struct SFCertificatePanel { /* private fields */ }

Available on crate feature SFCertificatePanel only.

Expand description

SFCertificatePanel is a panel and sheet interface that displays one or more certificates.

Implementations§

Source §

impl SFCertificatePanel

Source

pub unsafe fn sharedCertificatePanel( mtm: MainThreadMarker, ) -> Option<Retained<SFCertificatePanel>>

Returns a shared instance of SFCertificatePanel.

If your application can display multiple SFCertificatePanels at once, you should allocate (alloc) and initialize (init) separate object instances instead of using this class method.

Source

pub unsafe fn runModalForTrust_showGroup( &self, trust: Option<&SecTrust>, show_group: bool, ) -> NSInteger

Available on crate feature objc2-security only.

Displays a certificate chain in a modal panel, returning NSOKButton when dismissed. This method is preferred over runModalForCertificates, since the SecTrustRef parameter lets you specify policies that determine whether the certificate is valid within your application’s context.

Parameter trust: A trust reference which contains the certificates to display.

Parameter showGroup: Specifies whether additional certificates (other than the leaf certificate) are displayed.

§Safety

trust might not allow None.

Source

pub unsafe fn runModalForCertificates_showGroup( &self, certificates: Option<&NSArray>, show_group: bool, ) -> NSInteger

Displays one or more specified certificates in a modal panel, returning NSOKButton when dismissed.

Parameter certificates: The certificates to display. Pass a NSArray containing one or more SecCertificateRef instances in this parameter. The leaf certificate is assumed to be at index 0; the order of additional certificates in the array is not critical.

Parameter showGroup: Specifies whether additional certificates (other than the leaf certificate) are displayed. To show only a single certificate, specify only one SecCertificateRef in the array and set showGroup to NO.

§Safety

certificates generic should be of the correct type.
certificates might not allow None.

Source

pub unsafe fn beginSheetForWindow_modalDelegate_didEndSelector_contextInfo_trust_showGroup( &self, doc_window: Option<&NSWindow>, delegate: Option<&AnyObject>, did_end_selector: Option<Sel>, context_info: *mut c_void, trust: Option<&SecTrust>, show_group: bool, )

Available on crate feature objc2-security only.

Displays a certificate chain in a modal sheet. This is the preferred sheet method for SFCertificatePanel, since the SecTrustRef parameter lets you specify policies that determine whether the certificate is valid within your application’s context.

Parameter docWindow: The parent window to which the sheet is attached.

Parameter modalDelegate: The object whose didEndSelector method will be called when the sheet is dismissed.

Parameter didEndSelector: This method is called when the sheet is dismissed.

Parameter contextInfo: Client-defined contextual data which will be passed to the didEndSelector method.

Parameter trust: A trust reference which contains the certificates to display.

Parameter showGroup: Specifies whether additional certificates (other than the leaf certificate) are displayed.

The didEndSelector method should have the following signature:

(void)certificateSheetDidEnd:(NSWindow *)sheet returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo

§Safety

doc_window might not allow None.
delegate should be of the correct type.
delegate might not allow None.
did_end_selector must be a valid selector.
context_info must be a valid pointer.
trust might not allow None.

Source

pub unsafe fn beginSheetForWindow_modalDelegate_didEndSelector_contextInfo_certificates_showGroup( &self, doc_window: Option<&NSWindow>, delegate: Option<&AnyObject>, did_end_selector: Option<Sel>, context_info: *mut c_void, certificates: Option<&NSArray>, show_group: bool, )

Displays one or more specified certificates in a modal sheet.

Parameter docWindow: The parent window to which the sheet is attached.

Parameter modalDelegate: The object whose didEndSelector method will be called when the sheet is dismissed.

Parameter didEndSelector: This method is called when the sheet is dismissed.

Parameter contextInfo: Client-defined contextual data which will be passed to the didEndSelector method.

Parameter certificates: The certificates to display. Pass a NSArray containing one or more SecCertificateRef instances in this parameter.

Parameter showGroup: Specifies whether additional certificates (other than the leaf certificate) are displayed.

The didEndSelector method should have the following signature:

(void)certificateSheetDidEnd:(NSWindow *)sheet returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo

§Safety

doc_window might not allow None.
delegate should be of the correct type.
delegate might not allow None.
did_end_selector must be a valid selector.
context_info must be a valid pointer.
certificates generic should be of the correct type.
certificates might not allow None.

Source

pub unsafe fn setPolicies(&self, policies: Option<&AnyObject>)

Specifies one or more policies that apply to the displayed certificates.

Parameter policies: The policies to use when evaluating the certificates’ status. You can pass either a SecPolicyRef or a NSArray (containing one or more SecPolicyRef instances) in this parameter. If policies is set to nil, the Apple X.509 Basic Policy will be used.

Applications will typically display a SFCertificatePanel in the context of a specific usage, such as SSL or S/MIME. You should set only the policy references which apply to your intended usage.

§Safety

policies should be of the correct type.
policies might not allow None.

Source

pub unsafe fn policies(&self) -> Option<Retained<NSArray>>

Returns an array of policies used to evaluate the status of the displayed certificates.

This method returns an autoreleased NSArray containing one or more SecPolicyRef instances, as set by a previous setPolicies: call.

Source

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

Customizes the title of the default button.

Parameter title: The new title for the default button.

§Safety

title might not allow None.

Source

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

Customizes the title of the alternate button.

Parameter title: The new title for the alternate button. If title is set to nil, the button will not be shown.

§Safety

title might not allow None.

Source

pub unsafe fn setShowsHelp(&self, shows_help: bool)

Source

pub unsafe fn showsHelp(&self) -> bool

Source

pub unsafe fn setHelpAnchor(&self, anchor: Option<&NSString>)

§Safety

§Safety

coder possibly has further requirements.

Source

pub unsafe fn windowWithContentViewController( content_view_controller: &NSViewController, ) -> Retained<Self>

Convenience method for creating an autoreleased titled window with the given contentViewController. A basic NSWindow with the following attributes is made: titled, closable, resizable, miniaturizable. The window’s title is automatically bound to the contentViewController’s title. The size of the window can easily be controlled by utilizing autolayout and applying size constraints to the view (or its subviews). The window has isReleasedWhenClosed set to NO, and it must be explicitly retained to keep the window instance alive. To have it automatically be freed when it is closed, do the following: [window retain] and [window setReleasedWhenClosed:YES].

Source §

impl SFCertificatePanel

Methods declared on superclass NSResponder.

Source

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

Source §

impl SFCertificatePanel

Methods declared on superclass NSObject.

Source

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

Setter for worksWhenModal.

Methods from Deref<Target = NSWindow>§

Source

pub fn frameRectForContentRect(&self, content_rect: CGRect) -> CGRect

Available on crate feature NSResponder only.

Source

pub fn contentRectForFrameRect(&self, frame_rect: CGRect) -> CGRect

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Setter for title.

This is copied when set.

Source

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

Available on crate feature NSResponder only.

Secondary text that may be displayed adjacent to or below the primary title depending on the configuration of the window. A value of empty string will remove the subtitle from the window layout.

Source

pub fn setSubtitle(&self, subtitle: &NSString)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

contentLayoutGuideis a corollary to contentLayoutRect.It can be used by autolayout constraints to automatically bind to the contentLayoutRect.

Source

pub fn removeTitlebarAccessoryViewControllerAtIndex(&self, index: isize)

Available on crate feature NSResponder only.

Source

pub fn representedURL(&self) -> Option<Retained<NSURL>>

Available on crate feature NSResponder only.

If url is not nil and its path is not empty, the window will show a document icon in the titlebar. If the url represents a filename or other resource with a known icon, that icon will be used as the document icon. Otherwise the default document icon will be used. The icon can be customized using -[[NSWindow standardWindowButton:NSWindowDocumentIconButton] setImage:customImage]. If url is not nil and its path is not empty, the window will have a pop-up menu which can be shown via command-click on the area containing the document icon and title. By default, this menu will display the path components of the url. The presence and contents of this menu can be controlled by the delegate method -[window:shouldPopUpDocumentPathMenu:] If the url is nil or has an empty path, the window will not show a document icon and will not have a pop-up menu available via command-click.

Source

pub fn setRepresentedURL(&self, represented_url: Option<&NSURL>)

Available on crate feature NSResponder only.

Setter for representedURL.

This is copied when set.

Source

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

Available on crate feature NSResponder only.

Source

pub fn setRepresentedFilename(&self, represented_filename: &NSString)

Available on crate feature NSResponder only.

Setter for representedFilename.

This is copied when set.

Source

Available on crate feature NSResponder only.

Setter for delegate.

This is a weak property.

Source

The frame to use when cascading or sizing a new window based on the receiver’s position or size. This may be different from frame when the receiver is positioned by the system.

Source

Source

pub fn preservesContentDuringLiveResize(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setPreservesContentDuringLiveResize( &self, preserves_content_during_live_resize: bool, )

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

§Safety

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

Source

pub fn setAutorecalculatesContentBorderThickness_forEdge( &self, flag: bool, edge: NSRectEdge, )

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Setter for miniwindowTitle.

This is copied when set.

Source

pub fn isDocumentEdited(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setDocumentEdited(&self, document_edited: bool)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Source

pub fn preventsApplicationTerminationWhenModal(&self) -> bool

Available on crate feature NSResponder only.

A Boolean value that indicates whether or not to prevent application termination when the receiving window is presented modally. The value of this property is YES if the window should prevent application termination when modal; otherwise, NO. The default value is YES. However, note that some window subclasses and some windows created indirectly (like those created by UI frameworks like AppKit and SwiftUI), may have different default values. For example, the Open panel and toolbar customization sheets should not prevent application termination, so those windows have preventsApplicationTerminationWhenModal set to NO. Some NSAlerts, like those that are simply informational, have windows that do not prevent application termination by default. Setting this property overrides the default behavior.

Source

pub fn setPreventsApplicationTerminationWhenModal( &self, prevents_application_termination_when_modal: bool, )

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Source

pub fn setDisplaysWhenScreenProfileChanges( &self, displays_when_screen_profile_changes: bool, )

Available on crate feature NSResponder only.

Setter for displaysWhenScreenProfileChanges.

Source

pub fn canBecomeVisibleWithoutLogin(&self) -> bool

Available on crate feature NSResponder only.

This API controls whether the receiver is permitted onscreen before the user has logged in. This property is off by default. Alert panels and windows presented by input managers are examples of windows which should have this property set.

Source

pub fn setCanBecomeVisibleWithoutLogin( &self, can_become_visible_without_login: bool, )

Available on crate feature NSResponder only.

Setter for canBecomeVisibleWithoutLogin.

Source

Available on crate feature NSResponder only.

Source

pub fn sheetParent(&self) -> Option<Retained<NSWindow>>

Available on crate feature NSResponder only.

Source

pub fn appearanceSource(&self) -> Option<Retained<NSObject>>

Available on crate features NSAppearance and NSResponder only.

pub fn setTitlebarSeparatorStyle( &self, titlebar_separator_style: NSTitlebarSeparatorStyle, )

Available on crate feature NSResponder only.

Setter for titlebarSeparatorStyle.

Source

pub fn contentViewController(&self) -> Option<Retained<NSViewController>>

Available on crate features NSResponder and NSViewController only.

The main content view controller for the window. This provides the contentView of the window. Assigning this value will remove the existing contentView and will make the contentViewController.view the main contentView for the window. The default value is nil. The contentViewController only controls the contentView, and not the title of the window. The window title can easily be bound to the contentViewController with the following: [window bind:NSTitleBinding toObject:contentViewController withKeyPath: “ title“ options:nil]. Setting the contentViewController will cause the window to resize based on the current size of the contentViewController. Autolayout should be used to restrict the size of the window. The value of the contentViewController is encoded in the NIB. Directly assigning a contentView will clear out the contentViewController.

Source

pub fn setContentViewController( &self, content_view_controller: Option<&NSViewController>, )

Available on crate features NSResponder and NSViewController only.

Setter for contentViewController.

Source

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

Available on crate features NSResponder and NSView only.

Source

pub fn setInitialFirstResponder(&self, initial_first_responder: Option<&NSView>)

Available on crate features NSResponder and NSView only.

Setter for initialFirstResponder.

pub fn recalculateKeyViewLoop(&self)

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

pub fn showsToolbarButton(&self) -> bool

👎Deprecated:

This property has no effect

Available on crate feature NSResponder only.

Source

pub fn setShowsToolbarButton(&self, shows_toolbar_button: bool)

👎Deprecated:

This property has no effect

Available on crate feature NSResponder only.

Setter for showsToolbarButton.

Source

pub fn tabbingMode(&self) -> NSWindowTabbingMode

Available on crate feature NSResponder only.

Get and set the tabbing mode for this window. This should be set before a window is shown. The default value is NSWindowTabbingModeAutomatic.When the value is NSWindowTabbingModeAutomatic,the system will look at the userTabbingPreferenceand automatically tab windows together based on the tabbingIdentifier, when it is appropriate to do so.

Source

pub fn setTabbingMode(&self, tabbing_mode: NSWindowTabbingMode)

Available on crate feature NSResponder only.

Setter for tabbingMode.

Source

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

Available on crate feature NSResponder only.

Windows with the same tabbingIdentifierwill have the ability to be tabbed together when a window is being shown. This allows aggregation of similar windows. By default, the tabbingIdentifierwill be generated based on inherent window properties, such as the window class name, the delegate class name, the window controller class name, and some additional state. Windows can be explicitly made to group together by using the same tabbingIdentifier.

Source

pub fn setTabbingIdentifier(&self, tabbing_identifier: &NSString)

Available on crate feature NSResponder only.

Setter for tabbingIdentifier.

This is copied when set.

Source

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

Available on crate feature NSResponder only.

Actions that can be called to perform various tabbed window behaviors. UI that is hooked up to these items can be automatically validated by calling NSWindow’s validateUserInterfaceItem.

Source

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

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Source

pub fn setAcceptsMouseMovedEvents(&self, accepts_mouse_moved_events: bool)

Available on crate feature NSResponder only.

Setter for acceptsMouseMovedEvents.

Source

pub fn ignoresMouseEvents(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setIgnoresMouseEvents(&self, ignores_mouse_events: bool)

Available on crate feature NSResponder only.

👎Deprecated:

This property does not do anything and should not be used.

Available on crate feature NSResponder only.

Source

pub fn setShowsResizeIndicator(&self, shows_resize_indicator: bool)

👎Deprecated:

This property does not do anything and should not be used.

Available on crate feature NSResponder only.

Setter for showsResizeIndicator.

Source

pub fn windowRef(&self) -> NonNull<c_void>

👎Deprecated:

This method should not be used.

Available on crate feature NSResponder only.

Available on crate feature NSMenu only.

Source

pub unsafe fn setMenu(&self, menu: Option<&NSMenu>)

Available on crate feature NSMenu only.

Setter for menu.

Source

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

§Safety

sender should be of the correct type.

Source

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

§Safety

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

Source

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

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