Playlist Generator  1.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Public Member Functions | Static Public Member Functions | Protected Attributes | Properties
MBProgressHUD Class Reference

#import <MBProgressHUD.h>

List of all members.

Public Member Functions

(id) - initWithWindow:
(id) - initWithView:
(void) - show:
(void) - hide:
(void) - hide:afterDelay:
(void) - showWhileExecuting:onTarget:withObject:animated:

Static Public Member Functions

(MBProgressHUD *) + showHUDAddedTo:animated:
(BOOL) + hideHUDForView:animated:

Protected Attributes

SEL methodForExecution
id targetForExecution
id objectForExecution
BOOL useAnimation
float width
float height
NSTimer * graceTimer
NSTimer * minShowTimer
NSDate * showStarted
UIView * indicator
UILabel * label
UILabel * detailsLabel
BOOL isFinished
CGAffineTransform rotationTransform

Properties

UIView * customView
MBProgressHUDMode mode
MBProgressHUDAnimation animationType
id< MBProgressHUDDelegatedelegate
NSStringlabelText
NSStringdetailsLabelText
float opacity
float xOffset
float yOffset
float margin
BOOL dimBackground
float graceTime
float minShowTime
BOOL taskInProgress
BOOL removeFromSuperViewOnHide
UIFont * labelFont
UIFont * detailsLabelFont
float progress
CGSize minSize
BOOL square

Detailed Description

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 Apples 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 witch resizes depending on the user specified content.

This view supports three modes of operation:


Member Function Documentation

- (void) hide: (BOOL)  animated

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

Parameters:
animatedIf set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.
- (void) hide: (BOOL)  animated
afterDelay: (NSTimeInterval)  delay 

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

Parameters:
animatedIf set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.
delayDelay in secons until the HUD is hidden.
+ (BOOL) hideHUDForView: (UIView *)  view
animated: (BOOL)  animated 

Finds a HUD sibview and hides it. The counterpart to this method is showHUDAddedTo:animated:.

Parameters:
viewThe view that is going to be searched for a HUD subview.
animatedIf set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.
Returns:
YES if a HUD was found and removed, NO otherwise.
See also:
+ hideHUDForView:animated:
- (id) initWithView: (UIView *)  view

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

Parameters:
viewThe view instance that will provide the bounds for the HUD. Should probably be the same instance as the HUD's superview (i.e., the view that the HUD will be added to).
- (id) initWithWindow: (UIWindow *)  window

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

Parameters:
windowThe window instance that will provide the bounds for the HUD. Should probably be the same instance as the HUD's superview (i.e., the window that the HUD will be added to).
- (void) show: (BOOL)  animated

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).

If you need to perform a blocking thask on the main thread, you can try spining the run loop imeidiately after calling this method by using:

[[NSRunLoop currentRunLoop] runUntilDate:[NSDate distantPast]];

Parameters:
animatedIf set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.
+ (MBProgressHUD *) showHUDAddedTo: (UIView *)  view
animated: (BOOL)  animated 

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

Parameters:
viewThe view that the HUD will be added to
animatedIf set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.
Returns:
A reference to the created HUD.
See also:
+ hideHUDForView:animated:
- (void) showWhileExecuting: (SEL)  method
onTarget: (id)  target
withObject: (id)  object
animated: (BOOL)  animated 

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

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

Parameters:
methodThe method to be executed while the HUD is shown. This method will be executed in a new thread.
targetThe object that the target method belongs to.
objectAn optional object to be passed to the method.
animatedIf set to YES the HUD will disappear using the current animationType. If set to NO the HUD will not use animations while disappearing.

Member Data Documentation

- (UILabel*) detailsLabel [protected]
- (NSTimer*) graceTimer [protected]
- (float) height [protected]
- (UIView*) indicator [protected]
- (BOOL) isFinished [protected]
- (UILabel*) label [protected]
- (SEL) methodForExecution [protected]
- (NSTimer*) minShowTimer [protected]
- (id) objectForExecution [protected]
- (CGAffineTransform) rotationTransform [protected]
- (NSDate*) showStarted [protected]
- (id) targetForExecution [protected]
- (BOOL) useAnimation [protected]
- (float) width [protected]

Property Documentation

- (MBProgressHUDAnimation) animationType [read, write, assign]

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

See also:
MBProgressHUDAnimation
- (UIView *) customView [read, write, retain]

The UIView (i.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 build in indicator bounds).

- (id< MBProgressHUDDelegate >) delegate [read, write, assign]

The HUD delegate object. If set the delegate will receive hudWasHidden callbacks when the HUD was hidden. The delegate should conform to the MBProgressHUDDelegate protocol and implement the hudWasHidden method. The delegate object will not be retained.

- (UIFont *) detailsLabelFont [read, write, retain]

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

- (NSString *) detailsLabelText [read, write, copy]

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 ("").

- (BOOL) dimBackground [read, write, assign]

Cover the HUD background view with a radial gradient.

- (float) graceTime [read, write, assign]
- (UIFont *) labelFont [read, write, retain]

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

- (NSString *) labelText [read, write, copy]

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.

- (float) margin [read, write, assign]

The amounth of space between the HUD edge and the HUD elements (labels, indicators or custom views).

Defaults to 20.0

- (float) minShowTime [read, write, assign]

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).

- (CGSize) minSize [read, write, assign]

The minimum size of the HUD bezel. Defaults to CGSizeZero.

- (MBProgressHUDMode) mode [read, write, assign]

MBProgressHUD operation mode. Switches between indeterminate (MBProgressHUDModeIndeterminate) and determinate progress (MBProgressHUDModeDeterminate). The default is MBProgressHUDModeIndeterminate.

See also:
MBProgressHUDMode
- (float) opacity [read, write, assign]

The opacity of the HUD window. Defaults to 0.9 (90% opacity).

- (float) progress [read, write, assign]

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

- (BOOL) removeFromSuperViewOnHide [read, write, assign]

Removes the HUD from it's parent view when hidden. Defaults to NO.

- (BOOL) square [read, write, assign]

Force the HUD dimensions to be equal if possible.

- (BOOL) taskInProgress [read, write, assign]

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 functunality.

- (float) xOffset [read, write, assign]

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

- (float) yOffset [read, write, assign]

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


The documentation for this class was generated from the following files: