Swiftgram/AsyncDisplayKit/Layout/ASOverlayLayoutSpec.h
Adlai Holler 124234fef8 [Umbrella] Add warn_unused_result Attribute to Public Headers (#2353)
* Add some warn_unused_result attributes

* Add more

* Add some more
2016-10-06 16:44:49 -04:00

36 lines
1.2 KiB
Objective-C

//
// ASOverlayLayoutSpec.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 <AsyncDisplayKit/ASLayoutSpec.h>
NS_ASSUME_NONNULL_BEGIN
/**
This layout spec lays out a single layoutElement child and then overlays a layoutElement object on top of it streched to its size
*/
@interface ASOverlayLayoutSpec : ASLayoutSpec
/**
* Overlay layoutElement of this layout spec
*/
@property (nullable, nonatomic, strong) id<ASLayoutElement> overlay;
/**
* Creates and returns an ASOverlayLayoutSpec object with a given child and an layoutElement that act as overlay.
*
* @param child A child that is laid out to determine the size of this spec.
* @param overlay A layoutElement object that is laid out over the child. If this is nil, the overlay is omitted.
*/
+ (instancetype)overlayLayoutSpecWithChild:(id<ASLayoutElement>)child overlay:(nullable id<ASLayoutElement>)overlay AS_WARN_UNUSED_RESULT;
@end
NS_ASSUME_NONNULL_END