Struct IMKCandidates

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

Available on crate features IMKCandidates and objc2-app-kit only.

Apple’s documentation

Implementations

impl IMKCandidates

pub unsafe fn initWithServer_panelType( this: Allocated<Self>, server: Option<&IMKServer>, panel_type: IMKCandidatePanelType, ) -> Option<Retained<Self>>

Available on crate feature IMKServer only.

Default initializer for the class.

When an input method allocates an IMKCandidate object it should initialize that object by calling this method passing the IMKServer that will manage the candidates and the initial panel type.

pub unsafe fn initWithServer_panelType_styleType( this: Allocated<Self>, server: Option<&IMKServer>, panel_type: IMKCandidatePanelType, style: IMKStyleType, ) -> Option<Retained<Self>>

Available on crate feature IMKServer only.

pub unsafe fn panelType(&self) -> IMKCandidatePanelType

Return the panel type.

pub unsafe fn setPanelType(&self, panel_type: IMKCandidatePanelType)

Change the panel type.

pub unsafe fn show(&self, location_hint: IMKCandidatesLocationHint)

If a candidate window type has been provided, show the candidate window. The caller provides a location hint that is used to position the window.

Input methods call this method when it is appropriate, during text conversion, to display a list of candidates.

pub unsafe fn hide(&self)

If the candidate window is visible, hide it.

pub unsafe fn isVisible(&self) -> bool

Utility method returns YES if a candidate display is visible.

pub unsafe fn updateCandidates(&self)

Call this method to update the candidates displayed in the candidate window.

Calling this method will result in a call being made to the IMKInputController’s candidates method. Note that the candidate list will be updated, but the window’s visible state will not change; that is to say, if the window is hidden it will remain hidden, and vice versa.

pub unsafe fn showAnnotation( &self, annotation_string: Option<&NSAttributedString>, )

Displays an annotation window whose contents are the annotationString.

An annotation is additional text that explains or somehow adds to the candidate string in a candidate window. Annotations are displayed in a small borderless window that is aligned with the current candidate panel. An input method calls showAnnotation: when the method [IMKInputController candidateSelectionChanged:] is called, and the candidateString has annotations.

pub unsafe fn showSublist_subListDelegate( &self, candidates: Option<&NSArray>, delegate: Option<&AnyObject>, )

pub unsafe fn candidateFrame(&self) -> NSRect

pub unsafe fn setSelectionKeys(&self, key_codes: Option<&NSArray>)

Set the selection keys for the candidates.

Selection keys are an array of NSNumbers where each NSNumber is a virtual key code that the controller will map to characters that are displayed either across the top of the candidates, if the candidates are laid out horizontally, or along the left edge of the candidates, if they are aligned vertically.

The number of selection keys determines how many candidates are displayed per page. For example, if you passed an array of 4 key codes, then 4 candidates are displayed per page. If you passed 11 key codes, then 11 candidates would be displayed.

By default the key codes are mapped using the keyboard layout whose source id is com.apple.keylayout.US. The default layout can be replaced by calling setSelectionKeysKeylayout (see below).

The default selection keys are the digits 1 through 9, or in terms of key codes: 18-21,23,22, 26, 28, 25.

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

Returns an NSArray of NSNumbers where each NSNumber is a virtual key code.

The NSArray is an autoreleased object. Do not release unless it is first retained.

pub unsafe fn setAttributes(&self, attributes: Option<&NSDictionary>)

Sets the “style” attributes for the candidates window. The keys for the attributes dictionary and the values are:

NSFontAttributeName (value = NSFont) Setting the font attribute sets the font that is used to draw Candidates. It does not effect the selection keys which are always drawn in the same font. Note that to set the font size you should use this key/value pair.

IMKCandidatesOpacityAttributeName (value = NSNumber with a float value between 0 and 1). Sets the opacity level to transparent (0.0) to completely opaque (1.0). The default opacity is 1.0. This constant is declared above.

NSForegroundColorAttributeName (value = NSColor) Sets the text color used for the candidate text. By default it is black.

NSBackgroundColorDocumentAttribute (value = NSColor). Set the background color that is drawn behind the candidate text.

IMKCandidatesSendServerKeyEventFirst (value = NSNumber). NO (default) gives the candidate window first chance at key events. YES causes events to first be routed to the current IMKInputController. In that case, if the event is not handled, it will then be sent to the candidate window.

pub unsafe fn attributes(&self) -> Option<Retained<NSDictionary>>

Returns the attributes dictionary.

pub unsafe fn setDismissesAutomatically(&self, flag: bool)

Setting the dismissesAutomatically flag determines what happens to displayed candidates when the return key or enter key is typed.

By default, if a return or enter key is typed, the candidates are dismissed and a candidateSelected: message is sent to the input controller. However if setDismissesAutomatically is passed a NO flag the candidate display will not be dismissed when a return or enter key is typed. The input controller will still be sent the candidatesSelected: message, but, as stated, the candidates display will not be dismissed.

Setting this flag to NO lets an input method process text input while keeping a dynamically changing candidates display in view throughout the text input process.

When you set this to NO the candidate display will still be hidden when when a session deactivates.

pub unsafe fn dismissesAutomatically(&self) -> bool

Returns the dismissesAutomatically flag.

pub unsafe fn selectedCandidate(&self) -> NSInteger

Returns the currently selected candidate identifer.

Attempts to determine the identifier for the selected candidate. If there is no selection the return value will be NSNotFound.

pub unsafe fn setCandidateFrameTopLeft(&self, point: NSPoint)

Positions the top-left corner of the candidate window’s frame rectangle at a given point in screen coordinates.

pub unsafe fn showChild(&self)

If the current selection has a child IMKCandidates object that will be shown.

If there is a failure in showing the child this method will throw an exception.

pub unsafe fn hideChild(&self)

If the current selection has a child IMKCandidates that is being shown hide it.

Typically a client will not need to call this as IMKCandidates automatically hides and shows children.

pub unsafe fn attachChild_toCandidate_type( &self, child: Option<&IMKCandidates>, candidate_identifier: NSInteger, the_type: IMKStyleType, )

Attach an IMKCandidates object to the specified selection.

The IMKCandidate can be a sublist or an annotation.

pub unsafe fn detachChild(&self, candidate_identifier: NSInteger)

Detach the IMKCandidates object attached to candidate

pub unsafe fn setCandidateData(&self, candidates_array: Option<&NSArray>)

Set the candidates data directly rather than supplying data via [IMKInputContoller candidates:].

The elements of the array can be strings or attributed strings.

pub unsafe fn selectCandidateWithIdentifier( &self, candidate_identifier: NSInteger, ) -> bool

Select the candidate whose identifier matches the identifier parameter.

Returns: YES if the candidateIdentifier is valid an the selection was made. NO if canidateIdentifier is invalid or it was not possible make the selection.

Parameter An: identifier for a candidate. You can obtain an identifier by mapping a candidate to an identifier via the [IMKCandidates candidateStringIdentifier:].

pub unsafe fn selectCandidate(&self, candidate_identifier: NSInteger)

pub unsafe fn showCandidates(&self)

Show the candidate window.

This simply shows the candidates. No effort is made to position the candidate. The caller should move the candidate window to an appropriate location prior to showing.

pub unsafe fn candidateStringIdentifier( &self, candidate_string: Option<&AnyObject>, ) -> NSInteger

Map a candidateString to an identifier.

Beginning with MacOS 10.7, candidate strings are mapped internally to an unique identifier of type NSInteger. Using identifiers to identify a particular candidate is the first stage of enabling data types other than NSString and NSAttributedString for containing the contents of a candidate.

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

Returns the currently selected candidate string.

Attempts to determine the string for the selected candidate. If there is no selection the return value can be nil. The attributed string is an autoreleased object.

pub unsafe fn candidateIdentifierAtLineNumber( &self, line_number: NSInteger, ) -> NSInteger

Returns the candidate identifier for a given line in the candidate window display.

Maps the lineNumber to a candidate identifier. Line number 0 corresponds to the candidate in the cell currently in the first (top for vertical) line of the candidate window. This is convienient for input methods that support selecting a candidate by a number key. Line Number values depend on the column arrangement of your candidate. If you are displaying a single column candidate window, lines that have been scrolled out of view will have negative values. For a single row grid line, numbers will correspond to the cell’s position in the row (i.e. the first cell will be 0, the second 1, etc). Finally, for a grid, the line numbers correspond to the grid row. If the line number is invalid, NSNotFound is returned.

Parameter lineNumber: a number representing a cells position in the candidate window.

pub unsafe fn lineNumberForCandidateWithIdentifier( &self, candidate_identifier: NSInteger, ) -> NSInteger

Returns the line number for a given CandidateID.

Returns: The line number. NSNotFound if the candidateID is invalid.

Parameter candidateIdentifier: - A valid identifier for a candidate.

If the cell that contains the candidate is at the top line of the candidate window, the return value will be 0.

pub unsafe fn clearSelection(&self)

Clears the current selection.

impl IMKCandidates

Methods declared on superclass NSResponder.

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

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

impl IMKCandidates

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSResponder>

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

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

Setter for nextResponder.

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

pub unsafe fn performKeyEquivalent(&self, event: &NSEvent) -> bool

pub unsafe fn mouseDown(&self, event: &NSEvent)

pub unsafe fn rightMouseDown(&self, event: &NSEvent)

pub unsafe fn otherMouseDown(&self, event: &NSEvent)

pub unsafe fn mouseUp(&self, event: &NSEvent)

pub unsafe fn rightMouseUp(&self, event: &NSEvent)

pub unsafe fn otherMouseUp(&self, event: &NSEvent)

pub unsafe fn mouseMoved(&self, event: &NSEvent)

pub unsafe fn mouseDragged(&self, event: &NSEvent)

pub unsafe fn scrollWheel(&self, event: &NSEvent)

pub unsafe fn rightMouseDragged(&self, event: &NSEvent)

pub unsafe fn otherMouseDragged(&self, event: &NSEvent)

pub unsafe fn mouseEntered(&self, event: &NSEvent)

pub unsafe fn mouseExited(&self, event: &NSEvent)

pub unsafe fn keyDown(&self, event: &NSEvent)

pub unsafe fn keyUp(&self, event: &NSEvent)

pub unsafe fn flagsChanged(&self, event: &NSEvent)

pub unsafe fn tabletPoint(&self, event: &NSEvent)

pub unsafe fn tabletProximity(&self, event: &NSEvent)

pub unsafe fn cursorUpdate(&self, event: &NSEvent)

pub unsafe fn magnifyWithEvent(&self, event: &NSEvent)

pub unsafe fn rotateWithEvent(&self, event: &NSEvent)

pub unsafe fn swipeWithEvent(&self, event: &NSEvent)

pub unsafe fn beginGestureWithEvent(&self, event: &NSEvent)

pub unsafe fn endGestureWithEvent(&self, event: &NSEvent)

pub unsafe fn smartMagnifyWithEvent(&self, event: &NSEvent)

pub unsafe fn changeModeWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesBeganWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesMovedWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesEndedWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesCancelledWithEvent(&self, event: &NSEvent)

pub unsafe fn quickLookWithEvent(&self, event: &NSEvent)

pub unsafe fn pressureChangeWithEvent(&self, event: &NSEvent)

pub unsafe fn contextMenuKeyDown(&self, event: &NSEvent)

Handle a key event that should present a context menu at the user focus.

Most applications should not override this method. Instead, you should customize the context menu displayed from a keyboard event by implementing menuForEvent: and selectionAnchorRect, or showContextMenuForSelection:, rather than this method.

You should only override this method when you do not want the system-provided default behavior for the context menu hotkey, either for a specific key combination, or for the hotkey in general. For example, if your application already provides a different behavior for control-Return (the default context menu hotkey definition), and you want to preserve that behavior, you should override this method to handle that specific key combination, and then return without calling super. Note that the user may customize the hotkey to a different key combination, so in this example, if any other key combination is passed to your method, you would call super.

An implementation of this method should call [super contextMenuKeyDown:event] to pass the request up the responder chain. If the message reaches the application object, NSApplication’s implementation of this method will send showContextMenuForSelection: to the responder chain. If you do not call super, then no further handling of the key event will be performed.

Note: In some cases, showContextMenuForSelection: will be called without a prior call to contextMenuKeyDown:. This occurs when a view receives an Accessibility ShowMenu action, or when the user has created a Cocoa Text key binding to map a different key combination to the showContextMenuForSelection: action.

Parameter event: The key down event that matches the system-wide context menu hotkey combination.

See also: showContextMenuForSelection:

pub unsafe fn noResponderFor(&self, event_selector: Sel)

pub unsafe fn acceptsFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn interpretKeyEvents(&self, event_array: &NSArray<NSEvent>)

pub unsafe fn flushBufferedKeyEvents(&self)

pub unsafe fn menu(&self) -> Option<Retained<NSMenu>>

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

Setter for menu.

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

pub unsafe fn helpRequested(&self, event_ptr: &NSEvent)

pub unsafe fn shouldBeTreatedAsInkEvent(&self, event: &NSEvent) -> bool

pub unsafe fn wantsScrollEventsForSwipeTrackingOnAxis( &self, axis: NSEventGestureAxis, ) -> bool

pub unsafe fn wantsForwardedScrollEventsForAxis( &self, axis: NSEventGestureAxis, ) -> bool

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

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

pub unsafe fn validateProposedFirstResponder_forEvent( &self, responder: &NSResponder, event: Option<&NSEvent>, ) -> bool

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

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

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

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

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

pub unsafe fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

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 IMKCandidates

fn as_ref(&self) -> &AnyObject

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

impl AsRef<IMKCandidates> for IMKCandidates

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for IMKCandidates

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for IMKCandidates

fn as_ref(&self) -> &NSResponder

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

impl Borrow<AnyObject> for IMKCandidates

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for IMKCandidates

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for IMKCandidates

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl ClassType for IMKCandidates

const NAME: &'static str = "IMKCandidates"

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

type Super = NSResponder

The superclass of this class.

type ThreadKind = <<IMKCandidates 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 IMKCandidates

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

Formats the value using the given formatter.

impl Deref for IMKCandidates

type Target = NSResponder

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for IMKCandidates

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 IMKCandidates

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for IMKCandidates

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 IMKCandidates

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 PartialEq for IMKCandidates

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 IMKCandidates

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

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

impl DowncastTarget for IMKCandidates

impl Eq for IMKCandidates