Files
TIMSDK/iOS/TUIKit/TUIChat/Cell/CellData/Base/TUITextMessageCellData.h
T
2022-08-19 15:09:06 +08:00

130 lines
4.4 KiB
Objective-C
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* 本文件声明了 TUITextMessageCellData 类。
* 本类继承于 TUIBubbleMessageCellData,用于存放文本消息单元所需的一系列数据与信息。
*
* This file declares the TUITextMessageCellData class.
* This class inherits from TUIBubbleMessageCellData and is used to store a series of data and information required by the text message unit.
*/
#import "TUIMessageCellData.h"
#import "TUIBubbleMessageCellData.h"
NS_ASSUME_NONNULL_BEGIN
/**
* 【模块名称】TUITextMessageCellData
* 【功能说明】文本消息单元数据源。
* - 文本消息单元,即在多数消息收发情况下最常见的消息单元。
* - 文本消息单元数据源则是为文本消息单元提供一系列所需的数据与信息。
*
* 【Module name】 TUITextMessageCellData
* 【Function description】The datasource of text message unit.
* - Text message unit, which is the most common message unit in most message sending and receiving situations.
* - The text message unit data source provides a series of required data and information for the text message unit.
*/
@interface TUITextMessageCellData : TUIBubbleMessageCellData
/**
* Content of text message
*/
@property (nonatomic, strong) NSString *content;
/**
* 文本字体
* 文本消息显示时的 UI 字体。
*
* The font of label which displays the text message content
*/
@property (nonatomic, strong) UIFont *textFont;
/**
* 文本颜色
* 文本消息显示时的 UI 颜色。
*
* The color of label which displays the text message content
*/
@property (nonatomic) UIColor *textColor;
@property (nonatomic) BOOL isAudioCall;
@property (nonatomic) BOOL isVideoCall;
/**
* 可变字符串
* 文本消息接收到 content 字符串后,需要将字符串中可能存在的字符串表情(比如[微笑]),转为图片表情。
* 本字符串则负责存储上述过程转换后的结果。
*
* Mutable strings.
* After the text message receives the content string, it is necessary to convert the string expression (such as [smile]) that may exist in the string into a picture expression.
* This string is responsible for storing the converted result of the above process.
*
*/
@property (nonatomic, strong) NSMutableAttributedString *attributedString;
/**
* NSValue(NSRange) 存储的 emoji 转换后的字符串在 attributedString 的位置。
* NSAttributedString 存储的 emoji 转换前的字符串,比如 "[呲牙]"。
* 在文本选中复制的时候,要找到 emoji 原始的字符串。
*
* NSValue (NSRange) stores the converted string of emoji at the position of attributedString.
* NSAttributedString stores the string before emoji conversion, such as "[呲牙]".
* When the text is selected and copied, it is necessary to find the original string of emoji.
*/
@property (nonatomic, strong) NSMutableArray<NSDictionary<NSValue *, NSAttributedString *> *> *emojiLocations;
/**
* 文本内容尺寸。
* 配合原点定位文本消息。
*
* The size of the label which displays the text message content.
* Position the text message with the @textOrigin.
*/
@property (readonly) CGSize textSize;
/**
* 文本内容原点。
* 配合尺寸定位文本消息。
*
* The origin of label which displays the text message content.
* Position the text message with the @textSize.
*/
@property (readonly) CGPoint textOrigin;
/**
* 文本消息颜色(发送)
* 在消息方向为发送时使用。
*
* The color of label which displays the text message content.
* Used when the message direction is send.
*/
@property (nonatomic, class) UIColor *outgoingTextColor;
/**
* 文本消息字体(发送)
* 在消息方向为发送时使用。
*
* The font of label which displays the text message content.
* Used when the message direction is send.
*/
@property (nonatomic, class) UIFont *outgoingTextFont;
/**
* 文本消息颜色(接收)
* 在消息方向为接收时使用。
*
* The color of label which displays the text message content.
* Used when the message direction is received.
*/
@property (nonatomic, class) UIColor *incommingTextColor;
/**
* 文本消息字体(接收)
* 在消息方向为接收时使用。
*
* The font of label which displays the text message content.
* Used when the message direction is received.
*/
@property (nonatomic, class) UIFont *incommingTextFont;
@end
NS_ASSUME_NONNULL_END