Struct objc2_input_method_kit::IMKCandidates

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

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

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.

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

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

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

pub unsafe fn hide(&self)

pub unsafe fn isVisible(&self) -> bool

pub unsafe fn updateCandidates(&self)

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

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

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

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

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

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

pub unsafe fn dismissesAutomatically(&self) -> bool

pub unsafe fn selectedCandidate(&self) -> NSInteger

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

pub unsafe fn showChild(&self)

pub unsafe fn hideChild(&self)

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

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

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

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

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

pub unsafe fn showCandidates(&self)

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

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

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

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

pub unsafe fn clearSelection(&self)

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

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

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

pub unsafe fn flushBufferedKeyEvents(&self)

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

Available on crate feature NSMenu only.

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

Available on crate feature NSMenu only.

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

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for IMKCandidates

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<IMKCandidates> for IMKCandidates

fn as_mut(&mut self) -> &mut Self

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

impl AsMut<NSObject> for IMKCandidates

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<NSResponder> for IMKCandidates

fn as_mut(&mut self) -> &mut NSResponder

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

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 BorrowMut<AnyObject> for IMKCandidates

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for IMKCandidates

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl BorrowMut<NSResponder> for IMKCandidates

fn borrow_mut(&mut self) -> &mut NSResponder

Mutably borrows from an owned value.

impl ClassType for IMKCandidates

type Super = NSResponder

The superclass of this class.

type Mutability = MainThreadOnly

Whether the type is mutable or immutable.

const NAME: &'static str = "IMKCandidates"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

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

fn deref_mut(&mut self) -> &mut Self::Target

Mutably 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 NSCoding for IMKCandidates

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for IMKCandidates

fn isEqual(&self, other: &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,

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: &IMKCandidates) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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 Eq for IMKCandidates

impl Message for IMKCandidates

impl StructuralPartialEq for IMKCandidates