TIMSDK/iOS/TUIKit/TUIChat/UI/Input/TUIInputController.h

 /**
  * 本文件声明了实现输入区的相关组件。
  * 输入区即包括表情视图输入区（TUIFaceView+TUIMoreView）、“更多”功能区（TUIMoreView）和文本输入区（TUIInputBar）。
  * 本文件包含TInputControllerDelegate 协议和 TInputController 类。
  * 在输入条（TUIInputBar）中，提供了表情、语音、更多视图的按钮响应委托。
  * 而在本类中，将 InputBar 与上述三个视图实际结合，实现了各个视图的显示与切换的逻辑。
  *
  * This document declares the relevant components to implement the input area.
  * The input area includes the emoticon view input area (TUIFaceView+TUIMoreView), the "more" functional area (TUIMoreView) and the text input area (TUIInputBar).
  * This file contains the TInputControllerDelegate protocol and the TInputController class.
  * In the input bar (TUIInputBar), button response callbacks for expressions, voices, and more views are provided.
  * In this class, the InputBar is actually combined with the above three views to realize the display and switching logic of each view.
  */
#import <UIKit/UIKit.h>
#import "TUIInputBar.h"
#import "TUIFaceView.h"
#import "TUIMenuView.h"
#import "TUIMoreView.h"
#import "TUIMessageCell.h"
#import "TUIReplyPreviewBar.h"

@class TUIInputController;

typedef NS_ENUM(NSUInteger, InputStatus) {
    Input_Status_Input,
    Input_Status_Input_Face,
    Input_Status_Input_More,
    Input_Status_Input_Keyboard,
    Input_Status_Input_Talk,
};

/////////////////////////////////////////////////////////////////////////////////
//
//                         TInputControllerDelegate
//
/////////////////////////////////////////////////////////////////////////////////

@protocol TInputControllerDelegate <NSObject>

/**
 * 当前 InputController 高度改变时的回调。
 * 您可以通过该回调实现：根据改变的高度调整控制器内各个组件的 UI 布局。
 *
 * Callback when the current InputController height changes.
 * You can use this callback to adjust the UI layout of each component in the controller according to the changed height.
 */
- (void)inputController:(TUIInputController *)inputController didChangeHeight:(CGFloat)height;

/**
 *  当前 InputController 发送消息时的回调。
 *  Callback when the current InputController sends a message.
 */
- (void)inputController:(TUIInputController *)inputController didSendMessage:(V2TIMMessage *)msg;

/**
 *  点击某一具体“更多”单元后的回调。
 *  您可以通过该回调实现：根据点击的单元的类型，进行对应类型相应的进一步操作。比如选择图片、选择文件等。
 *  同时在本委托的实现中，含有以下代码：
 *  <pre>
 *  - (void)inputController:(TUIInputController *)inputController didSelectMoreCell:(TUIInputMoreCell *)cell {
 *      ……
 *      ……
 *      if(_delegate && [_delegate respondsToSelector:@selector(chatController:onSelectMoreCell:)]){
 *          [_delegate chatController:self onSelectMoreCell:cell];
 *      }
 *  }
 *  </pre>
 *  上述代码能够帮助您实现“更多”单元的自定义。
 *  更多信息您可以参照 TUIChat\UI\Chat\TUIBaseChatController.h 中的注释。
 *
 *  Callback for clicking a more item
 *  You can use this callback to achieve: according to the clicked cell type, do the next step. For example, select pictures, select files, etc.
 *  At the same time, the implementation of this delegate contains the following code:
 *  <pre>
 *  - (void)inputController:(TUIInputController *)inputController didSelectMoreCell:(TUIInputMoreCell *)cell {
 *      ……
 *      ……
 *      if(_delegate && [_delegate respondsToSelector:@selector(chatController:onSelectMoreCell:)]){
 *          [_delegate chatController:self onSelectMoreCell:cell];
 *      }
 *  }
 *  </pre>
 *  The above code can help you to customize the "more" unit.
 *  For more information you can refer to the comments in TUIChat\UI\Chat\TUIBaseChatController.h
 */
- (void)inputController:(TUIInputController *)inputController didSelectMoreCell:(TUIInputMoreCell *)cell;

/**
 *  有 @ 字符输入
 *  Callback when @ character is entered
 */
- (void)inputControllerDidInputAt:(TUIInputController *)inputController;

/**
 *  有 @xxx 字符删除
 *  Callback when there are @xxx characters removed
 */
- (void)inputController:(TUIInputController *)inputController didDeleteAt:(NSString *)atText;


- (void)inputControllerBeginTyping:(TUIInputController *)inputController;

- (void)inputControllerEndTyping:(TUIInputController *)inputController;

@end


/////////////////////////////////////////////////////////////////////////////////
//
//                         TInputControllerDelegate
//
/////////////////////////////////////////////////////////////////////////////////

@interface TUIInputController : UIViewController

/**
 * 输入框上方的预览视图，用于消息回复场景
 * A preview view above the input box for message reply scenarios
 */
@property (nonatomic, strong) TUIReplyPreviewBar *replyPreviewBar;


/**
 * 输入框下方的预览视图，拥有消息引用场景
 * The preview view below the input box, with the message reference scene
 *
 */
@property (nonatomic, strong) TUIReferencePreviewBar *referencePreviewBar;

/**
 * 当前正在回复的消息
 * Message currently being replied to
 */
@property (nonatomic, strong) TUIReplyPreviewData *replyData;

@property (nonatomic, strong) TUIReferencePreviewData *referenceData;

/**
 *  输入条
 *  输入条中包含文本输入框、语音按钮、“更多”按钮、表情按钮等一系列交互组件，并提供了这些组件的对应回调委托。
 *
 *  Input bar
 *  The input bar contains a series of interactive components such as text input box, voice button, "more" button, emoticon button, etc., and provides corresponding callbacks for these components.
 */
@property (nonatomic, strong) TUIInputBar *inputBar;

/**
 *  表情视图
 *  表情视图一般在点击“笑脸”按钮后浮现。负责显示各个表情分组，与分组内表情的具体信息。
 *
 *  Emoticon view
 *  The emoticon view generally appears after clicking the "Smiley" button. Responsible for displaying each expression group and the expressions within the group.
 *
 */
@property (nonatomic, strong) TUIFaceView *faceView;

/**
 *  菜单视图
 *  菜单视图位于表情视图下方，负责提供表情分组单元以及发送按钮。
 *
 *  Menu view
 *  The menu view is located below the emoticon view and is responsible for providing the emoticon grouping unit and the send button.
 */
@property (nonatomic, strong) TUIMenuView *menuView;

/**
 *  更多视图
 *  更多视图一般在点击“更多“按钮（”+“按钮）后浮现，负责显示各个更多单元，比如拍摄、视频、文件、相册等。
 *
 *  More view
 *  More views generally appear after clicking the "More" button ("+" button), and are responsible for displaying each more unit, such as shooting, video, file, album, etc.
 */
@property (nonatomic, strong) TUIMoreView *moreView;


@property (nonatomic, weak) id<TInputControllerDelegate> delegate;

/**
 *  重置当前输入控制器。
 *  如果当前有表情视图或者“更多“视图正在显示，则收起相应视图，并将当前状态设置为 Input_Status_Input。
 *  即无论当前 InputController 处于何种状态，都将其重置为初始化后的状态。
 *
 *  Reset the current input controller.
 *  If there is currently an emoji view or a "more" view being displayed, collapse the corresponding view and set the current status to Input_Status_Input.
 *  That is, no matter what state the current InputController is in, reset it to its initialized state.
 */
- (void)reset;

/**
 * 显示/隐藏消息回复输入框的预览条
 * Show/hide preview bar of message reply input box
 */
- (void)showReplyPreview:(TUIReplyPreviewData *)data;
- (void)showReferencePreview:(TUIReferencePreviewData *)data;
- (void)exitReplyAndReference:(void (^ __nullable)(void))finishedCallback;

/**
 * 当前的输入框状态
 * Current input box state
 */
@property (nonatomic, assign, readonly) InputStatus status;
@end