Inherits from UIView
Declared in MBProgressHUD.h
MBProgressHUD.m

Overview

Displays a simple HUD window containing a progress indicator and two optional labels for short messages.

This is a simple drop-in class for displaying a progress HUD view similar to Apple’s private UIProgressHUD class. The MBProgressHUD window spans over the entire space given to it by the initWithFrame constructor and catches all user input on this region, thereby preventing the user operations on components below the view. The HUD itself is drawn centered as a rounded semi-transparent view which resizes depending on the user specified content.

This view supports four modes of operation: - MBProgressHUDModeIndeterminate - shows a UIActivityIndicatorView - MBProgressHUDModeDeterminate - shows a custom round progress indicator - MBProgressHUDModeAnnularDeterminate - shows a custom annular progress indicator - MBProgressHUDModeCustomView - shows an arbitrary, user specified view (@see customView)

All three modes can have optional labels assigned: - If the labelText property is set and non-empty then a label containing the provided content is placed below the indicator view. - If also the detailsLabelText property is set then another label is placed below the first label.

Tasks

Properties

animationType

The animation type that should be used when the HUD is shown and hidden.

@property (assign) MBProgressHUDAnimation animationType

Declared In

MBProgressHUD.h

color

The color of the HUD window. Defaults to black. If this property is set, color is set using this UIColor and the opacity property is not used. using retain because performing copy on UIColor base colors (like [UIColor greenColor]) cause problems with the copyZone.

@property (MB_STRONG) UIColor *color

Declared In

MBProgressHUD.h

completionBlock

A block that gets called after the HUD was completely hidden.

@property (copy) MBProgressHUDCompletionBlock completionBlock

Declared In

MBProgressHUD.h

customView

The UIView (e.g., a UIImageView) to be shown when the HUD is in MBProgressHUDModeCustomView. For best results use a 37 by 37 pixel view (so the bounds match the built in indicator bounds).

@property (MB_STRONG) UIView *customView

Declared In

MBProgressHUD.h

delegate

The HUD delegate object.

@property (MB_WEAK) id<MBProgressHUDDelegate> delegate

See Also

Declared In

MBProgressHUD.h

detailsLabelFont

Font to be used for the details label. Set this property if the default is not adequate.

@property (MB_STRONG) UIFont *detailsLabelFont

Declared In

MBProgressHUD.h

detailsLabelText

An optional details message displayed below the labelText message. This message is displayed only if the labelText property is also set and is different from an empty string (@“”). The details text can span multiple lines.

@property (copy) NSString *detailsLabelText

Declared In

MBProgressHUD.h

dimBackground

Cover the HUD background view with a radial gradient.

@property (assign) BOOL dimBackground

Declared In

MBProgressHUD.h

labelFont

Font to be used for the main label. Set this property if the default is not adequate.

@property (MB_STRONG) UIFont *labelFont

Declared In

MBProgressHUD.h

labelText

An optional short message to be displayed below the activity indicator. The HUD is automatically resized to fit the entire text. If the text is too long it will get clipped by displaying “…” at the end. If left unchanged or set to @“”, then no message is displayed.

@property (copy) NSString *labelText

Declared In

MBProgressHUD.h

margin

The amount of space between the HUD edge and the HUD elements (labels, indicators or custom views). Defaults to 20.0

@property (assign) float margin

Declared In

MBProgressHUD.h

minShowTime

The minimum time (in seconds) that the HUD is shown. This avoids the problem of the HUD being shown and than instantly hidden. Defaults to 0 (no minimum show time).

@property (assign) float minShowTime

Declared In

MBProgressHUD.h

minSize

The minimum size of the HUD bezel. Defaults to CGSizeZero (no minimum size).

@property (assign) CGSize minSize

Declared In

MBProgressHUD.h

mode

MBProgressHUD operation mode. The default is MBProgressHUDModeIndeterminate.

@property (assign) MBProgressHUDMode mode

Declared In

MBProgressHUD.h

opacity

The opacity of the HUD window. Defaults to 0.8 (80% opacity).

@property (assign) float opacity

Declared In

MBProgressHUD.h

progress

The progress of the progress indicator, from 0.0 to 1.0. Defaults to 0.0.

@property (assign) float progress

Declared In

MBProgressHUD.h

removeFromSuperViewOnHide

Removes the HUD from its parent view when hidden. Defaults to NO.

@property (assign) BOOL removeFromSuperViewOnHide

Declared In

MBProgressHUD.h

square

Force the HUD dimensions to be equal if possible.

@property (assign, getter=isSquare) BOOL square

Declared In

MBProgressHUD.h

taskInProgress

Indicates that the executed operation is in progress. Needed for correct graceTime operation. If you don’t set a graceTime (different than 0.0) this does nothing. This property is automatically set when using showWhileExecuting:onTarget:withObject:animated:. When threading is done outside of the HUD (i.e., when the show: and hide: methods are used directly), you need to set this property when your task starts and completes in order to have normal graceTime functionality.

@property (assign) BOOL taskInProgress

Declared In

MBProgressHUD.h

xOffset

The x-axis offset of the HUD relative to the centre of the superview.

@property (assign) float xOffset

Declared In

MBProgressHUD.h

yOffset

The y-axis offset of the HUD relative to the centre of the superview.

@property (assign) float yOffset

Declared In

MBProgressHUD.h

Class Methods

HUDForView:

Finds the top-most HUD subview and returns it.

+ (MB_INSTANCETYPE)HUDForView:(UIView *)view

Parameters

view

The view that is going to be searched.

Return Value

A reference to the last HUD subview discovered.

Declared In

MBProgressHUD.h

allHUDsForView:

Finds all HUD subviews and returns them.

+ (NSArray *)allHUDsForView:(UIView *)view

Parameters

view

The view that is going to be searched.

Return Value

All found HUD views (array of MBProgressHUD objects).

Declared In

MBProgressHUD.h

hideAllHUDsForView:animated:

Finds all the HUD subviews and hides them.

+ (NSUInteger)hideAllHUDsForView:(UIView *)view animated:(BOOL)animated

Parameters

view

The view that is going to be searched for HUD subviews.

animated

If set to YES the HUDs will disappear using the current animationType. If set to NO the HUDs will not use animations while disappearing.

Return Value

the number of HUDs found and removed.

See Also

Declared In

MBProgressHUD.h

hideHUDForView:animated:

Finds the top-most HUD subview and hides it. The counterpart to this method is showHUDAddedTo:animated:.

+ (BOOL)hideHUDForView:(UIView *)view animated:(BOOL)animated

Parameters

view

The view that is going to be searched for a HUD subview.

animated

If set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.

Return Value

YES if a HUD was found and removed, NO otherwise.

See Also

Declared In

MBProgressHUD.h

showHUDAddedTo:animated:

Creates a new HUD, adds it to provided view and shows it. The counterpart to this method is hideHUDForView:animated:.

+ (MB_INSTANCETYPE)showHUDAddedTo:(UIView *)view animated:(BOOL)animated

Parameters

view

The view that the HUD will be added to

animated

If set to YES the HUD will appear using the current animationType. If set to NO the HUD will not use animations while appearing.

Return Value

A reference to the created HUD.

See Also

Declared In

MBProgressHUD.h

Instance Methods

hide:

Hide the HUD. This still calls the hudWasHidden: delegate. This is the counterpart of the show: method. Use it to hide the HUD when your task completes.

- (void)hide:(BOOL)animated

Parameters

animated

If set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.

See Also

Declared In

MBProgressHUD.h

hide:afterDelay:

Hide the HUD after a delay. This still calls the hudWasHidden: delegate. This is the counterpart of the show: method. Use it to hide the HUD when your task completes.

- (void)hide:(BOOL)animated afterDelay:(NSTimeInterval)delay

Parameters

animated

If set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.

delay

Delay in seconds until the HUD is hidden.

See Also

Declared In

MBProgressHUD.h

initWithView:

A convenience constructor that initializes the HUD with the view’s bounds. Calls the designated constructor with view.bounds as the parameter

- (id)initWithView:(UIView *)view

Parameters

view

The view instance that will provide the bounds for the HUD. Should be the same instance as the HUD’s superview (i.e., the view that the HUD will be added to).

Declared In

MBProgressHUD.h

initWithWindow:

A convenience constructor that initializes the HUD with the window’s bounds. Calls the designated constructor with window.bounds as the parameter.

- (id)initWithWindow:(UIWindow *)window

Parameters

window

The window instance that will provide the bounds for the HUD. Should be the same instance as the HUD’s superview (i.e., the window that the HUD will be added to).

Declared In

MBProgressHUD.h

show:

Display the HUD. You need to make sure that the main thread completes its run loop soon after this method call so the user interface can be updated. Call this method when your task is already set-up to be executed in a new thread (e.g., when using something like NSOperation or calling an asynchronous call like NSURLRequest).

- (void)show:(BOOL)animated

Parameters

animated

If set to YES the HUD will appear using the current animationType. If set to NO the HUD will not use animations while appearing.

See Also

Declared In

MBProgressHUD.h

showAnimated:whileExecutingBlock:

Shows the HUD while a block is executing on a background queue, then hides the HUD.

- (void)showAnimated:(BOOL)animated whileExecutingBlock:(dispatch_block_t)block

See Also

Declared In

MBProgressHUD.h

showAnimated:whileExecutingBlock:completionBlock:

Shows the HUD while a block is executing on a background queue, then hides the HUD.

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

See Also

Declared In

MBProgressHUD.h

showAnimated:whileExecutingBlock:onQueue:

Shows the HUD while a block is executing on the specified dispatch queue, then hides the HUD.

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

See Also

Declared In

MBProgressHUD.h

showAnimated:whileExecutingBlock:onQueue:completionBlock:

Shows the HUD while a block is executing on the specified dispatch queue, executes completion block on the main queue, and then hides the HUD.

- (void)showAnimated:(BOOL)animated whileExecutingBlock:(dispatch_block_t)block onQueue:(dispatch_queue_t)queue completionBlock:(MBProgressHUDCompletionBlock)completion

Parameters

animated

If set to YES the HUD will (dis)appear using the current animationType. If set to NO the HUD will not use animations while (dis)appearing.

block

The block to be executed while the HUD is shown.

queue

The dispatch queue on which the block should be executed.

completion

The block to be executed on completion.

See Also

Declared In

MBProgressHUD.h

showWhileExecuting:onTarget:withObject:animated:

Shows the HUD while a background task is executing in a new thread, then hides the HUD.

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

Parameters

method

The method to be executed while the HUD is shown. This method will be executed in a new thread.

target

The object that the target method belongs to.

object

An optional object to be passed to the method.

animated

If set to YES the HUD will (dis)appear using the current animationType. If set to NO the HUD will not use animations while (dis)appearing.

Discussion

This method also takes care of autorelease pools so your method does not have to be concerned with setting up a pool.

Declared In

MBProgressHUD.h