Struct NSSearchFieldCell

Source

pub struct NSSearchFieldCell { /* private fields */ }

Available on crate features NSActionCell and NSCell and NSSearchFieldCell and NSTextFieldCell only.

Expand description

Apple’s documentation

Setter for recentSearches.

This is copied when set.

Methods declared on superclass NSCell.

Source

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

Source §

impl NSSearchFieldCell

Methods declared on superclass NSObject.

Source

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

pub fn textColor(&self) -> Option<Retained<NSColor>>

Available on crate feature NSColor only.

Source

pub fn setTextColor(&self, text_color: Option<&NSColor>)

Available on crate feature NSColor only.

Setter for textColor.

This is copied when set.

Source

pub fn setUpFieldEditorAttributes(&self, text_obj: &NSText) -> Retained<NSText>

Available on crate features NSResponder and NSText and NSView only.

Source

pub fn bezelStyle(&self) -> NSTextFieldBezelStyle

Source

pub fn setBezelStyle(&self, bezel_style: NSTextFieldBezelStyle)

Setter for bezelStyle.

Methods from Deref<Target = NSActionCell>§

Source

pub fn target(&self) -> Option<Retained<AnyObject>>

Source

pub unsafe fn setTarget(&self, target: Option<&AnyObject>)

Setter for target.

This is a weak property.

§Safety

target should be of the correct type.

Source

pub fn action(&self) -> Option<Sel>

Source

pub unsafe fn setAction(&self, action: Option<Sel>)

Setter for action.

§Safety

action must be a valid selector.

pub unsafe fn setControlView(&self, control_view: Option<&NSView>)

Available on crate features NSResponder and NSView only.

target should be of the correct type.

Source

Setter for isEnabled.

Available on crate feature NSText only.

Source

pub fn setAlignment(&self, alignment: NSTextAlignment)

Available on crate feature NSText only.

Setter for alignment.

Source

pub fn wraps(&self) -> bool

Source

pub fn setWraps(&self, wraps: bool)

Setter for wraps.

Source

pub fn font(&self) -> Option<Retained<NSFont>>

Available on crate feature NSFont only.

Source

pub fn setFont(&self, font: Option<&NSFont>)

Available on crate feature NSFont only.

Setter for font.

Source

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

Source

pub fn formatter(&self) -> Option<Retained<NSFormatter>>

Source

pub fn setFormatter(&self, formatter: Option<&NSFormatter>)

Setter for stringValue.

This is copied when set.

Source

Available on crate feature NSImage only.

Source

pub fn setImage(&self, image: Option<&NSImage>)

Available on crate feature NSImage only.

Setter for image.

Source

pub fn controlSize(&self) -> NSControlSize

Source

pub fn setControlSize(&self, control_size: NSControlSize)

Setter for controlSize.

Source

pub fn representedObject(&self) -> Option<Retained<AnyObject>>

Source

pub unsafe fn setRepresentedObject( &self, represented_object: Option<&AnyObject>, )

Setter for representedObject.

§Safety

represented_object should be of the correct type.

Available on crate features NSColor and NSResponder and NSView only.

Source

pub fn calcDrawInfo(&self, rect: NSRect)

Source

pub fn setUpFieldEditorAttributes(&self, text_obj: &NSText) -> Retained<NSText>

Available on crate features NSResponder and NSText and NSView only.

Source

Available on crate features NSEvent and NSMenu and NSResponder and NSView only.

Source

pub fn sendsActionOnEndEditing(&self) -> bool

Source

pub fn setSendsActionOnEndEditing(&self, sends_action_on_end_editing: bool)

Setter for sendsActionOnEndEditing.

Source

pub fn baseWritingDirection(&self) -> NSWritingDirection

Available on crate feature NSText only.

Source

pub fn setBaseWritingDirection( &self, base_writing_direction: NSWritingDirection, )

Available on crate feature NSText only.

Setter for baseWritingDirection.

Source

pub fn lineBreakMode(&self) -> NSLineBreakMode

Available on crate feature NSParagraphStyle only.

Source

pub fn setLineBreakMode(&self, line_break_mode: NSLineBreakMode)

Available on crate feature NSParagraphStyle only.

pub fn setUserInterfaceLayoutDirection( &self, user_interface_layout_direction: NSUserInterfaceLayoutDirection, )

Available on crate feature NSUserInterfaceLayout only.

Setter for userInterfaceLayoutDirection.

Source

pub fn fieldEditorForView( &self, control_view: &NSView, ) -> Option<Retained<NSTextView>>

Available on crate features NSResponder and NSText and NSTextView and NSView only.

Source

pub fn usesSingleLineMode(&self) -> bool

Source

pub fn setUsesSingleLineMode(&self, uses_single_line_mode: bool)

Setter for usesSingleLineMode.

Source

pub fn draggingImageComponentsWithFrame_inView( &self, frame: NSRect, view: &NSView, ) -> Retained<NSArray<NSDraggingImageComponent>>

Available on crate features NSDraggingItem and NSResponder and NSView only.

Source

Source

pub fn hitTestForEvent_inRect_ofView( &self, event: &NSEvent, cell_frame: NSRect, control_view: &NSView, ) -> NSCellHitResult

Available on crate features NSEvent and NSResponder and NSView only.

Source

pub fn expansionFrameWithFrame_inView( &self, cell_frame: NSRect, view: &NSView, ) -> NSRect

Available on crate features NSResponder and NSView only.

👎Deprecated: The controlTint property is not respected on 10.14 and later. For custom cells, use +[NSColor controlAccentColor] to respect the user’s preferred accent color when drawing.

👎Deprecated

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

Available on crate feature NSAccessibilityConstants only.

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.

Available on crate feature NSAccessibilityConstants only.

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,

Available on crate feature NSAccessibilityConstants only.

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