Adlai Holler cac14e0bce
Standardize Property Declaration Style in Core Classes (#870)
* Audit property attributes for core classes

* Update style guide

* Go crazy

* Update changelog
2018-05-24 14:42:43 -07:00

69 lines
1.5 KiB
Objective-C
Executable File

//
// ASTextRunDelegate.h
// ASText <https://github.com/ibireme/ASText>
//
// Created by ibireme on 14/10/14.
// Copyright (c) 2015 ibireme.
//
// This source code is licensed under the MIT-style license found in the
// LICENSE file in the root directory of this source tree.
//
#import <UIKit/UIKit.h>
#import <CoreText/CoreText.h>
NS_ASSUME_NONNULL_BEGIN
/**
Wrapper for CTRunDelegateRef.
Example:
ASTextRunDelegate *delegate = [ASTextRunDelegate new];
delegate.ascent = 20;
delegate.descent = 4;
delegate.width = 20;
CTRunDelegateRef ctRunDelegate = delegate.CTRunDelegate;
if (ctRunDelegate) {
/// add to attributed string
CFRelease(ctRunDelegate);
}
*/
@interface ASTextRunDelegate : NSObject <NSCopying, NSCoding>
/**
Creates and returns the CTRunDelegate.
@discussion You need call CFRelease() after used.
The CTRunDelegateRef has a strong reference to this ASTextRunDelegate object.
In CoreText, use CTRunDelegateGetRefCon() to get this ASTextRunDelegate object.
@return The CTRunDelegate object.
*/
- (nullable CTRunDelegateRef)CTRunDelegate CF_RETURNS_RETAINED;
/**
Additional information about the the run delegate.
*/
@property (nullable, nonatomic) NSDictionary *userInfo;
/**
The typographic ascent of glyphs in the run.
*/
@property (nonatomic) CGFloat ascent;
/**
The typographic descent of glyphs in the run.
*/
@property (nonatomic) CGFloat descent;
/**
The typographic width of glyphs in the run.
*/
@property (nonatomic) CGFloat width;
@end
NS_ASSUME_NONNULL_END