Struct NSDictionaryController

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

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

Apple’s documentation

Implementations

impl NSDictionaryController

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

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

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

Setter for initialKey.

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

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

Setter for initialValue.

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

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

Setter for includedKeys.

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

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

Setter for excludedKeys.

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

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

Setter for localizedKeyDictionary.

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

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

Setter for localizedKeyTable.

impl NSDictionaryController

Methods declared on superclass NSObjectController.

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

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

impl NSDictionaryController

Methods declared on superclass NSController.

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

impl NSDictionaryController

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSArrayController>

pub unsafe fn rearrangeObjects(&self)

pub unsafe fn automaticallyRearrangesObjects(&self) -> bool

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

Setter for automaticallyRearrangesObjects.

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

pub unsafe fn didChangeArrangementCriteria(&self)

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

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

Setter for sortDescriptors.

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

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

Setter for filterPredicate.

pub unsafe fn clearsFilterPredicateOnInsertion(&self) -> bool

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

Setter for clearsFilterPredicateOnInsertion.

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

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

pub unsafe fn avoidsEmptySelection(&self) -> bool

pub unsafe fn setAvoidsEmptySelection(&self, avoids_empty_selection: bool)

Setter for avoidsEmptySelection.

pub unsafe fn preservesSelection(&self) -> bool

pub unsafe fn setPreservesSelection(&self, preserves_selection: bool)

Setter for preservesSelection.

pub unsafe fn selectsInsertedObjects(&self) -> bool

pub unsafe fn setSelectsInsertedObjects(&self, selects_inserted_objects: bool)

Setter for selectsInsertedObjects.

pub unsafe fn alwaysUsesMultipleValuesMarker(&self) -> bool

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

Setter for alwaysUsesMultipleValuesMarker.

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

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

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

pub unsafe fn selectionIndex(&self) -> NSUInteger

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

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

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

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

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

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

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

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

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

pub unsafe fn canInsert(&self) -> bool

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

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

pub unsafe fn canSelectNext(&self) -> bool

pub unsafe fn canSelectPrevious(&self) -> bool

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

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

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

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

pub unsafe fn removeObjectAtArrangedObjectIndex(&self, index: NSUInteger)

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

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

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

Methods from Deref<Target = NSObjectController>

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

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

Setter for content.

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

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

pub unsafe fn automaticallyPreparesContent(&self) -> bool

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

Setter for automaticallyPreparesContent.

pub unsafe fn prepareContent(&self)

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

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

Setter for objectClass.

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

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

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

pub unsafe fn isEditable(&self) -> bool

pub unsafe fn setEditable(&self, editable: bool)

Setter for isEditable.

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

pub unsafe fn canAdd(&self) -> bool

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

pub unsafe fn canRemove(&self) -> bool

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

Available on crate feature NSUserInterfaceValidation only.

pub unsafe fn managedObjectContext( &self, ) -> Option<Retained<NSManagedObjectContext>>

Available on crate feature objc2-core-data and Apple only.

pub unsafe fn setManagedObjectContext( &self, managed_object_context: Option<&NSManagedObjectContext>, )

Available on crate feature objc2-core-data and Apple only.

Setter for managedObjectContext.

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

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

Setter for entityName.

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

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

Setter for fetchPredicate.

pub unsafe fn fetchWithRequest_merge_error( &self, fetch_request: Option<&NSFetchRequest>, merge: bool, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-core-data and Apple only.

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

pub unsafe fn usesLazyFetching(&self) -> bool

pub unsafe fn setUsesLazyFetching(&self, uses_lazy_fetching: bool)

Setter for usesLazyFetching.

pub unsafe fn defaultFetchRequest(&self) -> Retained<NSFetchRequest>

Available on crate feature objc2-core-data and Apple only.

Methods from Deref<Target = NSController>

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

Available on crate feature NSKeyValueBinding only.

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

Available on crate feature NSKeyValueBinding only.

pub unsafe fn discardEditing(&self)

pub unsafe fn commitEditing(&self) -> bool

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

pub unsafe 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,

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

where Self: Sized + Message,

impl NSEditor for NSDictionaryController

unsafe fn discardEditing(&self)

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

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

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

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

impl NSEditorRegistration for NSDictionaryController

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

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

unsafe 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