Struct NSDictionaryController 

pub struct NSDictionaryController { /* private fields */ }

Available on crate features NSArrayController and NSController and NSDictionaryController and NSObjectController only.

Apple’s documentation

Implementations

impl NSDictionaryController

pub fn newObject(&self) -> Retained<NSDictionaryControllerKeyValuePair>

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

pub fn setInitialKey(&self, initial_key: &NSString)

Setter for initialKey.

This is copied when set.

pub fn initialValue(&self) -> Retained<AnyObject>

pub unsafe fn setInitialValue(&self, initial_value: &AnyObject)

Setter for initialValue.

Safety

initial_value should be of the correct type.

pub fn includedKeys(&self) -> Retained<NSArray<NSString>>

pub fn setIncludedKeys(&self, included_keys: &NSArray<NSString>)

Setter for includedKeys.

This is copied when set.

pub fn excludedKeys(&self) -> Retained<NSArray<NSString>>

pub fn setExcludedKeys(&self, excluded_keys: &NSArray<NSString>)

Setter for excludedKeys.

This is copied when set.

pub fn localizedKeyDictionary( &self, ) -> Retained<NSDictionary<NSString, NSString>>

pub fn setLocalizedKeyDictionary( &self, localized_key_dictionary: &NSDictionary<NSString, NSString>, )

Setter for localizedKeyDictionary.

This is copied when set.

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

pub fn setLocalizedKeyTable(&self, localized_key_table: Option<&NSString>)

Setter for localizedKeyTable.

This is copied when set.

impl NSDictionaryController

Methods declared on superclass NSObjectController.

pub unsafe fn initWithContent( this: Allocated<Self>, content: Option<&AnyObject>, ) -> Retained<Self>

Safety

content should be of the correct type.

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

Safety

coder possibly has further requirements.

impl NSDictionaryController

Methods declared on superclass NSController.

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

impl NSDictionaryController

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSArrayController>

pub fn rearrangeObjects(&self)

pub fn automaticallyRearrangesObjects(&self) -> bool

pub fn setAutomaticallyRearrangesObjects( &self, automatically_rearranges_objects: bool, )

Setter for automaticallyRearrangesObjects.

pub fn automaticRearrangementKeyPaths( &self, ) -> Option<Retained<NSArray<NSString>>>

pub fn didChangeArrangementCriteria(&self)

pub fn sortDescriptors(&self) -> Retained<NSArray<NSSortDescriptor>>

pub fn setSortDescriptors(&self, sort_descriptors: &NSArray<NSSortDescriptor>)

Setter for sortDescriptors.

This is copied when set.

pub fn filterPredicate(&self) -> Option<Retained<NSPredicate>>

pub fn setFilterPredicate(&self, filter_predicate: Option<&NSPredicate>)

Setter for filterPredicate.

pub fn clearsFilterPredicateOnInsertion(&self) -> bool

pub fn setClearsFilterPredicateOnInsertion( &self, clears_filter_predicate_on_insertion: bool, )

Setter for clearsFilterPredicateOnInsertion.

pub unsafe fn arrangeObjects(&self, objects: &NSArray) -> Retained<NSArray>

Safety

objects generic should be of the correct type.

pub fn arrangedObjects(&self) -> Retained<AnyObject>

pub fn avoidsEmptySelection(&self) -> bool

pub fn setAvoidsEmptySelection(&self, avoids_empty_selection: bool)

Setter for avoidsEmptySelection.

pub fn preservesSelection(&self) -> bool

pub fn setPreservesSelection(&self, preserves_selection: bool)

Setter for preservesSelection.

pub fn selectsInsertedObjects(&self) -> bool

pub fn setSelectsInsertedObjects(&self, selects_inserted_objects: bool)

Setter for selectsInsertedObjects.

pub fn alwaysUsesMultipleValuesMarker(&self) -> bool

pub fn setAlwaysUsesMultipleValuesMarker( &self, always_uses_multiple_values_marker: bool, )

Setter for alwaysUsesMultipleValuesMarker.

pub fn setSelectionIndexes(&self, indexes: &NSIndexSet) -> bool

pub fn selectionIndexes(&self) -> Retained<NSIndexSet>

pub fn setSelectionIndex(&self, index: NSUInteger) -> bool

pub fn selectionIndex(&self) -> NSUInteger

pub fn addSelectionIndexes(&self, indexes: &NSIndexSet) -> bool

pub fn removeSelectionIndexes(&self, indexes: &NSIndexSet) -> bool

pub unsafe fn setSelectedObjects(&self, objects: &NSArray) -> bool

Safety

objects generic should be of the correct type.

pub fn selectedObjects(&self) -> Retained<NSArray>

pub unsafe fn addSelectedObjects(&self, objects: &NSArray) -> bool

Safety

objects generic should be of the correct type.

pub unsafe fn removeSelectedObjects(&self, objects: &NSArray) -> bool

Safety

objects generic should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

pub fn canInsert(&self) -> bool

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

pub fn canSelectNext(&self) -> bool

pub fn canSelectPrevious(&self) -> bool

pub unsafe fn addObject(&self, object: &AnyObject)

Safety

object should be of the correct type.

pub unsafe fn addObjects(&self, objects: &NSArray)

Safety

objects generic should be of the correct type.

pub unsafe fn insertObject_atArrangedObjectIndex( &self, object: &AnyObject, index: NSUInteger, )

Safety

object should be of the correct type.

pub unsafe fn insertObjects_atArrangedObjectIndexes( &self, objects: &NSArray, indexes: &NSIndexSet, )

Safety

objects generic should be of the correct type.

pub fn removeObjectAtArrangedObjectIndex(&self, index: NSUInteger)

pub fn removeObjectsAtArrangedObjectIndexes(&self, indexes: &NSIndexSet)

pub unsafe fn removeObject(&self, object: &AnyObject)

Safety

object should be of the correct type.

pub unsafe fn removeObjects(&self, objects: &NSArray)

Safety

objects generic should be of the correct type.

Methods from Deref<Target = NSObjectController>

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

pub unsafe fn setContent(&self, content: Option<&AnyObject>)

Setter for content.

Safety

content should be of the correct type.

pub fn selection(&self) -> Retained<AnyObject>

pub fn selectedObjects(&self) -> Retained<NSArray>

pub fn automaticallyPreparesContent(&self) -> bool

pub fn setAutomaticallyPreparesContent( &self, automatically_prepares_content: bool, )

Setter for automaticallyPreparesContent.

pub fn prepareContent(&self)

pub unsafe fn objectClass(&self) -> Option<&'static AnyClass>

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setObjectClass(&self, object_class: Option<&AnyClass>)

Setter for objectClass.

Safety

• object_class probably has further requirements.
• object_class might not allow None.
• This is unretained, you must ensure the object is kept alive while in use.

pub fn newObject(&self) -> Retained<AnyObject>

pub unsafe fn addObject(&self, object: &AnyObject)

Safety

object should be of the correct type.

pub unsafe fn removeObject(&self, object: &AnyObject)

Safety

object should be of the correct type.

pub fn isEditable(&self) -> bool

pub fn setEditable(&self, editable: bool)

Setter for isEditable.

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

Safety

sender should be of the correct type.

pub fn canAdd(&self) -> bool

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

Safety

sender should be of the correct type.

pub fn canRemove(&self) -> bool

pub fn validateUserInterfaceItem( &self, item: &ProtocolObject<dyn NSValidatedUserInterfaceItem>, ) -> bool

Available on crate feature NSUserInterfaceValidation only.

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

pub fn setEntityName(&self, entity_name: Option<&NSString>)

Setter for entityName.

This is copied when set.

pub fn fetchPredicate(&self) -> Option<Retained<NSPredicate>>

pub fn setFetchPredicate(&self, fetch_predicate: Option<&NSPredicate>)

Setter for fetchPredicate.

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

Safety

sender should be of the correct type.

pub fn usesLazyFetching(&self) -> bool

pub fn setUsesLazyFetching(&self, uses_lazy_fetching: bool)

Setter for usesLazyFetching.

Methods from Deref<Target = NSController>

pub fn objectDidBeginEditing(&self, editor: &ProtocolObject<dyn NSEditor>)

Available on crate feature NSKeyValueBinding only.

pub fn objectDidEndEditing(&self, editor: &ProtocolObject<dyn NSEditor>)

Available on crate feature NSKeyValueBinding only.

pub fn discardEditing(&self)

pub fn commitEditing(&self) -> bool

pub unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

Safety

• delegate should be of the correct type.
• did_commit_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn isEditing(&self) -> bool

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

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

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.

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

Trait Implementations

impl AsRef<AnyObject> for NSDictionaryController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSArrayController> for NSDictionaryController

fn as_ref(&self) -> &NSArrayController

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

impl AsRef<NSController> for NSDictionaryController

fn as_ref(&self) -> &NSController

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

impl AsRef<NSDictionaryController> for NSDictionaryController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSDictionaryController

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObjectController> for NSDictionaryController

fn as_ref(&self) -> &NSObjectController

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

impl Borrow<AnyObject> for NSDictionaryController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSArrayController> for NSDictionaryController

fn borrow(&self) -> &NSArrayController

Immutably borrows from an owned value.

impl Borrow<NSController> for NSDictionaryController

fn borrow(&self) -> &NSController

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSDictionaryController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObjectController> for NSDictionaryController

fn borrow(&self) -> &NSObjectController

Immutably borrows from an owned value.

impl ClassType for NSDictionaryController

const NAME: &'static str = "NSDictionaryController"

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

type Super = NSArrayController

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 NSDictionaryController

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

Formats the value using the given formatter.

impl Deref for NSDictionaryController

type Target = NSArrayController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSDictionaryController

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 NSDictionaryController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSDictionaryController

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSEditor for NSDictionaryController

fn discardEditing(&self)

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

fn commitEditing(&self) -> bool

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

Safety

fn commitEditingAndReturnError(&self) -> Result<(), Retained<NSError>>

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

impl NSEditorRegistration for NSDictionaryController

fn objectDidBeginEditing(&self, editor: &ProtocolObject<dyn NSEditor>)

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

fn objectDidEndEditing(&self, editor: &ProtocolObject<dyn NSEditor>)

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

impl NSObjectProtocol for NSDictionaryController

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 NSDictionaryController

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 NSDictionaryController

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

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

impl DowncastTarget for NSDictionaryController

impl Eq for NSDictionaryController