API_ UIResponder

對API中的UIResponder的屬性锻弓、方法以及使用的記錄,如果有什么不準確的地方蔫骂,歡迎大家來指出心肪、補充。

更新一篇UIResponder的API記錄纠吴,之后會陸續(xù)發(fā)一些其他類的API記錄硬鞍。代碼鏈接在本文最下方,歡迎Star或者Fark戴已。

注意:在iOS中不是任何對象都能處理事件固该,只有繼承了UIResponser的對象才能接收并處理事件,當控件用戶交互屬性設為NO或者hidden設為YES(隱藏)或者alpha=0(透明)時不能接收事件
//
//  UIResponder.h
//  UIKit
//
//  Copyright (c) 2005-2015 Apple Inc. All rights reserved.
//
//  Coder_Sun的GitHub地址:https://github.com/272095249
//  Coder_Sun簡書網址:http://www.reibang.com/u/87c7aa9de064
//  iOS-源碼解析專欄:http://www.reibang.com/c/7fe8b38a197b
//

#import <Foundation/Foundation.h>
#import <UIKit/UIKitDefines.h>
#import <UIKit/UIEvent.h>

NS_ASSUME_NONNULL_BEGIN

@class UIPress;
@class UIPressesEvent;

UIResponder
NS_CLASS_AVAILABLE_IOS(2_0) @interface UIResponder : NSObject
#pragma mark - 響應者事件
- (nullable UIResponder*)nextResponder;     // 獲取下一個響應者

- (BOOL)canBecomeFirstResponder;    // 當它放棄響應者糖儡,可以設置自身成為第一響應者伐坏,默認為NO
- (BOOL)becomeFirstResponder;       // 設置第一響應者

- (BOOL)canResignFirstResponder;    // 如果一個對象可以放棄對象響應者就返回YES,默認YES
- (BOOL)resignFirstResponder;       // 放棄第一響應者

- (BOOL)isFirstResponder;       // 是否是第一響應者


#pragma mark - 觸摸屏幕操作
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(nullable UIEvent *)event;   // 觸摸開始
- (void)touchesMoved:(NSSet<UITouch *> *)touches withEvent:(nullable UIEvent *)event;   // 觸摸移動
- (void)touchesEnded:(NSSet<UITouch *> *)touches withEvent:(nullable UIEvent *)event;   // 觸摸結束
- (void)touchesCancelled:(nullable NSSet<UITouch *> *)touches withEvent:(nullable UIEvent *)event;  // 觸摸取消
- (void)touchesEstimatedPropertiesUpdated:(NSSet * _Nonnull)touches NS_AVAILABLE_IOS(9_1);  // 3Dtouch用的



#pragma mark - 深按功能(3Dtouch用)
- (void)pressesBegan:(NSSet<UIPress *> *)presses withEvent:(nullable UIPressesEvent *)event NS_AVAILABLE_IOS(9_0);  // 開始按壓
- (void)pressesChanged:(NSSet<UIPress *> *)presses withEvent:(nullable UIPressesEvent *)event NS_AVAILABLE_IOS(9_0);    // 按壓選擇
- (void)pressesEnded:(NSSet<UIPress *> *)presses withEvent:(nullable UIPressesEvent *)event NS_AVAILABLE_IOS(9_0);  // 按壓結束
- (void)pressesCancelled:(NSSet<UIPress *> *)presses withEvent:(nullable UIPressesEvent *)event NS_AVAILABLE_IOS(9_0);  // 按壓取消


#pragma mark - 可以實現(xiàn)搖一搖等
- (void)motionBegan:(UIEventSubtype)motion withEvent:(nullable UIEvent *)event NS_AVAILABLE_IOS(3_0);   // 運動開始
- (void)motionEnded:(UIEventSubtype)motion withEvent:(nullable UIEvent *)event NS_AVAILABLE_IOS(3_0);   // 運動結束
- (void)motionCancelled:(UIEventSubtype)motion withEvent:(nullable UIEvent *)event NS_AVAILABLE_IOS(3_0);   // 運動取消

#pragma mark - 遠程控制接收事件
- (void)remoteControlReceivedWithEvent:(nullable UIEvent *)event NS_AVAILABLE_IOS(4_0); // 遠程控制接收事件



/*
 下方是如何使用遠程控制接收事件:
 
- (void)remoteControlReceivedWithEvent:(UIEvent *)event{

// 要使用遠程事件 需要在AppDelegate中的didFinishLaunchingWithOptions方法中寫[[UIApplication sharedApplication] beginReceivingRemoteControlEvents]; 用來啟用遠程控制事件接收的

    NSLog(@"遠程控制事件");
    // 然后在這里寫處理遠程事件的處理握联,下方是耳機遠程事件的操作

    NSLog(@"%li,%li",(long)event.type,(long)event.subtype);
    if(event.type==UIEventTypeRemoteControl){
        switch (event.subtype) {
            case UIEventSubtypeRemoteControlPlay:
                NSLog(@"播放事件");
                break;
            case UIEventSubtypeRemoteControlTogglePlayPause:
                NSLog(@"播放或暫停事件");
                break;
            case UIEventSubtypeRemoteControlNextTrack:
                NSLog(@"下一曲");
                break;
            case UIEventSubtypeRemoteControlPreviousTrack:
                NSLog(@"上一曲");
                break;
            case UIEventSubtypeRemoteControlBeginSeekingForward:
                NSLog(@"快進開始");
                break;
            case UIEventSubtypeRemoteControlEndSeekingForward:
                NSLog(@"快進停止");
                break;
            case UIEventSubtypeRemoteControlBeginSeekingBackward:
                NSLog(@"快退開始");
                break;
            case UIEventSubtypeRemoteControlEndSeekingBackward:
                NSLog(@"快退結束");
                break;
            default:
                break;
        }
    }
}
 
*/


- (BOOL)canPerformAction:(SEL)action withSender:(nullable id)sender NS_AVAILABLE_IOS(3_0);  // 處理命令事件
/*
 返回可以響應的事件
 
 - (BOOL)canPerformAction:(SEL)action withSender:(id)sender{
 
     return (action == @selector(copy:) || action == @selector(paste:) || action == @selector(cut:) || action == @selector(select:) || action == @selector(selectAll:) || action == @selector(delete:));
 }
 */


- (nullable id)targetForAction:(SEL)action withSender:(nullable id)sender NS_AVAILABLE_IOS(7_0);    // 初始化并處理命令事件

@property(nullable, nonatomic,readonly) NSUndoManager *undoManager NS_AVAILABLE_IOS(3_0);   // 公共的事件撤銷管理者

@end

// > 默認情況下桦沉,程序的每一個window都有一個undo管理器,它是一個用于管理undo和redo操作的共享對象金闽。然而纯露,響應鏈上的任何對象的類都可以有自定義undo管理器。例如代芜,UITextField的實例的自定義管理器在文件輸入框放棄第一響應者狀態(tài)時會被清理掉埠褪。當需要一個undo管理器時,請求會沿著響應鏈傳遞,然后UIWindow對象會返回一個可用的實例钞速。

UIKeyModifierFlags(按鍵調節(jié)器枚舉(快捷鍵))
typedef NS_OPTIONS(NSInteger, UIKeyModifierFlags) {
    UIKeyModifierAlphaShift     = 1 << 16,  // Alppha+Shift鍵
    UIKeyModifierShift          = 1 << 17,  // Shift鍵
    UIKeyModifierControl        = 1 << 18,  // Control鍵
    UIKeyModifierAlternate      = 1 << 19,  // Alt鍵
    UIKeyModifierCommand        = 1 << 20,  // Command鍵
    UIKeyModifierNumericPad     = 1 << 21,  // Num鍵
} NS_ENUM_AVAILABLE_IOS(7_0);
UIKeyCommand
NS_CLASS_AVAILABLE_IOS(7_0) @interface UIKeyCommand : NSObject <NSCopying, NSSecureCoding>

- (instancetype)init NS_DESIGNATED_INITIALIZER;
- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder NS_DESIGNATED_INITIALIZER;

@property (nonatomic,readonly) NSString *input;     // 輸入字符串
@property (nonatomic,readonly) UIKeyModifierFlags modifierFlags;    // 按鍵調節(jié)器
@property (nullable,nonatomic,copy) NSString *discoverabilityTitle NS_AVAILABLE_IOS(9_0);

// The action for UIKeyCommands should accept a single (id)sender, as do the UIResponderStandardEditActions below

// Creates an key command that will _not_ be discoverable in the UI.
+ (UIKeyCommand *)keyCommandWithInput:(NSString *)input modifierFlags:(UIKeyModifierFlags)modifierFlags action:(SEL)action;     // 按指定調節(jié)器鍵輸入字符串并設置事件

// Key Commands with a discoverabilityTitle _will_ be discoverable in the UI.
+ (UIKeyCommand *)keyCommandWithInput:(NSString *)input modifierFlags:(UIKeyModifierFlags)modifierFlags action:(SEL)action discoverabilityTitle:(NSString *)discoverabilityTitle NS_AVAILABLE_IOS(9_0);

@end

UIResponder (UIResponderKeyCommands) -- 響應者類的按鍵命令類類目
@interface UIResponder (UIResponderKeyCommands)     
@property (nullable,nonatomic,readonly) NSArray<UIKeyCommand *> *keyCommands NS_AVAILABLE_IOS(7_0); // 組合快捷鍵命令(裝有多個按鍵的數組)
@end

@interface NSObject(UIResponderStandardEditActions)   // NSObject類的標準編輯事件相應類類目

- (void)cut:(nullable id)sender NS_AVAILABLE_IOS(3_0);          // 剪貼
- (void)copy:(nullable id)sender NS_AVAILABLE_IOS(3_0);         // 復制
- (void)paste:(nullable id)sender NS_AVAILABLE_IOS(3_0);        // 粘貼
- (void)select:(nullable id)sender NS_AVAILABLE_IOS(3_0);       // 選擇
- (void)selectAll:(nullable id)sender NS_AVAILABLE_IOS(3_0);    // 選擇全部
- (void)delete:(nullable id)sender NS_AVAILABLE_IOS(3_2);       // 刪除
- (void)makeTextWritingDirectionLeftToRight:(nullable id)sender NS_AVAILABLE_IOS(5_0);  // 從左到右寫入字符串(居左)
- (void)makeTextWritingDirectionRightToLeft:(nullable id)sender NS_AVAILABLE_IOS(5_0);  // 從右到左寫入字符串(居左)
- (void)toggleBoldface:(nullable id)sender NS_AVAILABLE_IOS(6_0);   // 切換字體為黑體(粗體)
- (void)toggleItalics:(nullable id)sender NS_AVAILABLE_IOS(6_0);    // 切換文字為斜體
- (void)toggleUnderline:(nullable id)sender NS_AVAILABLE_IOS(6_0);  // 給文字添加下劃線

- (void)increaseSize:(nullable id)sender NS_AVAILABLE_IOS(7_0); // 增加字體大小
- (void)decreaseSize:(nullable id)sender NS_AVAILABLE_IOS(7_0); // 減小字體大小

@end

@class UIInputViewController;
@class UITextInputMode;
@class UITextInputAssistantItem;

UIResponder (UIResponderInputViewAdditions) -- 響應者類的輸入視圖類目
@interface UIResponder (UIResponderInputViewAdditions)


@property (nullable, nonatomic, readonly, strong) __kindof UIView *inputView NS_AVAILABLE_IOS(3_2);     // 鍵盤輸入視圖(系統(tǒng)默認的贷掖,可以自定義)
@property (nullable, nonatomic, readonly, strong) __kindof UIView *inputAccessoryView NS_AVAILABLE_IOS(3_2);    // 彈出鍵盤時附帶的視圖

/// This method is for clients that wish to put buttons on the Shortcuts Bar, shown on top of the keyboard.
/// You may modify the returned inputAssistantItem to add to or replace the existing items on the bar.
/// Modifications made to the returned UITextInputAssistantItem are reflected automatically.
/// This method should not be overriden. Goes up the responder chain.
@property (nonnull, nonatomic, readonly, strong) UITextInputAssistantItem *inputAssistantItem NS_AVAILABLE_IOS(9_0) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;

// For viewController equivalents of -inputView and -inputAccessoryView
// Called and presented when object becomes first responder.  Goes up the responder chain.
@property (nullable, nonatomic, readonly, strong) UIInputViewController *inputViewController NS_AVAILABLE_IOS(8_0);     // 鍵盤輸入視圖控制器
@property (nullable, nonatomic, readonly, strong) UIInputViewController *inputAccessoryViewController NS_AVAILABLE_IOS(8_0);    // 彈出鍵盤時附帶的視圖的視圖控制器


@property (nullable, nonatomic, readonly, strong) UITextInputMode *textInputMode NS_AVAILABLE_IOS(7_0);     // 文本輸入模式

@property (nullable, nonatomic, readonly, strong) NSString *textInputContextIdentifier NS_AVAILABLE_IOS(7_0);   // 文本輸入模式標識

+ (void)clearTextInputContextIdentifier:(NSString *)identifier NS_AVAILABLE_IOS(7_0);   // 根據設置的標識清楚指定的文本輸入模式

- (void)reloadInputViews NS_AVAILABLE_IOS(3_2);     // 重新刷新鍵盤輸入視圖

@end

/*

注意:
UITextFields和UITextView有一個inputAccessoryView的屬性,當你想在鍵盤上展示一個自定義的view時渴语,你就可以設置該屬性苹威。你設置的view就會自動和鍵盤keyboard一起顯示了。
需要注意的是驾凶,你所自定義的view既不應該處在其他的視圖層里牙甫,也不應該成為其他視圖的子視圖。其實也就是說狭郑,你所自定義的view只需要賦給屬性inputAccessoryView就可以了腹暖,不要再做其他多余的操作汇在。
我們在使用UITextView和UITextField的時候翰萨,可以通過它們的inputAccessoryView屬性給輸入時呼出的鍵盤加一個附屬視圖,通常是UIToolBar糕殉,用于回收鍵盤亩鬼。
inputView就是顯示鍵盤的view,如果重寫這個view則不再彈出鍵盤,而是彈出自己的view.如果想實現(xiàn)當某一控件變?yōu)榈谝豁憫邥r不彈出鍵盤而是彈出我們自定義的界面阿蝶,那么我們就可以通過修改這個inputView來實現(xiàn)雳锋,比如彈出一個日期拾取器。
inputView不會隨著鍵盤出現(xiàn)而出現(xiàn)羡洁,設置了InputView只會當UITextField或者UITextView變?yōu)榈谝幌鄳邥r顯示出來玷过,不會顯示鍵盤了。設置了InputAccessoryView筑煮,它會隨著鍵盤一起出現(xiàn)并且會顯示在鍵盤的頂端辛蚊。InutAccessoryView默認為nil.

*/


// These are pre-defined constants for use with the input property of UIKeyCommand objects. // 按鍵輸入箭頭指向
UIKIT_EXTERN NSString *const UIKeyInputUpArrow         NS_AVAILABLE_IOS(7_0);
UIKIT_EXTERN NSString *const UIKeyInputDownArrow       NS_AVAILABLE_IOS(7_0);
UIKIT_EXTERN NSString *const UIKeyInputLeftArrow       NS_AVAILABLE_IOS(7_0);
UIKIT_EXTERN NSString *const UIKeyInputRightArrow      NS_AVAILABLE_IOS(7_0);
UIKIT_EXTERN NSString *const UIKeyInputEscape          NS_AVAILABLE_IOS(7_0);

UIResponder (ActivityContinuation)
@interface UIResponder (ActivityContinuation)
@property (nullable, nonatomic, strong) NSUserActivity *userActivity NS_AVAILABLE_IOS(8_0);     // 用戶活動
- (void)updateUserActivityState:(NSUserActivity *)activity NS_AVAILABLE_IOS(8_0);       // 更新用戶活動
- (void)restoreUserActivityState:(NSUserActivity *)activity NS_AVAILABLE_IOS(8_0);      // 回復用戶活動
@end

/*

注意:
支持User Activities
在UIResponder中,已經為我們提供了一個userActivity屬性真仲,它是一個NSUserActivity對象袋马。因此我們在UIResponder的子類中不需要再去聲明一個userActivity屬性,直接使用它就行秸应。其聲明如下:
@property(nonatomic, retain) NSUserActivity *userActivity
由UIKit管理的User Activities會在適當的時間自動保存虑凛。一般情況下,我們可以重寫UIResponder類的updateUserActivityState:方法來延遲添加表示User Activity的狀態(tài)數據软啼。當我們不再需要一個User Activity時桑谍,我們可以設置userActivity屬性為nil。任何由UIKit管理的NSUserActivity對象祸挪,如果它沒有相關的響應者霉囚,則會自動失效。
另外,多個響應者可以共享一個NSUserActivity實例盈罐。
上面提到的updateUserActivityState:是用于更新給定的User Activity的狀態(tài)榜跌。其定義如下:
- (void)updateUserActivityState:(NSUserActivity *)activity
子類可以重寫這個方法來按照我們的需要更新給定的User Activity。我們需要使用NSUserActivity對象的addUserInfoEntriesFromDictionary:方法來添加表示用戶Activity的狀態(tài)盅粪。
在我們修改了User Activity的狀態(tài)后钓葫,如果想將其恢復到某個狀態(tài),則可以使用以下方法:
- (void)restoreUserActivityState:(NSUserActivity *)activity
子類可以重寫這個方法來使用給定User Activity的恢復響應者的狀態(tài)票顾。系統(tǒng)會在接收到數據時础浮,將數據傳遞給application:continueUserActivity:restorationHandler:以做處理。我們重寫時應該使用存儲在user activity的userInfo字典中的狀態(tài)數據來恢復對象奠骄。當然豆同,我們也可以直接調用這個方法

*/


NS_ASSUME_NONNULL_END
相關鏈接:

iOS-源碼解析專欄

記錄文件已經上傳至git:

--> 傳送門:SH_The-record-of-the-API

有問題歡迎指正以及相互探討 —— CoderSun

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市含鳞,隨后出現(xiàn)的幾起案子影锈,更是在濱河造成了極大的恐慌,老刑警劉巖蝉绷,帶你破解...
    沈念sama閱讀 206,214評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件鸭廷,死亡現(xiàn)場離奇詭異,居然都是意外死亡熔吗,警方通過查閱死者的電腦和手機辆床,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評論 2 382
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來桅狠,“玉大人讼载,你說我怎么就攤上這事≈械” “怎么了咨堤?”我有些...
    開封第一講書人閱讀 152,543評論 0 341
  • 文/不壞的土叔 我叫張陵,是天一觀的道長晒他。 經常有香客問我吱型,道長,這世上最難降的妖魔是什么陨仅? 我笑而不...
    開封第一講書人閱讀 55,221評論 1 279
  • 正文 為了忘掉前任津滞,我火速辦了婚禮,結果婚禮上灼伤,老公的妹妹穿的比我還像新娘触徐。我一直安慰自己,他們只是感情好狐赡,可當我...
    茶點故事閱讀 64,224評論 5 371
  • 文/花漫 我一把揭開白布撞鹉。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪鸟雏。 梳的紋絲不亂的頭發(fā)上享郊,一...
    開封第一講書人閱讀 49,007評論 1 284
  • 那天,我揣著相機與錄音孝鹊,去河邊找鬼炊琉。 笑死,一個胖子當著我的面吹牛又活,可吹牛的內容都是我干的苔咪。 我是一名探鬼主播,決...
    沈念sama閱讀 38,313評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼柳骄,長吁一口氣:“原來是場噩夢啊……” “哼团赏!你這毒婦竟也來了?” 一聲冷哼從身側響起耐薯,我...
    開封第一講書人閱讀 36,956評論 0 259
  • 序言:老撾萬榮一對情侶失蹤舔清,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后可柿,有當地人在樹林里發(fā)現(xiàn)了一具尸體鸠踪,經...
    沈念sama閱讀 43,441評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡丙者,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,925評論 2 323
  • 正文 我和宋清朗相戀三年复斥,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片械媒。...
    茶點故事閱讀 38,018評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡目锭,死狀恐怖,靈堂內的尸體忽然破棺而出纷捞,到底是詐尸還是另有隱情痢虹,我是刑警寧澤,帶...
    沈念sama閱讀 33,685評論 4 322
  • 正文 年R本政府宣布主儡,位于F島的核電站奖唯,受9級特大地震影響,放射性物質發(fā)生泄漏糜值。R本人自食惡果不足惜丰捷,卻給世界環(huán)境...
    茶點故事閱讀 39,234評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望寂汇。 院中可真熱鬧病往,春花似錦、人聲如沸骄瓣。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至畔勤,卻和暖如春蕾各,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背庆揪。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評論 1 261
  • 我被黑心中介騙來泰國打工示损, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人嚷硫。 一個月前我還...
    沈念sama閱讀 45,467評論 2 352
  • 正文 我出身青樓检访,卻偏偏與公主長得像,于是被迫代替她去往敵國和親仔掸。 傳聞我的和親對象是個殘疾皇子脆贵,可洞房花燭夜當晚...
    茶點故事閱讀 42,762評論 2 345

推薦閱讀更多精彩內容