#import <CPCollectionView.h>
Additional Inherited Members | |
Class Methods inherited from CPView | |
(Class) | + animatorClass |
(CAAnimation) | + defaultAnimationForKey: |
(CPMenu) | + defaultMenu |
(CPString) | + defaultThemeClass |
(void) | + initialize |
(BOOL) | + isHighDPIDrawingEnabled |
(CPSet) | + keyPathsForValuesAffectingBounds |
(CPSet) | + keyPathsForValuesAffectingFrame |
(void) | + setHighDPIDrawingEnabled: |
(CPDictionary) | + themeAttributes |
This class displays an array as a grid of objects, where each object is represented by a view. The view is controlled by creating a CPCollectionViewItem and specifying its view, then setting that item as the collection view prototype.
- (void)collectionView:(CPCollectionView)collectionView didDoubleClickOnItemAtIndex:(int)index; Called when the user double-clicks on an item in the collection view.
collectionView | the collection view that received the double-click |
index | the index of the item that received the double-click |
- (CPData)collectionView:(CPCollectionView)collectionView dataForItemsAtIndexes:(CPIndexSet)indices forType:(CPString)aType; Invoked to obtain data for a set of indices.
collectionView | the collection view to obtain data for |
indices | the indices to return data for |
aType | the data type |
- (CPArray)collectionView:(CPCollectionView)collectionView dragTypesForItemsAtIndexes:(CPIndexSet)indices; Invoked to obtain the data types supported by the specified indices for placement on the pasteboard.
collectionView | the collection view the items reside in |
indices | the indices to obtain drag types |
Definition at line 2 of file CPCollectionView.h.
|
implementation |
Returns YES
by default.
Definition at line 321 of file CPCollectionView.j.
|
implementation |
Returns YES
if the user can select no items, NO
otherwise.
Definition at line 406 of file CPCollectionView.j.
|
implementation |
Returns YES
if the user can select multiple items, NO
otherwise.
Definition at line 423 of file CPCollectionView.j.
|
implementation |
Definition at line 795 of file CPCollectionView.j.
|
implementation |
Returns the collection view content array
Definition at line 356 of file CPCollectionView.j.
|
implementation |
Returns the collection view's delegate
Definition at line 896 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1335 of file CPCollectionView.j.
|
implementation |
Definition at line 604 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 1116 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 1059 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 1111 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 1074 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 1047 of file CPCollectionView.j.
|
implementation |
Archives the view to a coder.
aCoder | the object into which the view's data will be archived. |
Reimplemented from CPView.
Provided by category CPCollectionView(CPCoding).
Definition at line 1562 of file CPCollectionView.j.
|
implementation |
Definition at line 935 of file CPCollectionView.j.
|
implementation |
Definition at line 940 of file CPCollectionView.j.
|
implementation |
Initializes the view from an archive.
aCoder | the coder from which to initialize |
Reimplemented from CPView.
Provided by category CPCollectionView(CPCoding).
Definition at line 1537 of file CPCollectionView.j.
|
implementation |
Initializes the receiver for usage with the specified bounding rectangle
Reimplemented from CPView.
Definition at line 138 of file CPCollectionView.j.
|
implementation |
Returns whether the receiver is currently the first responder.
Definition at line 329 of file CPCollectionView.j.
|
implementation |
Returns YES
if the collection view is selectable, and NO
otherwise.
Definition at line 389 of file CPCollectionView.j.
|
implementation |
Definition at line 930 of file CPCollectionView.j.
|
implementation |
Returns the current item prototype
Definition at line 292 of file CPCollectionView.j.
|
implementation |
Returns the collection view items.
Definition at line 364 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1350 of file CPCollectionView.j.
|
implementation |
Returns the current maximum item size.
Definition at line 771 of file CPCollectionView.j.
|
implementation |
Returns the maximum number of columns
Definition at line 701 of file CPCollectionView.j.
|
implementation |
Returns the maximum number of rows.
Definition at line 679 of file CPCollectionView.j.
Reimplemented from CPView.
Definition at line 904 of file CPCollectionView.j.
|
implementation |
Returns the current minimum item size
Definition at line 746 of file CPCollectionView.j.
|
implementation |
Reimplemented from CPView.
Definition at line 806 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 998 of file CPCollectionView.j.
|
implementation |
Definition at line 800 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1307 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1312 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1279 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1288 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1297 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1302 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1317 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1326 of file CPCollectionView.j.
|
implementation |
Returns a collection view item for anObject
.
anObject | the object to be represented. |
Definition at line 301 of file CPCollectionView.j.
|
implementation |
Returns the current number of columns
Definition at line 718 of file CPCollectionView.j.
|
implementation |
Returns the current number of rows
Definition at line 709 of file CPCollectionView.j.
|
implementation |
Places the selected items on the specified pasteboard. The items are requested from the collection's delegate.
aPasteboard | the pasteboard to put the items on |
aType | the format the pasteboard data |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 982 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(DragAndDrop).
Definition at line 1132 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(Deprecated).
Definition at line 1365 of file CPCollectionView.j.
|
implementation |
Provided by category CPCollectionView(Deprecated).
Definition at line 1374 of file CPCollectionView.j.
|
implementation |
Definition at line 458 of file CPCollectionView.j.
|
implementation |
Initiates -superviewSizeChanged
: messages to subviews.
aSize | the size for the subviews |
Reimplemented from CPView.
Definition at line 502 of file CPCollectionView.j.
|
implementation |
Notifies subviews that the superview changed size.
aSize | the size of the old superview |
Reimplemented from CPView.
Definition at line 507 of file CPCollectionView.j.
|
implementation |
Returns a set of the selected indices.
Definition at line 453 of file CPCollectionView.j.
|
implementation |
Sets whether the user may have no items selected. If YES, mouse clicks not on any item will empty the current selection. The first item will also start off as selected.
shouldAllowMultipleSelection | YES allows the user to select multiple items |
Definition at line 398 of file CPCollectionView.j.
|
implementation |
Sets whether the user can select multiple items.
shouldAllowMultipleSelection | YES allows the user to select multiple items |
Definition at line 415 of file CPCollectionView.j.
|
implementation |
Determines automatic resizing behavior.
aMask | a bit mask with options |
Reimplemented from CPView.
Provided by category CPCollectionView(KeyboardInteraction).
Definition at line 1355 of file CPCollectionView.j.
|
implementation |
Definition at line 776 of file CPCollectionView.j.
|
implementation |
Sets the content of the collection view to the content in anArray
. This array can be of any type, and each element will be passed to the -setRepresentedObject
: method. It's the responsibility of your custom collection view item to interpret the object.
If the new content array is smaller than the previous one, note that [receiver selectionIndexes] may refer to out of range indices. selectionIndexes
is not changed as a result of calling the setContent:
method.
anArray | a content array |
Definition at line 346 of file CPCollectionView.j.
|
implementation |
Set the delegate of the receiver
aDelegate | the delegate object for the collectionView. |
Definition at line 199 of file CPCollectionView.j.
|
implementation |
Sets the item prototype to anItem
anItem | the new item prototype. @note - If anItem is located in an external cib file, representedObject, outlets, and bindings will be automatically restored when an item is created. - If anItem and its view belong to the same cib as the collection view, the item prototype should implement the CPCoding protocol because the item is copied by archiving and unarchiving the prototypal view. @note Bindings won't be restored through archiving, instead you need to subclass the -representedObject: method and update the view there. @par Example: |
Definition at line 279 of file CPCollectionView.j.
|
implementation |
Sets the maximum item size.
aSize | the new maximum item size |
Definition at line 755 of file CPCollectionView.j.
|
implementation |
Sets the maximum number of columns.
aMaxNumberOfColumns | the new maximum number of columns |
Definition at line 688 of file CPCollectionView.j.
|
implementation |
Sets the maximum number of rows.
aMaxNumberOfRows | the new maximum number of rows |
Definition at line 666 of file CPCollectionView.j.
|
implementation |
Sets the minimum size for an item
aSize | the new minimum item size |
Definition at line 727 of file CPCollectionView.j.
|
implementation |
Sets whether the user is allowed to select items
isSelectable | YES allows the user to select items. |
Definition at line 374 of file CPCollectionView.j.
|
implementation |
Sets the selected items based on the provided indices.
anIndexSet | the set of items to be selected |
Definition at line 432 of file CPCollectionView.j.
|
implementation |
Synthesized accessor method.
Provided by category CPCollectionView(CPSynthesizedAccessors).
Definition at line 877 of file CPCollectionView.j.
|
implementation |
Sets the collection view's vertical spacing between elements.
aVerticalMargin | the number of pixels to place between elements |
Definition at line 867 of file CPCollectionView.j.
|
implementation |
Definition at line 519 of file CPCollectionView.j.
|
implementation |
Definition at line 524 of file CPCollectionView.j.
|
implementation |
Synthesized accessor method.
Provided by category CPCollectionView(CPSynthesizedAccessors).
Definition at line 1601 of file CPCollectionView.j.
|
implementation |
Gets the collection view's current vertical spacing between elements.
Definition at line 888 of file CPCollectionView.j.