Struct IKImageBrowserView

Source

pub struct IKImageBrowserView { /* private fields */ }

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Available on crate features IKImageBrowserView and ImageKit only.

Expand description

An IKImageBrowserView object is a view that display and browse images and movies. It supports scrolling and zooming.

The IKImageBrowserView is deprecated. Please switch to NSCollectionView.

Implementations§

Source §

impl IKImageBrowserView

Methods declared on superclass NSView.

Source

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

§Safety

coder possibly has further requirements.

👎Deprecated:

Deprecated - Please use NSCollectionView instead

The receiver’s data source. the data source is not retained by the receiver.

§Safety

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

Source

pub unsafe fn setDataSource(&self, data_source: Option<&AnyObject>)

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Setter for dataSource.

§Safety

data_source should be of the correct type.
data_source might not allow None.
This is unretained, you must ensure the object is kept alive while in use.

Source

pub unsafe fn reloadData(&self)

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Marks the receiver as needing redisplay, so it will reload the data and draw the new values.

Source

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

👎Deprecated:

Deprecated - Please use NSCollectionView instead

The receiver’s delegate. aDelegate is expected to implement the IKImageBrowserDelegate informal protocol.

§Safety

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

Source

pub unsafe fn setDelegate(&self, delegate: Option<&AnyObject>)

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Setter for delegate.

§Safety

delegate should be of the correct type.
delegate might not allow None.
This is unretained, you must ensure the object is kept alive while in use.

Source §

impl IKImageBrowserView

IKAppearance.

Source

pub unsafe fn setCellsStyleMask(&self, mask: NSUInteger)

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Defines the cells appearance style.

Parameter mask: An integer bit mask; see the discussion below.

mask can be specified by combining any of the options below using the C bitwise OR operator

Source

pub unsafe fn cellsStyleMask(&self) -> NSUInteger

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Return the cells appearance style mask.

Source

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

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Sets whether the receiver constraints the cells’s image to their original size. Default is NO.

Source

pub unsafe fn constrainsToOriginalSize(&self) -> bool

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns whether the receiver constraints the cells’s image to their original size.

Source

pub unsafe fn setBackgroundLayer(&self, a_layer: Option<&CALayer>)

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Available on crate feature objc2-quartz-core only.

Specifies the receiver�s background layer.

§Safety

a_layer might not allow None.

Source

pub unsafe fn backgroundLayer(&self) -> Option<Retained<CALayer>>

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Available on crate feature objc2-quartz-core only.

Provides the receiver�s background layer.

Source

pub unsafe fn setForegroundLayer(&self, a_layer: Option<&CALayer>)

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Available on crate feature objc2-quartz-core only.

Specifies the receiver�s foreground layer.

§Safety

a_layer might not allow None.

Source

pub unsafe fn foregroundLayer(&self) -> Option<Retained<CALayer>>

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Available on crate feature objc2-quartz-core only.

Provides the receiver�s foreground layer.

Source

pub unsafe fn newCellForRepresentedItem( &self, an_item: Option<&AnyObject>, ) -> Option<Retained<IKImageBrowserCell>>

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Available on crate feature IKImageBrowserCell only.

Returns the cell to use for the specified item. The returned cell should not be autoreleased.

Parameter The: item that the returned cell will represent.

Subclasses can override this method to customize the appearance of the cell that will represent “anItem”.

§Safety

an_item should be of the correct type.
an_item might not allow None.

Source

pub unsafe fn cellForItemAtIndex( &self, index: NSUInteger, ) -> Option<Retained<IKImageBrowserCell>>

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Available on crate feature IKImageBrowserCell only.

Returns the cell at the specified index.

Subclasses must not override this method.

Source §

impl IKImageBrowserView

IKBrowsing.

Source

pub unsafe fn setZoomValue(&self, a_value: c_float)

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Sets the zoom value to aValue .

This value should be greater or equal to zero and less or equal than one. A zoom value of zero corresponds to the minimum size (40x40 pixels), A zoom value of one means images fit the browser bounds. Other values are interpolated.

Source

pub unsafe fn zoomValue(&self) -> c_float

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns the current zoom value.

Source

pub unsafe fn setContentResizingMask(&self, mask: NSUInteger)

👎Deprecated:

👎Deprecated:

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns the number of rows in the receiver.

Source

pub unsafe fn numberOfColumns(&self) -> NSUInteger

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns the number of columns in the receiver.

Source

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

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Sets whether the receiver can automatically take control of the Quick Look panel.

Parameter flag: if YES, KImageBrowser can take control of the Quick Look panel automatically whenever it becomes first responder. This means that it provides the spacebar key store to open/close Quick Look panel and sets itself as the panel’s datasource and delegate.

default value is NO. IKImageBrowserView’s datasource items should provide file paths or URLs as their representation (see IKImageBrowserItem protocol).

Source

pub unsafe fn canControlQuickLookPanel(&self) -> bool

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns a Boolean value that indicates whether the receiver can automatically take control of the Quick Look panel.

Source §

impl IKImageBrowserView

IKSelectionReorderingAndGrouping.

Source

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

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns the indexes of the selected cells

Source

pub unsafe fn setSelectionIndexes_byExtendingSelection( &self, indexes: Option<&NSIndexSet>, extend_selection: bool, )

👎Deprecated:

Deprecated - Please use NSCollectionView instead

IKDragNDrop.

Source

pub unsafe fn setDraggingDestinationDelegate( &self, delegate: Option<&AnyObject>, )

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Sets the receiver’s dragging destination delegate to delegate .

§Safety

delegate should be of the correct type.
delegate might not allow None.

Source

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

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns the receiver’s dragging destination delegate.

Source

pub unsafe fn indexAtLocationOfDroppedItem(&self) -> NSUInteger

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns the index of the cell where the drop operation occured. This index is valid when a drop occurred and until next drop.

Source

pub unsafe fn dropOperation(&self) -> IKImageBrowserDropOperation

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns the current dropOperation. The returned value is valid when a drop occurred and until next drop.

Returns IKImageBrowserDropOn if the drop occurs on an item. Returns IKImageBrowserDropBefore otherwise. In drag and drop, used to specify a dropOperation. For example, given a browser with N cells (numbered with cell 0 at the top left visually), a cell of N-1 and operation of IKImageBrowserDropOn would specify a drop on the last cell. To specify a drop after the last cell, one would use an index of N and IKImageBrowserDropBefore for the operation.

Source

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

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Controls whether the user can drop on items. Default is NO.

Source

pub unsafe fn allowsDroppingOnItems(&self) -> bool

👎Deprecated:

Deprecated - Please use NSCollectionView instead

Returns YES if the receiver allows the user to drop on items, NO otherwise.

Source

pub unsafe fn setDropIndex_dropOperation( &self, index: NSInteger, operation: IKImageBrowserDropOperation, )

👎Deprecated:

Deprecated - Please use NSCollectionView instead

pub fn setSubviews(&self, subviews: &NSArray<NSView>)

Available on crate feature NSResponder only.

Setter for subviews.

This is copied when set.

Source

pub fn isDescendantOf(&self, view: &NSView) -> bool

Available on crate feature NSResponder only.

Source

pub fn ancestorSharedWithView(&self, view: &NSView) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

Source

pub unsafe fn opaqueAncestor(&self) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

§Safety

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

Source

pub fn isHidden(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setHidden(&self, hidden: bool)

Available on crate feature NSResponder only.

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Available on crate feature NSResponder only.

Source

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

Available on crate feature NSResponder only.

§Safety

rects must be a valid pointer or null.
count must be a valid pointer or null.

Source

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )

Available on crate feature NSResponder only.

§Safety

compare must be implemented correctly.
context must be a valid pointer or null.

Setter for postsFrameChangedNotifications.

Source

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Source

pub fn frame(&self) -> CGRect

Available on crate feature NSResponder only.

Source

pub fn setFrame(&self, frame: CGRect)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Setter for canDrawConcurrently.

Source

pub fn canDraw(&self) -> bool

👎Deprecated:

If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Available on crate feature NSResponder only.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Available on crate feature NSResponder only.

Source

pub fn needsDisplay(&self) -> bool

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

The portion of the view that isn’t clipped by its superviews.

Visibility, as reflected by this property, doesn’t account for whether other view or window objects overlap the current view or whether the current view is installed in a window at all. This value of this property is NSZeroRect if the current view is effectively hidden.

👎Deprecated:

Use NSScrollView to achieve scrolling views.

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated:

Use allowedTouchTypes instead

Available on crate feature NSResponder only.

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Available on crate feature NSResponder only.

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Available on crate feature NSResponder only.

Source

pub fn allowsVibrancy(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn viewDidChangeEffectiveAppearance(&self)

Available on crate feature NSResponder only.

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

pub unsafe fn nextKeyView(&self) -> Option<Retained<NSView>>

Available on crate feature NSResponder only.

§Safety

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

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Source

pub fn setKeyboardFocusRingNeedsDisplayInRect(&self, rect: CGRect)

Available on crate feature NSResponder only.

Source

pub fn focusRingType(&self) -> NSFocusRingType

Available on crate features NSGraphics and NSResponder only.

Source

pub fn setFocusRingType(&self, focus_ring_type: NSFocusRingType)

Available on crate features NSGraphics and NSResponder only.

Available on crate feature NSResponder only.

Source

pub fn discardCursorRects(&self)

Available on crate feature NSResponder only.

Source

pub fn resetCursorRects(&self)

Available on crate feature NSResponder only.

Source

pub unsafe fn addTrackingRect_owner_userData_assumeInside( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, flag: bool, ) -> isize

Available on crate feature NSResponder only.

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Source

pub fn removeTrackingRect(&self, tag: isize)

Available on crate feature NSResponder only.

Source

pub unsafe fn dragImage_at_offset_event_pasteboard_source_slideBack( &self, image: &NSImage, view_location: CGPoint, initial_offset: CGSize, event: &NSEvent, pboard: &NSPasteboard, source_obj: &AnyObject, slide_flag: bool, )

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: instead

Available on crate features NSEvent and NSImage and NSPasteboard and NSResponder only.

§Safety

source_obj should be of the correct type.

Source

pub fn dragFile_fromRect_slideBack_event( &self, filename: &NSString, rect: CGRect, flag: bool, event: &NSEvent, ) -> bool

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: instead

Available on crate features NSEvent and NSResponder only.

Source

pub unsafe fn dragPromisedFilesOfTypes_fromRect_source_slideBack_event( &self, type_array: &NSArray<NSString>, rect: CGRect, source_object: &AnyObject, flag: bool, event: &NSEvent, ) -> bool

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: with an NSFilePromiseProvider instead

Available on crate features NSEvent and NSResponder only.

👎Deprecated:

This has always returned NO and had no effect on macOS

Available on crate feature NSResponder only.

Source

pub fn shouldDrawColor(&self) -> bool

👎Deprecated:

This method no longer does anything

Available on crate feature NSResponder only.

Source

pub fn gState(&self) -> isize

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn allocateGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn setUpGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Source

pub fn renewGState(&self)

👎Deprecated

Available on crate feature NSResponder only.

Methods from Deref<Target = NSResponder>§

Source

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

§Safety

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

Source

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

Setter for nextResponder.

§Safety

This is unretained, you must ensure the object is kept alive while in use.

Source

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

§Safety

action must be a valid selector.
object should be of the correct type.

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:

Source

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

§Safety

event_selector must be a valid selector.

Source

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

Available on crate feature NSEvent only.

Source

Available on crate feature NSEvent only.

Source

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

Available on crate feature NSEvent only.

Source

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

Available on crate feature NSEvent only.

Source

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

Available on crate feature NSEvent only.

Source

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

§Safety

action must be a valid selector.
sender should be of the correct type.

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

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.

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,

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