mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-24 09:48:21 +00:00
32a566d7c9
Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
354 lines
17 KiB
HTML
354 lines
17 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>IGListGenericSectionController Class Reference</title>
|
||
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
||
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
||
<meta charset='utf-8'>
|
||
<script src="../js/jquery.min.js" defer></script>
|
||
<script src="../js/jazzy.js" defer></script>
|
||
|
||
</head>
|
||
<body>
|
||
<a name="//apple_ref/objc/Class/IGListGenericSectionController" class="dashAnchor"></a>
|
||
<a title="IGListGenericSectionController Class Reference"></a>
|
||
<header>
|
||
<div class="content-wrapper">
|
||
<p><a href="../index.html">IGListKit Docs</a> (99% documented)</p>
|
||
<p class="header-right"><a href="https://github.com/Instagram/IGListKit"><img src="../img/gh.png"/>View on GitHub</a></p>
|
||
</div>
|
||
</header>
|
||
<div class="content-wrapper">
|
||
<p id="breadcrumbs">
|
||
<a href="../index.html">IGListKit Reference</a>
|
||
<img id="carat" src="../img/carat.png" />
|
||
IGListGenericSectionController Class Reference
|
||
</p>
|
||
</div>
|
||
<div class="content-wrapper">
|
||
<nav class="sidebar">
|
||
<ul class="nav-groups">
|
||
<li class="nav-group-name">
|
||
<a href="../Guides.html">Guides</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../getting-started.html">Getting Started</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../iglistdiffable-and-equality.html">IGListDiffable and Equality</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../installation.html">Installation</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../migration.html">Migration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../vision.html">VISION</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../working-with-core-data.html">Working with Core Data</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../working-with-uicollectionview.html">Working with UICollectionView</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Categories.html">Categories</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Categories.html#/c:objc(cy)NSNumber@IGListDiffable">NSNumber(IGListDiffable)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Categories.html#/c:objc(cy)NSString@IGListDiffable">NSString(IGListDiffable)</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Classes.html">Classes</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListAdapter.html">IGListAdapter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListAdapterUpdater.html">IGListAdapterUpdater</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListBatchUpdateData.html">IGListBatchUpdateData</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListCollectionViewLayout.html">IGListCollectionViewLayout</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListGenericSectionController.html">IGListGenericSectionController</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListIndexPathResult.html">IGListIndexPathResult</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListIndexSetResult.html">IGListIndexSetResult</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListMoveIndex.html">IGListMoveIndex</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListMoveIndexPath.html">IGListMoveIndexPath</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes.html#/c:objc(cs)IGListReloadDataUpdater">IGListReloadDataUpdater</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListSectionController.html">IGListSectionController</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListSingleSectionController.html">IGListSingleSectionController</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/IGListStackedSectionController.html">IGListStackedSectionController</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Constants.html">Constants</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Constants.html#/c:@IGListKitVersionNumber">IGListKitVersionNumber</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Constants.html#/c:@IGListKitVersionString">IGListKitVersionString</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Enums.html">Enums</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/IGListDiffOption.html">IGListDiffOption</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/IGListExperiment.html">IGListExperiment</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Protocols.html">Protocols</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListAdapterDataSource.html">IGListAdapterDataSource</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListAdapterUpdaterDelegate.html">IGListAdapterUpdaterDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListBatchContext.html">IGListBatchContext</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListBindable.html">IGListBindable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListBindingSectionControllerDataSource.html">IGListBindingSectionControllerDataSource</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListBindingSectionControllerSelectionDelegate.html">IGListBindingSectionControllerSelectionDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListCollectionContext.html">IGListCollectionContext</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListDiffable.html">IGListDiffable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListDisplayDelegate.html">IGListDisplayDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListScrollDelegate.html">IGListScrollDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListSingleSectionControllerDelegate.html">IGListSingleSectionControllerDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListSupplementaryViewSource.html">IGListSupplementaryViewSource</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/IGListWorkingRangeDelegate.html">IGListWorkingRangeDelegate</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Type Definitions.html">Type Definitions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListItemUpdateBlock">IGListItemUpdateBlock</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListObjectTransitionBlock">IGListObjectTransitionBlock</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListReloadUpdateBlock">IGListReloadUpdateBlock</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Type Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellConfigureBlock">IGListSingleSectionCellConfigureBlock</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Type Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellSizeBlock">IGListSingleSectionCellSizeBlock</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Type Definitions.html#/c:IGListAdapter.h@T@IGListUpdaterCompletion">IGListUpdaterCompletion</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListUpdatingCompletion">IGListUpdatingCompletion</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Functions.html">Functions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/c:@F@IGListDiff">IGListDiff</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/c:@F@IGListDiffExperiment">IGListDiffExperiment</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/c:@F@IGListDiffPaths">IGListDiffPaths</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/c:@F@IGListDiffPathsExperiment">IGListDiffPathsExperiment</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/c:IGListExperiments.h@F@IGListExperimentEnabled">IGListExperimentEnabled</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
<section>
|
||
<section class="section">
|
||
<h1>IGListGenericSectionController</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
<pre class="highlight"><code>
|
||
<span class="k">@interface</span> <span class="nc">IGListGenericSectionController</span> <span class="o"><</span><span class="n">__covariant</span> <span class="n">ObjectType</span><span class="o">></span> <span class="o">:</span> <span class="n"><a href="../Classes/IGListSectionController.html">IGListSectionController</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>This class adds a helper layer to <code>IGListSectionController</code> to automatically store a generic object in
|
||
<code>didUpdateToObject:</code>.</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:objc(cs)IGListGenericSectionController(py)object"></a>
|
||
<a name="//apple_ref/objc/Property/object" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:objc(cs)IGListGenericSectionController(py)object">object</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The object mapped to this section controller. Matches the object provided in
|
||
<code>[IGListAdapterDataSource listAdapter:sectionControllerForObject:]</code> when this section controller was created and
|
||
returned.</p>
|
||
<div class="aside aside-note">
|
||
<p class="aside-title">Note</p>
|
||
This object is briefly <code>nil</code> between initialization and the first call to <code>didUpdateToObject:</code>. After that, it is
|
||
safe to assume that this is non-<code>nil</code>.
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Objective-C</p>
|
||
<pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">ObjectType</span> <span class="n">object</span><span class="p">;</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:objc(cs)IGListGenericSectionController(im)didUpdateToObject:"></a>
|
||
<a name="//apple_ref/objc/Method/-didUpdateToObject:" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:objc(cs)IGListGenericSectionController(im)didUpdateToObject:">-didUpdateToObject:</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Updates the section controller to a new object.</p>
|
||
<div class="aside aside-note">
|
||
<p class="aside-title">Note</p>
|
||
<p>This <code><a href="../Classes/IGListSectionController.html">IGListSectionController</a></code> subclass sets its object in this method, so any overrides <strong>must call super</strong>.</p>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Objective-C</p>
|
||
<pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">didUpdateToObject</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span><span class="p">;</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<h4>Parameters</h4>
|
||
<table class="graybox">
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>object</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>The object mapped to this section controller.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="footer">
|
||
<p>© 2017 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2017-05-11)</p>
|
||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||
</section>
|
||
</article>
|
||
</div>
|
||
</body>
|
||
</div>
|
||
</html>
|