CollectionView Struct Reference

CollectionViews display items in a grid. More...

#include <CollectionView.h>

Inheritance diagram for CollectionView:

Public Member Functions
Class *	_CollectionView (void)
	The CollectionView archetype. More...
void	deselectAll (CollectionView *self)
	Deselects all items in this CollectionView. More...
void	deselectItemAtIndexPath (CollectionView *self, const IndexPath *indexPath)
	Deselects the item at the given index path. More...
void	deselectItemsAtIndexPaths (CollectionView *self, const Array *indexPaths)
	Deselects the items at the given index paths. More...
IndexPath *	indexPathForItem (const CollectionView *self, const CollectionItemView *item)
IndexPath *	indexPathForItemAtPoint (const CollectionView *self, const SDL_Point *point)
CollectionView *	init (CollectionView *self, const SDL_Rect *frame)
	Initializes this CollectionView with the specified frame and style. More...
CollectionView *	initWithFrame (CollectionView *self, const SDL_Rect *frame)
CollectionItemView *	itemAtIndexPath (const CollectionView *self, const IndexPath *indexPath)
SDL_Size	naturalSize (const CollectionView *self)
void	reloadData (CollectionView *self)
	Reloads this CollectionView's visible items. More...
void	selectAll (CollectionView *self)
	Selects all items in this CollectionView. More...
Array *	selectionIndexPaths (const CollectionView *self)
void	selectItemAtIndexPath (CollectionView *self, const IndexPath *indexPath)
	Selects the item at the given index path. More...
void	selectItemsAtIndexPaths (CollectionView *self, const Array *indexPaths)
	Selects the items at the given index paths. More...
Public Member Functions inherited from Control
Class *	_Control (void)
	The Control archetype. More...
Array *	actionsForEvent (const Control *self, const SDL_Event *event)
void	addActionForEventType (Control *self, SDL_EventType eventType, ActionFunction function, ident sender, ident data)
	Adds an Action for the given event type to this Control. More...
_Bool	captureEvent (Control *self, const SDL_Event *event)
	Captures a given event, potentially altering the state of this Control. More...
Control	initWithFrame (Control *self, const SDL_Rect *frame)
	Initializes this Control with the specified frame and style. More...
_Bool	isDisabled (const Control *self)
_Bool	isFocused (const Control *self)
_Bool	isHighlighted (const Control *self)
_Bool	isSelected (const Control *self)
void	stateDidChange (Control *self)
	Called when the state of this Control changes. More...
Public Member Functions inherited from View
Class *	_View (void)
	The View archetype. More...
_Bool	acceptsFirstResponder (const View *self)
void	addClassName (View *self, const char *className)
	Adds the given class name to this View. More...
void	addSubview (View *self, View *subview)
	Adds a subview to this view, to be drawn above its siblings. More...
void	addSubviewRelativeTo (View *self, View *subview, View *other, ViewPosition position)
	Adds a subview to this view, positioned relatively to other. More...
	ancestorWithIdentifier (const View *self, const char *identifier)
void	applyStyle (View *self, const Style *style)
	Applies the given Style to this View. More...
void	applyTheme (View *self, const Theme *theme)
	Applies the given Theme to this View. More...
void	applyThemeIfNeeded (View *self, const Theme *theme)
	Recursively applies the Theme to this View and its subviews. More...
void	attachStylesheet (View *self, SDL_Window *window)
	Attaches this View's Stylesheet to the Theme associated with the given window. More...
void	awakeWithCharacters (View *self, const char *chars)
	Wakes this View with the given null-terminated JSON C string. More...
void	awakeWithData (View *self, const Data *data)
	Wakes this View with the specified JSON Data. More...
void	awakeWithDictionary (View *self, const Dictionary *dictionary)
	Wakes this View with the specified Dictionary. More...
void	awakeWithResource (View *self, const Resource *resource)
	Wakes this View with the specified Resource. More...
void	awakeWithResourceName (View *self, const char *name)
	Wakes this View with the Resource by the specified name. More...
void	becomeFirstResponder (View *self)
	Become the first responder in the View hierarchy. More...
_Bool	bind (View *self, const Inlet *inlets, const Dictionary *dictionary)
	Performs data binding for the Inlets described in dictionary. More...
SDL_Rect	bounds (const View *self)
void	bringSubviewToFront (View *self, View *subview)
	Brings the specified subview to the front. More...
SDL_Rect	clippingFrame (const View *self)
_Bool	containsPoint (const View *self, const SDL_Point *point)
int	depth (const View *self)
	descendantWithIdentifier (const View *self, const char *identifier)
void	detachStylesheet (View *self, SDL_Window *window)
	Detaches this View's Stylesheet from the Theme associated with the given window. More...
void	didMoveToWindow (View *self, SDL_Window *window)
	Informs this View that it has been added to the View hierachy of the given window. More...
_Bool	didReceiveEvent (const View *self, const SDL_Event *event)
void *	draw (View *self, Renderer *renderer)
	Draws this View. More...
void	enumerate (const View *self, ViewEnumerator enumerator, ident data)
void	enumerate (View *self, ViewEnumerator enumerator, ident data)
	Enumerates this View and its descendants, applying enumerator to each. More...
void	enumerateAdjacent (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates adjacent siblings of this View, applying enumerator to each. More...
void	enumerateAncestors (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all ancestors of this View, applying enumerator to each. More...
void	enumerateDescendants (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all descendants of this View, applying enumerator to each. More...
void	enumerateSelection (View *self, const char *rule, ViewEnumerator enumerator, ident data)
	Enumerates all Views in the selection matched by rule, applying enumerator to each. More...
void	enumerateSiblings (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all siblings of this View, applying enumerator to each. More...
void	enumerateSubviews (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates all subviews of this View, applying enumerator to each. More...
void	enumerateSuperview (const View *self, ViewEnumerator enumerator, ident data)
	Enumerates the superview of this View, if any, applying enumerator to it. More...
View *	firstResponder (SDL_Window *window)
_Bool	hasClassName (const View *self, cosnt char *className)
View *	hitTest (const View *self, const SDL_Point *point)
	Performs a hit test against this View and its descendants for the given point. More...
View *	init (View *self)
	Initializes this View. More...
View *	initWithFrame (View *self, const SDL_Rect *frame)
	Initializes this View with the specified frame. More...
void	invalidateStyle (View *self)
	Invalidates the computed Style for this View and its descendants. More...
_Bool	isContainer (const View *self)
_Bool	isDescendantOfView (const View *self, const View *view)
_Bool	isFirstResponder (const View *self)
_Bool	isVisible (const View *self)
void	layoutIfNeeded (View *self)
	Recursively updates the layout of this View and its subviews. More...
	layoutSubviews (View *self)
	Performs layout for this View's immediate subviews. More...
_Bool	matchesSelector (const View *self, const SimpleSelector *simpleSelector)
void	moveToWindow (View *self, SDL_Window *window)
	Moves this View to the View hierarchy of the given window. More...
String *	path (const View *self)
void	removeAllClassNames (View *self)
	Removes all class names from this View. More...
void	removeAllSubviews (View *self)
	Removes all subviews from this View. More...
void	removeClassName (View *self, const char *className)
	Removes the given class name to this View. More...
void	removeFromSuperview (View *self)
	Removes this View from its superview. More...
void	removeSubview (View *self, View *subview)
	Removes the given subview from this View. More...
void	render (View *self, Renderer *renderer)
	Renders this View using the given renderer. More...
void	renderDeviceDidReset (View *self)
	Informs this View that the render device has reset. More...
void	renderDeviceWillReset (View *self)
	Informs this View that the render device will reset. More...
SDL_Rect	renderFrame (const View *self)
void	replaceSubview (View *self, View *subview, View *replacement)
	Replaces the specified subview with the given replacement. More...
void	resignFirstResponder (View *self)
	Resigns first responder priority. More...
void	resize (View *self, const SDL_Size *size)
	Resizes this View to the specified size. More...
void	resolve (View *self, Outlet *outlets)
	Resolves the given Outlets from this View's hierarchy. More...
void	respondToEvent (View *self, const SDL_Event *event)
	Responds to the specified event. More...
Set *	select (View *self, const char *rule)
	Resolves all descendants (including this View) that match the given Selector rule. More...
void	setFirstResponder (SDL_Window *window, View *view)
	Sets the first responder for the given window. More...
SDL_Size	size (const View *self)
SDL_Size	sizeThatContains (const View *self)
void	sizeThatFits (const View *self)
void	sizeToContain (View *self)
	Resizes this View to contain its subviews. More...
void	sizeToFit (View *self)
	Resizes this View to fit its subviews. More...
	subviewWithIdentifier (const View *self, const char *identifier)
void	updateBindings (View *self)
	Updates data bindings, prompting the appropriate layout changes. More...
SDL_Rect	viewport (const View *self)
View *	viewWithCharacters (const char *chars, Outlet *outlets)
	Instantiates a View initialized with the given null-terminated JSON C string. More...
View *	viewWithData (const Data *data, Outlet *outlets)
	Instantiates a View initialized with the contents of data. More...
View *	viewWithDictionary (const Dictionary *dictionary, Outlet *outlets)
	Instantiates a View initialized with the attributes described in dictionary. More...
View *	viewWithResource (const Resource *resource, Outlet *outlets)
	Instantiates a View initialized with the JSON data in resource. More...
View *	viewWithResourceName (const char *name, Outlet *outlets)
	Instantiates a View initialized with the JSON Resource with the specified name. More...
Array *	visibleSubviews (const View *self)
void	warn (View *self, const char *fmt,...)
	Appends a warning for this View. More...
void	willMoveToWindow (View *self, SDL_Window *window)
	Informs this View that it will be added to the View hierarchy for the given window. More...

Data Fields
CollectionViewAxis	axis
	The layout axis. More...
View *	contentView
	The content view. More...
Control	control
	The superclass. More...
CollectionViewDataSource	dataSource
	The data source. More...
CollectionViewDelegate	delegate
	The delegate. More...
MutableArray *	items
	The items. More...
SDL_Size	itemSize
	The item size. More...
SDL_Size	itemSpacing
	The item spacing. More...
ScrollView *	scrollView
	The scroll view. More...
Data Fields inherited from Control
ControlBevel	bevel
	The ControlBevel. More...
ControlSelection	selection
	The ControlSelection. More...
unsigned int	state
	The bit mask of ControlState. More...
View	view
	The superclass. More...
Data Fields inherited from View
ViewAlignment	alignment
	The alignment. More...
int	autoresizingMask
	The ViewAutoresizing bitmask. More...
SDL_Color	backgroundColor
	The background color. More...
SDL_Color	borderColor
	The border color. More...
int	borderWidth
	The border width. More...
MutableSet *	classNames
	The class names. More...
_Bool	clipsSubviews
	If true, subviews will be clipped to this View's frame. More...
Style *	computedStyle
	The computed Style of this View. More...
SDL_Rect	frame
	The frame, relative to the superview. More...
_Bool	hidden
	If true, this View is not drawn. More...
char *	identifier
	An optional identifier. More...
SDL_Size	maxSize
	The maximum size this View may be resized to during layout. More...
SDL_Size	minSize
	The minimum size this View may be resized to during layout. More...
_Bool	needsApplyTheme
	If true, this View will apply the Theme before it is drawn. More...
_Bool	needsLayout
	If true, this View will layout its subviews before it is drawn. More...
View *	nextResponder
	The next responder, or event handler, in the chain. More...
Object	object
	The superclass. More...
ViewPadding	padding
	The padding. More...
Style *	style
	The element-level Style of this View. More...
Stylesheet *	stylesheet
	An optional Stylesheet. More...
MutableArray *	subviews
	The immediate subviews. More...
View *	superview
	The super View. More...
ViewController *	viewController
	The ViewController. More...
MutableArray *	warnings
	The warnings this View generated. More...
SDL_Window *	window
	The window. More...

Protected Attributes
CollectionViewInterface *	interface
	The interface. More...
Protected Attributes inherited from Control
ControlInterface *	interface
	The interface. More...
Protected Attributes inherited from View
ViewInterface *	interface
	The interface. More...

Detailed Description

CollectionViews display items in a grid.

Definition at line 118 of file CollectionView.h.

Member Function Documentation

_CollectionView()

Class * _CollectionView

(

void

)

The CollectionView archetype.

Returns

The CollectionView Class.

Definition at line 542 of file CollectionView.c.

                             {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "CollectionView",
            .superclass = _Control(),
            .instanceSize = sizeof(CollectionView),
            .interfaceOffset = offsetof(CollectionView, interface),
            .interfaceSize = sizeof(CollectionViewInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

deselectAll()

void deselectAll

(

CollectionView *

self

)

Deselects all items in this CollectionView.

Parameters

self	The CollectionView.

Definition at line 208 of file CollectionView.c.

                                              {
    $((Array *) self->items, enumerateObjects, deselectAll_enumerate, NULL);
}

deselectItemAtIndexPath()

void deselectItemAtIndexPath	(	CollectionView *	self,
		const IndexPath *	indexPath
	)

Deselects the item at the given index path.

Parameters

self	The CollectionView.
indexPath	The index path of the item to deselect.

Definition at line 216 of file CollectionView.c.

                                                                                      {
 
    if (indexPath) {
        CollectionItemView *item = $(self, itemAtIndexPath, indexPath);
        if (item) {
            $(item, setSelected, false);
            $(self->contentView, invalidateStyle);
        }
    }
}

deselectItemsAtIndexPaths()

void deselectItemsAtIndexPaths	(	CollectionView *	self,
		const Array *	indexPaths
	)

Deselects the items at the given index paths.

Parameters

self	The CollectionView.
indexPaths	The index paths of the items to deselect.

Definition at line 238 of file CollectionView.c.

                                                                                     {
 
    if (indexPaths) {
        $(indexPaths, enumerateObjects, deselectItemsAtIndexPaths_enumerate, self);
    }
}

indexPathForItem()

IndexPath * indexPathForItem	(	const CollectionView *	self,
		const CollectionItemView *	item
	)

Parameters

self	The CollectionView.
item	The item.

Returns

The index path of item, or NULL if not found.

Definition at line 289 of file CollectionView.c.

                                                                                               {
 
    const ssize_t index = $((Array *) self->items, indexOfObject, (ident) item);
    if (index > -1) {
        return $(alloc(IndexPath), initWithIndex, index);
    }
 
    return NULL;
}

indexPathForItemAtPoint()

IndexPath indexPathForItemAtPoint	(	const CollectionView *	self,
		const SDL_Point *	point
	)

Parameters

self	The CollectionView.
point	A point in window coordinate space.

Returns

The index path of the item at the specified point, or NULL.

Definition at line 249 of file CollectionView.c.

                                                                                              {
 
    if (self->itemSize.w && self->itemSize.h) {
 
        const SDL_Rect frame = $(self->contentView, renderFrame);
 
        const int itemWidth = self->itemSize.w + self->itemSpacing.w;
        const int itemHeight = self->itemSize.h + self->itemSpacing.h;
 
        const int rows = max(1, frame.h / itemHeight);
        const int cols = max(1, frame.w / itemWidth);
 
        const int x = point->x - frame.x;
        const int y = point->y - frame.y;
 
        const int row = y / itemHeight;
        const int col = x / itemWidth;
 
        int index;
        switch (self->axis) {
            case CollectionViewAxisVertical:
                index = row * cols + col;
                break;
            case CollectionViewAxisHorizontal:
                index = col * rows + row;
                break;
        }
 
        if (index < (int) self->items->array.count) {
            return $(alloc(IndexPath), initWithIndex, index);
        }
    }
 
    return NULL;
}

init()

CollectionView * init	(	CollectionView *	self,
		const SDL_Rect *	frame
	)

Initializes this CollectionView with the specified frame and style.

Parameters

self	The CollectionView.
frame	The frame.

Returns

The initialized CollectionView, or NULL on error.

initWithFrame()

CollectionView * initWithFrame	(	CollectionView *	self,
		const SDL_Rect *	frame
	)

Definition at line 303 of file CollectionView.c.

                                                                                  {
 
    self = (CollectionView *) super(Control, self, initWithFrame, frame);
    if (self) {
 
        self->items = $$(MutableArray, array);
 
        self->contentView = $(alloc(View), initWithFrame, NULL);
        assert(self->contentView);
 
        $(self->contentView, addClassName, "contentView");
        $(self->contentView, addClassName, "container");
 
        self->scrollView = $(alloc(ScrollView), initWithFrame, NULL);
        assert(self->scrollView);
 
        $(self->scrollView, setContentView, self->contentView);
 
        $((View *) self, addSubview, (View *) self->scrollView);
    }
 
    return self;
}

itemAtIndexPath()

CollectionItemView * itemAtIndexPath	(	const CollectionView *	self,
		const IndexPath *	indexPath
	)

Parameters

self	The CollectionView.
indexPath	An index path.

Returns

The item at the specified index path, or NULL.

Definition at line 331 of file CollectionView.c.

                                                                                                   {
 
    if (indexPath) {
        const Array *items = (Array *) self->items;
        const size_t index = $(indexPath, indexAtPosition, 0);
 
        if (index < items->count) {
            return $(items, objectAtIndex, index);
        }
    }
 
    return NULL;
}

naturalSize()

SDL_Size naturalSize

(

const CollectionView *

self

)

Parameters

self	The CollectionView.

Returns

The natural size of this CollectionView, placing all items in a single column or row.

Definition at line 349 of file CollectionView.c.

                                                        {
 
    ViewPadding padding = MakePadding(0, 0, 0, 0);
    padding = AddPadding(padding, ((View *) self)->padding);
    padding = AddPadding(padding, ((View *) self->scrollView)->padding);
    padding = AddPadding(padding, ((View *) self->contentView)->padding);
 
    SDL_Size size = MakeSize(padding.left + padding.right, padding.top + padding.bottom);
 
    const SDL_Rect bounds = $((View *) self->scrollView->contentView, bounds);
 
    switch (self->axis) {
        case CollectionViewAxisVertical: {
            int itemsPerRow = 1;
            int w = bounds.w;
            while (w > 0) {
                w -= self->itemSize.w;
                itemsPerRow++;
                if (w - self->itemSpacing.w < 0) {
                    break;
                }
                w -= self->itemSpacing.w;
            }
            const int rows = ceilf(self->items->array.count / (float) itemsPerRow);
            size.w += max(self->itemSize.w, bounds.w);
            size.h += rows * (self->itemSize.h + self->itemSpacing.h);
        }
            break;
        case CollectionViewAxisHorizontal:{
            int itemsPerCol = 1;
            int h = bounds.h;
            while (h > 0) {
                h -= self->itemSize.h;
                itemsPerCol++;
                if (h - self->itemSpacing.h < 0) {
                    break;
                }
                h -= self->itemSpacing.h;
            }
            const int cols = ceilf(self->items->array.count / (float) itemsPerCol);
            size.w += cols * (self->itemSize.w + self->itemSpacing.w);
            size.h += max(self->itemSize.h, bounds.h);
        }
            break;
    }
 
    return size;
}

reloadData()

void reloadData

(

CollectionView *

self

)

Reloads this CollectionView's visible items.

Parameters

self	The CollectionView.

Remarks

This method must be called after changes to the data source or delegate. Failure to call this method after such changes leads to undefined behavior.

Definition at line 409 of file CollectionView.c.

                                             {
 
    assert(self->dataSource.numberOfItems);
    assert(self->delegate.itemForObjectAtIndexPath);
 
    $((Array *) self->items, enumerateObjects, reloadData_removeItems, self->contentView);
    $(self->items, removeAllObjects);
 
    const size_t numberOfItems = self->dataSource.numberOfItems(self);
    for (size_t i = 0; i < numberOfItems; i++) {
 
        IndexPath *indexPath = $(alloc(IndexPath), initWithIndex, i);
 
        CollectionItemView *item = self->delegate.itemForObjectAtIndexPath(self, indexPath);
        assert(item);
 
        $(self->items, addObject, item);
        $(self->contentView, addSubview, (View *) item);
 
        release(item);
        release(indexPath);
    }
 
    ((View *) self)->needsLayout = true;
}

selectAll()

void selectAll

(

CollectionView *

self

)

Selects all items in this CollectionView.

Parameters

self	The CollectionView.

Definition at line 446 of file CollectionView.c.

                                            {
    $((Array *) self->items, enumerateObjects, selectAll_enumerate, NULL);
}

selectionIndexPaths()

Array * selectionIndexPaths

(

const CollectionView *

self

)

Parameters

self	The CollectionView.

Returns

An Array containing the index paths of all selected items.

Definition at line 454 of file CollectionView.c.

                                                              {
 
    MutableArray *array = $$(MutableArray, array);
 
    const Array *items = (Array *) self->items;
    for (size_t i = 0; i < items->count; i++) {
 
        const CollectionItemView *item = $(items, objectAtIndex, i);
        if (item->isSelected) {
 
            IndexPath *indexPath = $(self, indexPathForItem, item);
            $(array, addObject, indexPath);
 
            release(indexPath);
        }
    }
 
    return (Array *) array;
}

selectItemAtIndexPath()

void selectItemAtIndexPath	(	CollectionView *	self,
		const IndexPath *	indexPath
	)

Selects the item at the given index path.

Parameters

self	The CollectionView.
indexPath	The index path of the item to select.

Definition at line 478 of file CollectionView.c.

                                                                                    {
 
    if (indexPath) {
        CollectionItemView *item = $(self, itemAtIndexPath, indexPath);
        if (item) {
            $(item, setSelected, true);
            $(self->contentView, invalidateStyle);
        }
    }
}

selectItemsAtIndexPaths()

void selectItemsAtIndexPaths	(	CollectionView *	self,
		const Array *	indexPaths
	)

Selects the items at the given index paths.

Parameters

self	The CollectionView.
indexPaths	The index paths of the items to select.

Definition at line 500 of file CollectionView.c.

                                                                                   {
 
    if (indexPaths) {
        $(indexPaths, enumerateObjects, selectItemsAtIndexPaths_enumerate, self);
    }
}

Field Documentation

axis

CollectionViewAxis CollectionView::axis

The layout axis.

Definition at line 134 of file CollectionView.h.

contentView

View* CollectionView::contentView

The content view.

Definition at line 139 of file CollectionView.h.

control

Control CollectionView::control

The superclass.

Definition at line 123 of file CollectionView.h.

dataSource

CollectionViewDataSource CollectionView::dataSource

The data source.

Definition at line 144 of file CollectionView.h.

delegate

CollectionViewDelegate CollectionView::delegate

The delegate.

Definition at line 149 of file CollectionView.h.

interface

CollectionViewInterface* CollectionView::interface

protected

The interface.

Definition at line 129 of file CollectionView.h.

items

MutableArray* CollectionView::items

The items.

Definition at line 154 of file CollectionView.h.

itemSize

SDL_Size CollectionView::itemSize

The item size.

Definition at line 159 of file CollectionView.h.

itemSpacing

SDL_Size CollectionView::itemSpacing

The item spacing.

Definition at line 164 of file CollectionView.h.

scrollView

ScrollView* CollectionView::scrollView

The scroll view.

Definition at line 169 of file CollectionView.h.

---

The documentation for this struct was generated from the following files:

• Sources/ObjectivelyMVC/CollectionView.h
• Sources/ObjectivelyMVC/CollectionView.c