IGGridViewThemeDefinition Protocol Reference

Conforms to NSObject
Declared in IGGridViewThemeDefinition.h

Overview

The IGGridViewThemeDefinition protocol is adopted by an object that mediates key styling points of a IGGridView object. The theme provides the grid view object with the information it needs to specific areas of the grid view.

The theme has a higher order of precedence than properties specifically on the IGGridView and IGGridViewCell, but a lower order of precedence than properties on the IGGridViewDataSource, IGGridViewDelegate and IGGridViewColumnDefintion objects.

All methods and properties in this protocol are optional.

Some properties will only take effect if certain objects are used. For example, cell related properties must use the IGGridViewDataSourceHelper and IGGridViewColumnDefintion objects that are built into the control, otherwise the creator of the cell is responsible for setting theme definition properties on the cell.

Cells

  cellBackgroundColor

The background color of an IGGridViewCell in the IGGridView.

@property (nonatomic, readonly) UIColor *cellBackgroundColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects. If you also set the alternateRowCellBackgroundColor, then this property will only apply to cells in even number rows, where the first index is zero.

Declared In

IGGridViewThemeDefinition.h

  cellTextColor

The text color of an IGGridViewCell in the IGGridView.

@property (nonatomic, readonly) UIColor *cellTextColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects. If you also set the alternateRowCellTextColor, then this property will only apply to cells in even number rows, where the first index is zero.

Declared In

IGGridViewThemeDefinition.h

  cellTextFont

The font of an IGGridViewCell in the IGGridView.

@property (nonatomic, readonly) UIFont *cellTextFont

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects.

Declared In

IGGridViewThemeDefinition.h

  alternateRowCellBackgroundColor

The background color of an IGGridViewCell in the IGGridView.

@property (nonatomic, readonly) UIColor *alternateRowCellBackgroundColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects. This property will only apply to cells in odd number rows, where the first index is zero.

Declared In

IGGridViewThemeDefinition.h

  alternateRowCellTextColor

The text color of an IGGridViewCell in the IGGridView.

@property (nonatomic, readonly) UIColor *alternateRowCellTextColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects. This property will only apply to cells in odd number rows, where the first index is zero.

Declared In

IGGridViewThemeDefinition.h

  cellContentInset

The UIEdgeInset for the content of all IGGridViewCell objects in the grid view.

@property (nonatomic, readonly) UIEdgeInsets cellContentInset

Discussion

Use this property to set the inset of the content of a cell. This property should not be set when the style of the grid view is set to IGGridViewStyleSingleCellPaging. This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

Rows

  rowSpacing

The amount of space that is appended after each row.

@property (nonatomic, readonly) CGFloat rowSpacing

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  rowHeight

The height of every row in the grid view.

@property (nonatomic, readonly) CGFloat rowHeight

Discussion

This property will override the grid level version of this property, however the IGGridViewDelegate method gridView:heightForRowAtPath: has higher precedence.

Declared In

IGGridViewThemeDefinition.h

  rowSeparatorColor

The UIColor of every row separator in the grid view.

@property (nonatomic, readonly) UIColor *rowSeparatorColor

Discussion

This property will override the grid level version of this property.

This value is only used when the delegate’s gridView:viewForRowSeparatorAtPath: or the viewForRowSeparatorAtPath: method on theme is not implemented.

Declared In

IGGridViewThemeDefinition.h

  rowSeparatorHeight

The height of every row separator in the grid View

@property (nonatomic, readonly) CGFloat rowSeparatorHeight

Discussion

This property will override the grid level version of this property.

To remove the row separator, return a height of zero.

Declared In

IGGridViewThemeDefinition.h

– viewForRowSeparatorAtPath:

A view that will be used for a row separator at a specific path.

- (UIView *)viewForRowSeparatorAtPath:(IGRowPath *)path

Parameters

path

The IGRowPath that identifes the specific row separator that should be returned

Discussion

The IGGridViewDelegate’s gridView:viewForRowSeparatorAtPath: has higher precedence.

Declared In

IGGridViewThemeDefinition.h

– viewForRowBackgroundAtPath:

A view that will be used for a row background at a specific path.

- (UIView *)viewForRowBackgroundAtPath:(IGRowPath *)path

Parameters

path

The IGRowPath that identifes the specific row background that should be returned

Discussion

The IGGridViewDelegate’s gridView:viewForRowBackgroundAtPath: has higher precedence.

Declared In

IGGridViewThemeDefinition.h

Columns

  columnSpacing

the amount of space that is appended after each column.

@property (nonatomic, readonly) CGFloat columnSpacing

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  columnWidth

The width of every column in the grid view.

@property (nonatomic, readonly) IGColumnWidth *columnWidth

Discussion

The order of precedence is as follows: IGGridViewDataSource, IGGridViewDelegate, IGGridViewThemeDefintion, IGGridView

Declared In

IGGridViewThemeDefinition.h

Header Row

  headerCellBackgroundColor

The UIColor used for the background of all header cells in the grid view.

@property (nonatomic, readonly) UIColor *headerCellBackgroundColor

Discussion

This property will override the grid level version of this property. If you provide a custom header cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  headerCellTextColor

The UIColor used for the text of all header cells in the grid view.

@property (nonatomic, readonly) UIColor *headerCellTextColor

Discussion

This property will override the grid level version of this property. If you provide a custom header cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  headerCellTextFont

The UIFont used for all header cells in the grid view.

@property (nonatomic, readonly) UIFont *headerCellTextFont

Discussion

This property will override the grid level version of this property. If you provide a custom header cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  headerCellTextAlignment

The UITextAlignment used for all header cells in the grid view.

@property (nonatomic, readonly) NSTextAlignment headerCellTextAlignment

Discussion

This property will override the grid level version of this property. If you provide a custom header cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  headerHeight

The height of the header row.

@property (nonatomic, readonly) CGFloat headerHeight

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

Section Header

  sectionHeaderBackgroundColor

The UIColor used for the background of all section header cells in the grid view.

@property (nonatomic, readonly) UIColor *sectionHeaderBackgroundColor

Discussion

This property will not be used if you provide a custom section header view via the IGGridViewDelegate or a custom section header cell via the IGGridViewDataSource.

Declared In

IGGridViewThemeDefinition.h

  sectionHeaderTextColor

The UIColor used for the text of all section header cells in the grid view.

@property (nonatomic, readonly) UIColor *sectionHeaderTextColor

Discussion

This property will not be used if you provide a custom section header view via the IGGridViewDelegate.

Declared In

IGGridViewThemeDefinition.h

  sectionHeaderTextFont

The UIFont used for of all section header cells in the grid view.

@property (nonatomic, readonly) UIFont *sectionHeaderTextFont

Discussion

This property will not be used if you provide a custom section header view via the IGGridViewDelegate.

Declared In

IGGridViewThemeDefinition.h

  sectionHeaderHeight

The height of every section header row in the grid view.

@property (nonatomic, readonly) CGFloat sectionHeaderHeight

Discussion

The order of precedence is as follows: IGGridViewDelegate, IGGridViewThemeDefintion, IGGridView

Declared In

IGGridViewThemeDefinition.h

  sectionHeaderPressedBackgroundColor

The UIColor used for the background of all section header cells in the grid view, when it’s being pressed and expansion is turned on.

@property (nonatomic, readonly) UIColor *sectionHeaderPressedBackgroundColor

Discussion

This property will not be used if you provide a custom section header view via the IGGridViewDelegate or a custom section header cell via the IGGridViewDataSource.

Declared In

IGGridViewThemeDefinition.h

Section Footer

  sectionFooterBackgroundColor

The UIColor used for the background of all section footer cells in the grid view.

@property (nonatomic, readonly) UIColor *sectionFooterBackgroundColor

Discussion

This property will not be used if you provide a custom section header view via the IGGridViewDelegate.

Declared In

IGGridViewThemeDefinition.h

  sectionFooterTextColor

The UIColor used for the text of all section footer cells in the grid view.

@property (nonatomic, readonly) UIColor *sectionFooterTextColor

Discussion

This property will not be used if you provide a custom section header view via the IGGridViewDelegate.

Declared In

IGGridViewThemeDefinition.h

  sectionFooterTextFont

The UIFont used for of all section header cells in the grid view.

@property (nonatomic, readonly) UIFont *sectionFooterTextFont

Discussion

This property will not be used if you provide a custom section header view via the IGGridViewDelegate.

Declared In

IGGridViewThemeDefinition.h

  sectionFooterHeight

The height of every section footer row in the grid view.

@property (nonatomic, readonly) CGFloat sectionFooterHeight

Discussion

The order of precedence is as follows: IGGridViewDelegate, IGGridViewThemeDefintion, IGGridView

Declared In

IGGridViewThemeDefinition.h

Section Column

  sectionColumnContentColor

The UIColor of the content area of the Section column.

@property (nonatomic, readonly) UIColor *sectionColumnContentColor

Discussion

The content area is the area in which the views specified in viewForSectionColumn: will be displayed. The default value is clear;

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  sectionColumnWidth

The width of the section column.

@property (nonatomic, readonly) CGFloat sectionColumnWidth

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  sectionColumnBackgroundView

The background view of the fixed column used for displaying a section’s custom content.

@property (nonatomic, readonly) UIView *sectionColumnBackgroundView

Discussion

When the delegate’s gridView:viewForSectionColumn: is implemented, this specified view is used as a background for the column used to display the specified content. This background view is sized to the available viewport determined by the frame of the grid view and the sectionColumnWidth. This property has lower precedence than the delegate method.

Declared In

IGGridViewThemeDefinition.h

Shortcut Bar

  shortcutBarColor

The UIColor of the shortcut bar itself and not the color of the background of the column the shortcut bar is in.

@property (nonatomic, readonly) UIColor *shortcutBarColor

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  shortcutBarPressedColor

The UIColor of the shortcut bar when its pressed.

@property (nonatomic, readonly) UIColor *shortcutBarPressedColor

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  shortcutBarColumnWidth

The width of the shortcut bar’s column.

@property (nonatomic, readonly) CGFloat shortcutBarColumnWidth

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  shortcutBarColumnBackgroundColor

The UIColor of the shortcut bar’s background.

@property (nonatomic, readonly) UIColor *shortcutBarColumnBackgroundColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  shortcutBarFont

The UIFont of the shortcut bar.

@property (nonatomic, readonly) UIFont *shortcutBarFont

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  shortcutBarTextColor

The UIColor of the shortcut bar’s item text.

@property (nonatomic, readonly) UIColor *shortcutBarTextColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  shortcutBarTextPressedColor

The UIColor of the shortcut bar’s item text when its pressed.

@property (nonatomic, readonly) UIColor *shortcutBarTextPressedColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  shortcutBarBorderColor

The UIColor of the shortcut bar’s border.

@property (nonatomic, readonly) UIColor *shortcutBarBorderColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

Selection

  selectedCellColor

The UIColor that will be used as the background of a cell when its selected.

@property (nonatomic, readonly) UIColor *selectedCellColor

Discussion

This property will override the cell level version of this property.

Declared In

IGGridViewThemeDefinition.h

  selectedCellTextColor

The UIColor that will be used for the text of a cell when its selected.

@property (nonatomic, readonly) UIColor *selectedCellTextColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

– viewForSelectedCell

The UIView that will be displayed when a cell is selected.

- (UIView *)viewForSelectedCell

Discussion

This method will override the cell level version of this property.

Declared In

IGGridViewThemeDefinition.h

Column Resizing Adorner

  columnResizingAdornerColor

The UIColor of the adorner used for resizing a column when the columnResizing property is set to IGGridViewColumnResizeActionAdorner.

@property (nonatomic, readonly) UIColor *columnResizingAdornerColor

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  columnResizingAdornerThumbColor

The UIColor of the thumb on the adorner used for resizing a column when the columnResizing property is set to IGGridViewColumnResizeActionAdorner.

@property (nonatomic, readonly) UIColor *columnResizingAdornerThumbColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  columnResizingAdornerHeaderHeight

The height of the header of the adorner used for resizing a column when the columnResizing property is set to IGGridViewColumnResizeActionAdorner.

@property (nonatomic, readonly) CGFloat columnResizingAdornerHeaderHeight

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

Row Reordering Column

  rowReorderingCellBackgroundColor

The UIColor used for the background of all row reordering cells in the grid view.

@property (nonatomic, readonly) UIColor *rowReorderingCellBackgroundColor

Discussion

This property will not be used if you provide a custom reorder cell via the IGGridViewDataSource.

Declared In

IGGridViewThemeDefinition.h

  rowReorderingColumnWidth

The width of the row reordering column.

@property (nonatomic, readonly) CGFloat rowReorderingColumnWidth

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

Filter Row

  filterCellBackgroundColor

The UIColor used for the background of the filter cell.

@property (nonatomic, readonly) UIColor *filterCellBackgroundColor

Discussion

This property only exists on the theme. If you provide a custom filter cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  filterCellTextFieldColor

The UIColor used for the text field of the filter cell.

@property (nonatomic, readonly) UIColor *filterCellTextFieldColor

Discussion

This property only exists on the theme. If you provide a custom filter cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  filterCellTextFieldFont

The UIFont used for the filter cell.

@property (nonatomic, readonly) UIFont *filterCellTextFieldFont

Discussion

This property only exists on the theme. If you provide a custom filter cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  filterCellTextFieldTextColor

The UIColor used for the text of the filter cell.

@property (nonatomic, readonly) UIColor *filterCellTextFieldTextColor

Discussion

This property only exists on the theme. If you provide a custom filter cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  filterCellTextFieldCornerRadius

The corner radius of the text field in the filter cell.

@property (nonatomic, readonly) CGFloat filterCellTextFieldCornerRadius

Discussion

This property only exists on the theme. If you provide a custom filter cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  filterRowHeight

The height of the filter row.

@property (nonatomic, readonly) CGFloat filterRowHeight

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

Pull Down Row

  pullDownRowBackgroundColor

The UIColor used for the background of the pull down row.

@property (nonatomic, readonly) UIColor *pullDownRowBackgroundColor

Discussion

This property only exists on the theme. If you provide a custom pull down cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  pullDownRowTextColor

The UIColor used for the text of the pull down row.

@property (nonatomic, readonly) UIColor *pullDownRowTextColor

Discussion

This property only exists on the theme. If you provide a custom pull down cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  pullDownRowFont

The UIFont of the pull down row.

@property (nonatomic, readonly) UIFont *pullDownRowFont

Discussion

This property only exists on the theme. If you provide a custom pull down cell, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  pullDownRowHeight

The height of the pull down row.

@property (nonatomic, readonly) CGFloat pullDownRowHeight

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

Load More Row

  loadMoreRowBackgroundColor

The UIColor used for the background of the load more row

@property (nonatomic, readonly) UIColor *loadMoreRowBackgroundColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  loadMoreRowTextColor

The UIColor used for the text of the load more row

@property (nonatomic, readonly) UIColor *loadMoreRowTextColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  loadMoreRowFont

The UIFont used for the load more row

@property (nonatomic, readonly) UIFont *loadMoreRowFont

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

Fixed Left Column

  fixedLeftCellBackgroundColor

The background color of an IGGridViewCell that is fixed to the left of the IGGridView.

@property (nonatomic, readonly) UIColor *fixedLeftCellBackgroundColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects.

Declared In

IGGridViewThemeDefinition.h

  fixedLeftCellTextColor

The text color of an IGGridViewCell that is fixed to the left of the IGGridView.

@property (nonatomic, readonly) UIColor *fixedLeftCellTextColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects.

Declared In

IGGridViewThemeDefinition.h

  fixedLeftCellFont

The UIFont of an IGGridViewCell that is fixed to the left of the IGGridView.

@property (nonatomic, readonly) UIFont *fixedLeftCellFont

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects.

Declared In

IGGridViewThemeDefinition.h

  fixedLeftColumnSeparatorColor

The UIColor of every fixed left column separator in the grid view.

@property (nonatomic, readonly) UIColor *fixedLeftColumnSeparatorColor

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  fixedLeftColumnSeparatorWidth

The width of the fixed left column separator

@property (nonatomic, readonly) CGFloat fixedLeftColumnSeparatorWidth

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

Fixed Right Column

  fixedRightCellBackgroundColor

The background color of an IGGridViewCell that is fixed to the right of the IGGridView.

@property (nonatomic, readonly) UIColor *fixedRightCellBackgroundColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects.

Declared In

IGGridViewThemeDefinition.h

  fixedRightCellTextColor

The text color of an IGGridViewCell that is fixed to the right of the IGGridView.

@property (nonatomic, readonly) UIColor *fixedRightCellTextColor

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects.

Declared In

IGGridViewThemeDefinition.h

  fixedRightCellFont

The UIFont of an IGGridViewCell that is fixed to the right of the IGGridView.

@property (nonatomic, readonly) UIFont *fixedRightCellFont

Discussion

This property will only take effect if you’re uing one of the IGGridViewDataSourceHelper classes along with one of the built in IGGridViewColumnDefinition objects.

Declared In

IGGridViewThemeDefinition.h

  fixedRightColumnSeparatorColor

The UIColor of every fixed right column separator in the grid view.

@property (nonatomic, readonly) UIColor *fixedRightColumnSeparatorColor

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

  fixedRightColumnSeparatorWidth

The width of the fixed right column separator

@property (nonatomic, readonly) CGFloat fixedRightColumnSeparatorWidth

Discussion

This property will override the grid level version of this property.

Declared In

IGGridViewThemeDefinition.h

Delete Button

  deleteButtonBackgroundColors

An array of CGColors used to create a gradient background for the delete row button that is displayed when swipeRowAction property of the grid view is set to: IGGridViewSwipeRowActionDeleteButton.

@property (nonatomic, readonly) NSArray *deleteButtonBackgroundColors

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  deleteButtonTextColor

The UIColor used for the text of the delete row button that is displayed when swipeRowAction property of the grid view is set to: IGGridViewSwipeRowActionDeleteButton.

@property (nonatomic, readonly) UIColor *deleteButtonTextColor

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

  deleteButtonFont

The UIFont used for the delete row button that is displayed when swipeRowAction property of the grid view is set to: IGGridViewSwipeRowActionDeleteButton.

@property (nonatomic, readonly) UIFont *deleteButtonFont

Discussion

This property only exists on the theme.

Declared In

IGGridViewThemeDefinition.h

Editing

  editCellTextFieldBackgroundColor

The UIColor used for the background of a text field of a cell in edit mode.

@property (nonatomic, readonly) UIColor *editCellTextFieldBackgroundColor

Discussion

This property only exists on the theme. If you provide a custom editor, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  editCellTextFieldFont

The UIFont used for the text field of a cell in edit mode.

@property (nonatomic, readonly) UIFont *editCellTextFieldFont

Discussion

This property only exists on the theme. If you provide a custom editor, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h

  editCellTextFieldTextColor

The UIColor used for the text of a text field of a cell in edit mode.

@property (nonatomic, readonly) UIColor *editCellTextFieldTextColor

Discussion

This property only exists on the theme. If you provide a custom editor, this property will take no effect, unless implemented manually.

Declared In

IGGridViewThemeDefinition.h