Files
RETableViewManager/RETableViewManagerExample/Pods/Documentation/SDWebImage/docset/Contents/Resources/Tokens4.xml
2013-04-02 10:02:19 -05:00

180 lines
6.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<Tokens version="1.0">
<File path="Classes/SDWebImageManager.html">
<Token>
<TokenIdentifier>//apple_ref/occ/cl/SDWebImageManager</TokenIdentifier>
<Abstract type="html">The SDWebImageManager is the class behind the UIImageView+WebCache category and likes.
It ties the asynchronous downloader (SDWebImageDownloader with the image cache store (SDImageCache.
You can use this class directly to benefit from web image downloading with caching in another context than
a UIView.</Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<NodeRef refid="4"/>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instm/SDWebImageManager/setDelegate:</TokenIdentifier>
<Abstract type="html"></Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (weak, nonatomic) id&lt;SDWebImageManagerDelegate&gt; delegate</Declaration>
<Anchor>//api/name/delegate</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instp/SDWebImageManager/delegate</TokenIdentifier>
<Abstract type="html"></Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (weak, nonatomic) id&lt;SDWebImageManagerDelegate&gt; delegate</Declaration>
<Anchor>//api/name/delegate</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instm/SDWebImageManager/setImageCache:</TokenIdentifier>
<Abstract type="html"></Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (strong, nonatomic, readonly) SDImageCache *imageCache</Declaration>
<Anchor>//api/name/imageCache</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instp/SDWebImageManager/imageCache</TokenIdentifier>
<Abstract type="html"></Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (strong, nonatomic, readonly) SDImageCache *imageCache</Declaration>
<Anchor>//api/name/imageCache</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instm/SDWebImageManager/setImageDownloader:</TokenIdentifier>
<Abstract type="html"></Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (strong, nonatomic, readonly) SDWebImageDownloader *imageDownloader</Declaration>
<Anchor>//api/name/imageDownloader</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instp/SDWebImageManager/imageDownloader</TokenIdentifier>
<Abstract type="html"></Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (strong, nonatomic, readonly) SDWebImageDownloader *imageDownloader</Declaration>
<Anchor>//api/name/imageDownloader</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instm/SDWebImageManager/setCacheKeyFilter:</TokenIdentifier>
<Abstract type="html">The cache filter is a block used each time SDWebImageManager need to convert an URL into a cache key. This can
be used to remove dynamic part of an image URL.</Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (strong) NSString *^ ) ( NSURL *url ) cacheKeyFilter</Declaration>
<Anchor>//api/name/cacheKeyFilter</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instp/SDWebImageManager/cacheKeyFilter</TokenIdentifier>
<Abstract type="html">The cache filter is a block used each time SDWebImageManager need to convert an URL into a cache key. This can
be used to remove dynamic part of an image URL.</Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>@property (strong) NSString *^ ) ( NSURL *url ) cacheKeyFilter</Declaration>
<Anchor>//api/name/cacheKeyFilter</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/clm/SDWebImageManager/sharedManager</TokenIdentifier>
<Abstract type="html">Returns global SDWebImageManager instance.</Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>+ (SDWebImageManager *)sharedManager</Declaration>
<ReturnValue><Abstract type="html">SDWebImageManager shared instance</Abstract></ReturnValue>
<Anchor>//api/name/sharedManager</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instm/SDWebImageManager/downloadWithURL:options:progress:completed:</TokenIdentifier>
<Abstract type="html">Downloads the image at the given URL if not present in cache or return the cached version otherwise.</Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>- (id&lt;SDWebImageOperation&gt;)downloadWithURL:(NSURL *)url options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletedWithFinishedBlock)completedBlock</Declaration>
<Parameters>
<Parameter>
<Name>url</Name>
<Abstract type="html">The URL to the image</Abstract>
</Parameter><Parameter>
<Name>options</Name>
<Abstract type="html">A mask to specify options to use for this request</Abstract>
</Parameter><Parameter>
<Name>progressBlock</Name>
<Abstract type="html">A block called while image is downloading</Abstract>
</Parameter><Parameter>
<Name>completedBlock</Name>
<Abstract type="html">A block called when operation has been completed.
This block as no return value and takes the requested UIImage as first parameter.
In case of error the image parameter is nil and the second parameter may contain an NSError.
The third parameter is a Boolean indicating if the image was retrived from the local cache
of from the network.
The last parameter is set to NO when the SDWebImageProgressiveDownload option is used and
the image is downloading. This block is thus called repetidly with a partial image. When
image is fully downloaded, the block is called a last time with the full image and the last
parameter set to YES.</Abstract>
</Parameter><Parameter>
<Name>delegate</Name>
<Abstract type="html">The delegate object used to send result back</Abstract>
</Parameter>
</Parameters>
<ReturnValue><Abstract type="html">Returns a cancellable NSOperation</Abstract></ReturnValue>
<Anchor>//api/name/downloadWithURL:options:progress:completed:</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instm/SDWebImageManager/cancelAll</TokenIdentifier>
<Abstract type="html">Cancel all current opreations</Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>- (void)cancelAll</Declaration>
<Anchor>//api/name/cancelAll</Anchor>
</Token>
<Token>
<TokenIdentifier>//apple_ref/occ/instm/SDWebImageManager/isRunning</TokenIdentifier>
<Abstract type="html">Check one or more operations running</Abstract>
<DeclaredIn>SDWebImageManager.h</DeclaredIn>
<Declaration>- (BOOL)isRunning</Declaration>
<Anchor>//api/name/isRunning</Anchor>
</Token>
</File>
</Tokens>