Swiftgram/AsyncDisplayKit/Details/Transactions/_ASAsyncTransactionContainer.h
Michael Schneider 8897614f0e [Layout] Layout API based on content area (#2110)
* Initial commit for adding a size constraint to ASLayoutable's

* Some more commits

* Fix sample projects in extra/

* Remove preferredFrameSize test of ASEditableTextNode

* Remove preferredFrameSize from examples_extra

* Add deprecation warning to -[ASDisplayNode preferredFrameSize]

* Add deprecation warning to -[ASDisplayNode measureWithSizeRange:]

* Commit

* Commit

* Remove ASRelativeSizeRange

* Make ASRelativeSize private

* Adjust examples

* Improve setting of -[ASLayoutable size] with points or fractions

* Add ASWrapperLayoutSpec

* Improve creation of ASRelativeDimension

* Add `preferredFrameSize` back and add deprecated logging

* Add `layoutSpecBlock` setter and getter and add locking for it

* Add better documentation and fix macros to create ASRelativeDimension

* Create new ASSizeRangeMake with just a CGSize as parameter

* Update Kitten and Social App Layout example

* Add layoutThatFits: and deprecate measure:

* Rename ASRelativeDimension to ASDimension

* Fix examples for ASDimension renaming

* Remove fancy height and width setter

* Fix ASDimension helper

* Rename -[ASLayout layoutableObject] to -[ASLayout layoutable]

* Update layout related methods and more clearer documentation around how to use it

* Deprecate old ASLayout class constructors

* Don't unnecessary recalculate layout if constrained or parent size did not change

* Use shared pointer for ASDisplayNodeLayout

* Fix rebase conflicts

* Add documentation and move implementation in mm file of ASDisplayNodeLayout

* Fix test errors

* Rename ASSize to ASLayoutableSize

* Address comments

* Rename setSizeFromCGSize to setSizeWithCGSize

* Improve inline functions in ASDimension

* Fix rebase conflicts
2016-09-07 08:44:48 -07:00

74 lines
2.9 KiB
Objective-C

//
// _ASAsyncTransactionContainer.h
// AsyncDisplayKit
//
// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
// This source code is licensed under the BSD-style license found in the
// LICENSE file in the root directory of this source tree. An additional grant
// of patent rights can be found in the PATENTS file in the same directory.
//
#import <UIKit/UIKit.h>
@class _ASAsyncTransaction;
typedef NS_ENUM(NSUInteger, ASAsyncTransactionContainerState) {
/**
The async container has no outstanding transactions.
Whatever it is displaying is up-to-date.
*/
ASAsyncTransactionContainerStateNoTransactions = 0,
/**
The async container has one or more outstanding async transactions.
Its contents may be out of date or showing a placeholder, depending on the configuration of the contained ASDisplayLayers.
*/
ASAsyncTransactionContainerStatePendingTransactions,
};
@protocol ASDisplayNodeAsyncTransactionContainer
/**
@summary If YES, the receiver is marked as a container for async display, grouping all of the async display calls
in the layer hierarchy below the receiver together in a single ASAsyncTransaction.
@default NO
*/
@property (nonatomic, assign, getter=asyncdisplaykit_isAsyncTransactionContainer, setter=asyncdisplaykit_setAsyncTransactionContainer:) BOOL asyncdisplaykit_asyncTransactionContainer;
/**
@summary The current state of the receiver; indicates if it is currently performing asynchronous operations or if all operations have finished/canceled.
*/
@property (nonatomic, readonly, assign) ASAsyncTransactionContainerState asyncdisplaykit_asyncTransactionContainerState;
/**
@summary Cancels all async transactions on the receiver.
*/
- (void)asyncdisplaykit_cancelAsyncTransactions;
/**
@summary Invoked when the asyncdisplaykit_asyncTransactionContainerState property changes.
@desc You may want to override this in a CALayer or UIView subclass to take appropriate action (such as hiding content while it renders).
*/
- (void)asyncdisplaykit_asyncTransactionContainerStateDidChange;
@end
@interface CALayer (ASDisplayNodeAsyncTransactionContainer) <ASDisplayNodeAsyncTransactionContainer>
/**
@summary Returns the current async transaction for this container layer. A new transaction is created if one
did not already exist. This method will always return an open, uncommitted transaction.
@desc asyncdisplaykit_isAsyncTransactionContainer does not need to be YES for this to return a transaction.
*/
@property (nonatomic, readonly, strong) _ASAsyncTransaction *asyncdisplaykit_asyncTransaction;
/**
@summary Goes up the superlayer chain until it finds the first layer with asyncdisplaykit_isAsyncTransactionContainer=YES (including the receiver) and returns it.
Returns nil if no parent container is found.
*/
@property (nonatomic, readonly, strong) CALayer *asyncdisplaykit_parentTransactionContainer;
@end
@interface UIView (ASDisplayNodeAsyncTransactionContainer) <ASDisplayNodeAsyncTransactionContainer>
@end