MBProgressHUD

1.+ (MB_INSTANCETYPE)showHUDAddedTo:(UIView *)view animated:(BOOL)animated;

 建立一個新的HUD,並把它添加並顯示到提供的視圖上.與之相對應的方法是 hideHUDForView:animated:.

 @note 這個方法會設置HUD的屬性`removeFromSuperViewOnHide`爲YES.HUD會在隱藏時自動從父視圖上移除.

 @param view 將HUD添加到此視圖上.

 @param animated YES,顯示時使用當前的動畫類型顯示;NO,直接顯示不使用動畫效果.

 @return 新建立的HUD.

 @see hideHUDForView:animated:

 @see animationType   

 2.+ (BOOL)hideHUDForView:(UIView *)view animated:(BOOL)animated;

 找到並隱藏子視圖最頂層的HUD.與之對應的方法是 showHUDAddedTo:animated:.

 @note 這個方法會設置HUD的屬性`removeFromSuperViewOnHide`爲YES.HUD會在隱藏時自動從父視圖上移除.

 @param view 用來在其子視圖中查找HUD的視圖.

 @param animated YES,隱藏時使用當前的動畫類型顯示;NO,直接隱藏不使用動畫效果.

 @return YES,若是某個HUD被找到並被移除;不然返回NO.

 @see showHUDAddedTo:animated:

@see animationType

3.+ (NSUInteger)hideAllHUDsForView:(UIView *)view animated:(BOOL)animated;

找到子視圖中全部的HUD,並隱藏.

@note 這個方法會設置HUD的屬性`removeFromSuperViewOnHide`爲YES.HUD會在隱藏時自動從父視圖上移除.

@param view 用來在其子視圖中查找HUD的視圖.

@param animated YES,隱藏時使用當前的動畫類型顯示;NO,直接隱藏不使用動畫效果.

@return 找到並移除的HUD的數量.

@see hideHUDForView:animated:

@see animationType

四、+ (MB_INSTANCETYPE)HUDForView:(UIView *)view;

找到並返回子視圖最頂層的HUD.

@param view 用來在其子視圖中查找HUD的視圖.

@return 子視圖最頂層的HUD.

五、+ (NSArray *)allHUDsForView:(UIView *)view;

 找到並返回子視圖中全部的HUD.

@param view 用來在其子視圖中查找HUD的視圖.

@return 全部找到的HUD視圖(存儲 MBProgressHUD 對象的數組).

六、  - (id)initWithWindow:(UIWindow *)window;

 使用屏幕尺寸建立HUD的便利初始化方法.

@param window 提供邊框值以初始化HUD的窗口.應該和HUD將來的父視圖相同(好比,建立 HUD 後,將HUD添加到此窗口上).

7.   - (id)initWithView:(UIView *)view;

 使用指定視圖的邊框尺寸建立HUD的便利初始化方法.

 @param view 提供邊框值以初始化HUD的視圖.應該和HUD將來的父視圖相同(好比,建立 HUD 後,將HUD添加到此視圖上).

8.  - (void)show:(BOOL)animated;

顯示HUD.你須要確保調用此方法時,主線程未被其餘任務阻塞,以便於更新視圖.當你已經在新的線程中開始(好比,使用NSOperation或者NSURLRequest的異步請求等)執行某個任務後,再執行此方法.

@param animated YES,顯示時使用當前的動畫類型顯示;NO,直接顯示不使用動畫效果. *

@see animationType

9. - (void)hide:(BOOL)animated;

隱藏HUD.這個仍然會去嘗試調用代理的hudWasHidden:方法.此方法是 show: 的配對方法.當你的任務完成時,再使用它.

@param animated YES,隱藏時使用當前的動畫類型顯示;NO,直接隱藏不使用動畫效果.

@see animationType

10.- (void)hide:(BOOL)animated afterDelay:(NSTimeInterval)delay;

 延時隱藏HUD.這個仍然會去嘗試調用代理的hudWasHidden:方法.此方法是 show: 的配對方法.當你的任務完成時,再使用它.

 @param animated YES,隱藏時使用當前的動畫類型顯示;NO,直接隱藏不使用動畫效果.

 @param delay Delay in seconds until the HUD is hidden.

 @see animationType

11.   - (void)showWhileExecuting:(SEL)method onTarget:(id)target withObject:(id)object animated:(BOOL)animated;

 #if NS_BLOCKS_AVAILABLE

當在新線程執行某個後臺任務時,顯示HUD;任務完成時,自動隱藏HUD.

這個方法會處理自動釋放池的相關技術細節,因此你能夠安全使用它.

 @param method HUD顯示期間,被執行的方法.這個方法會在一個新的線程中執行.

 @param target HUD顯示期間,被調用的方法歸屬的實例對象.

 @param object 用來傳遞給方法的可選對象.

 @param animated YES,HUD使用當前的 animationType 動畫類型來顯示或隱藏;不然,顯示或隱藏時不使用動畫效果.

  animations while (dis)appearing.

12.- (void)showAnimated:(BOOL)animated whileExecutingBlock:(dispatch_block_t)block;

當在後臺隊列中執行block時,顯示HUD;並在block執行完畢後,隱藏HUD.

@see showAnimated:whileExecutingBlock:onQueue:completionBlock:

13.- (void)showAnimated:(BOOL)animated whileExecutingBlock:(dispatch_block_t)block completionBlock:(MBProgressHUDCompletionBlock)completion;

  當在後臺隊列中執行block時,顯示HUD;並在block執行完畢後,隱藏HUD.

 @see showAnimated:whileExecutingBlock:onQueue:completionBlock:

14.   - (void)showAnimated:(BOOL)animated whileExecutingBlock:(dispatch_block_t)block onQueue:(dispatch_queue_t)queue;

 當在後臺隊列中執行block時,顯示HUD;並在block執行完畢後,隱藏HUD.

 @see showAnimated:whileExecutingBlock:onQueue:completionBlock:

15.  - (void)showAnimated:(BOOL)animated whileExecutingBlock:(dispatch_block_t)block onQueue:(dispatch_queue_t)queue

            completionBlock:(MBProgressHUDCompletionBlock)completion;

 當在一個指定的隊列中執行block時,顯示HUD;block執行完畢後在主線程執行completion block;而後隱藏HUD.

@param animated YES,HUD使用當前的 animationType 動畫類型來顯示或隱藏;不然,顯示或隱藏時不使用動畫效果.

 @param block HUD顯示期間執行的block.

@param queue block在此隊列中執行.

 @param completion 完成時執行的block.

 @see completionBlock

16.@property (copy) MBProgressHUDCompletionBlock completionBlock;

 HUD徹底隱藏後執行的block.

17.  @property (assign) MBProgressHUDMode mode;

MBProgressHUD 操做模式. 默認是 MBProgressHUDModeIndeterminate.

@see MBProgressHUDMode

18.  @property (assign) MBProgressHUDAnimation animationType;

 HUD顯示和隱藏時使用的動畫類型.

@see MBProgressHUDAnimation

19. @property (MB_STRONG) UIView *customView;

HUD處於MBProgressHUDModeCustomView模式時,顯示此自定義視圖(好比一個 UIImageView).

最好設置自定義視圖寬高爲 37x37(這是HUD內建指示器的邊框值).

20.@property (MB_WEAK) id<MBProgressHUDDelegate> delegate;

 HUD代理對象.

@see MBProgressHUDDelegate

21.    @property (copy) NSString *labelText;

狀態指示器下可選顯示的短消息.HUD會自動調整文字的尺寸. 若是文字過長,後面會用"..."代替.

22.@property (copy) NSString *detailsLabelText;

可選顯示在labelText的細節文字信息.支持多行顯示.

23.@property (assign) float opacity;

HUD的不透明度.默認是0.8.

24.@property (MB_STRONG) UIColor *color;

 HUD的顏色.默認黑色.設置此值後, opacity屬性的值將再也不使用,由於顏色也能夠設置透明度.

25. @property (assign) float xOffset;

 HUD相對於父視圖中心點的水平偏移量.

26.@property (assign) float yOffset;

HUD相對於父視圖中心點的垂直偏移量

27.@property (assign) float margin;

 HUD邊緣與HUD的元素之間(好比標籤,指示器,自定義視圖等)的空白距離.

默認 20.0

28.@property (assign) float cornerRadius;

HUD圓角半徑,默認10.0.

29.@property (assign) BOOL dimBackground;

 是否給父視圖添加一個放射線樣式的遮罩層.默認NO.

30.@property (assign) float graceTime;

用於指定某個方法執行一段時間以後再顯示HUD,以秒記.若是方法在這段時間以前就執行完成,就再也不顯示HUD.

這主要是爲了優化耗時可能極短的任務的體驗.

 默認值爲 0.

這個屬性僅在能夠任務的狀態能夠知曉時,纔有做用.

 @see taskInProgress

31.@property (assign) float minShowTime;

HUD顯示的最小時間(以秒記.)

這能夠避免HUD剛一顯示當即又隱藏所帶來的很差的用戶體驗.

 默認是 0.

32.  @property (assign) BOOL taskInProgress;

指示被執行的操做是否還在執行. graceTime 屬性依賴於這個屬性.

若是你沒有設置graceTime(和設置爲0.0不一樣),這個屬性沒有任何做用.

當使用showWhileExecuting:onTarget:withObject:animated:時,這個值會被自動設置.

當直接使用show:或hide:等方法顯示或隱藏HUD時,你應該手動設置taskInProgress 屬性的值,以保證 graceTime 能正確發揮做用.

33.  @property (assign) BOOL removeFromSuperViewOnHide;

HUD隱藏時,是否從父視圖中移除.

 默認 NO.

34.@property (MB_STRONG) UIFont* labelFont;

 用於主標籤的字體值.

35.@property (MB_STRONG) UIColor* labelColor;

主標籤顏色值.

36.@property (MB_STRONG) UIFont* detailsLabelFont;

詳情標籤字體值.

37.@property (MB_STRONG) UIColor* detailsLabelColor;

詳情標籤顏色.

38.@property (MB_STRONG) UIColor *activityIndicatorColor;

指示器顏色.默認 [UIColor whiteColor]

39.@property (assign) float progress;

進度指示器的顏色,可選 0.0 ~ 1.0,默認0.0.

40.@property (assign) CGSize minSize;

 HUD面板的最小尺寸.默認 CGSizeZero.

41.@property (atomic, assign, readonly) CGSize size;

 HUD面板的實際尺存,只讀.

 你可使用它來限制HUD的可點擊區域.

@see https://github.com/jdg/MBProgressHUD/pull/200

42.  @property (assign, getter = isSquare) BOOL square;

 是否強制設置HUD爲正方形,默認NO.

43.  - (void)hudWasHidden:(MBProgressHUD *)hud;

 HUD徹底從屏幕中隱藏時調用此方法.

44.   @interface MBRoundProgressView : UIView

  一個餅狀圖樣式的進圖指示視圖.

45.@property (nonatomic, assign) float progress;

進度 (0.0 to 1.0)

46.@property (nonatomic, MB_STRONG) UIColor *progressTintColor;

 進度指示器顏色.默認 [UIColor whiteColor].

47. @property (nonatomic, MB_STRONG) UIColor *backgroundTintColor;

 進度指示的背景部分的顏色.

 默認白色半透(透明度0.1)

48.@property (nonatomic, assign, getter = isAnnular) BOOL annular;

     @end

顯示模式.NO,圓形;YES,環形.默認圓形.

49.@interface MBBarProgressView : UIView

一個水平進度條視圖.

50.  @property (nonatomic, assign) float progress;

 進度 (0.0 to 1.0)

51.    @property (nonatomic, MB_STRONG) UIColor *lineColor;

進度條邊框線的顏色.

 默認白色 [UIColor whiteColor]

52.   @property (nonatomic, MB_STRONG) UIColor *progressRemainingColor;

進度條背景色.

 默認是 [UIColor clearColor];

53.  @property (nonatomic, MB_STRONG) UIColor *progressColor;

 進度的顏色.

 默認 [UIColor whiteColor].