CollectionView.h

Go to the documentation of this file.

/*
 * ObjectivelyMVC: Object oriented MVC framework for OpenGL, SDL2 and GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <Objectively/IndexPath.h>
 
#include <ObjectivelyMVC/Control.h>
#include <ObjectivelyMVC/CollectionItemView.h>
#include <ObjectivelyMVC/ScrollView.h>
 
typedef enum {
    CollectionViewAxisVertical,
    CollectionViewAxisHorizontal
} CollectionViewAxis;
 
OBJECTIVELYMVC_EXPORT const EnumName CollectionViewAxisNames[];
 
typedef struct CollectionViewDataSource CollectionViewDataSource;
typedef struct CollectionViewDelegate CollectionViewDelegate;
 
typedef struct CollectionView CollectionView;
typedef struct CollectionViewInterface CollectionViewInterface;
 
struct CollectionViewDataSource {
 
    ident self;
 
    size_t (*numberOfItems)(const CollectionView *collectionView);
 
    ident (*objectForItemAtIndexPath)(const CollectionView *collectionView, const IndexPath *indexPath);
};
 
struct CollectionViewDelegate {
 
    ident self;
 
    void (*didModifySelection)(CollectionView *collectionView, const Array *selectionIndexPaths);
 
    CollectionItemView *(*itemForObjectAtIndexPath)(const CollectionView *collectionView, const IndexPath *indexPath);
};
 
struct CollectionView {
 
    Control control;
 
    CollectionViewInterface *interface;
 
    CollectionViewAxis axis;
 
    View *contentView;
 
    CollectionViewDataSource dataSource;
 
    CollectionViewDelegate delegate;
 
    MutableArray *items;
 
    SDL_Size itemSize;
 
    SDL_Size itemSpacing;
 
    ScrollView *scrollView;
};
 
struct CollectionViewInterface {
 
    ControlInterface controlInterface;
 
    void (*deselectAll)(CollectionView *self);
 
    void (*deselectItemAtIndexPath)(CollectionView *self, const IndexPath *indexPath);
 
    void (*deselectItemsAtIndexPaths)(CollectionView *self, const Array *indexPaths);
 
    CollectionView *(*initWithFrame)(CollectionView *self, const SDL_Rect *frame);
 
    IndexPath *(*indexPathForItem)(const CollectionView *self, const CollectionItemView *item);
 
    IndexPath *(*indexPathForItemAtPoint)(const CollectionView *self, const SDL_Point *point);
 
    CollectionItemView *(*itemAtIndexPath)(const CollectionView *self, const IndexPath *indexPath);
 
    SDL_Size (*naturalSize)(const CollectionView *self);
 
    void (*reloadData)(CollectionView *self);
 
    void (*selectAll)(CollectionView *self);
 
    Array *(*selectionIndexPaths)(const CollectionView *self);
 
    void (*selectItemAtIndexPath)(CollectionView *self, const IndexPath *indexPath);
 
    void (*selectItemsAtIndexPaths)(CollectionView *self, const Array *indexPaths);
};
 
OBJECTIVELYMVC_EXPORT Class *_CollectionView(void);