diff --git a/.gitignore b/.gitignore index f2c600c..7f8eff1 100644 --- a/.gitignore +++ b/.gitignore @@ -17,4 +17,5 @@ profile *.moved-aside DerivedData .idea/ -Mockup.pxm \ No newline at end of file +Mockup.pxm +Documentation/generate-docs.sh \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUD.html b/Documentation/html/Classes/JGProgressHUD.html new file mode 100644 index 0000000..3c9a65d --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUD.html @@ -0,0 +1,2220 @@ + + + + + + JGProgressHUD Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUD Class Reference

+ + +
+ + + + + + + +
Inherits fromUIView
Declared inJGProgressHUD.h
JGProgressHUD.m
+ + + + +
+ +

Overview

+

A HUD to indicate progress, success, error, warnings or other notifications to the user.

@c JGProgressHUD respects its @c layoutMargins when positioning the HUD view. Additionally, on iOS 11 if @c insetsLayoutMarginsFromSafeArea is set to @c YES (default) the @c layoutMargins additionally contain the @c safeAreaInsets.

Note: Remember to call every method from the main thread! UIKit => main thread! +@attention You may not add JGProgressHUD to a view which has an alpha value < 1.0 or to a view which is a subview of a view with an alpha value < 1.0.

+
+ + + + + +
+ + + + +

Other Methods

+ +
+
+ +

– initWithStyle: +

+ +
+
+ +
+ + +
+

Designated initializer.

+
+ + + +
- (instancetype __nonnull)initWithStyle:(JGProgressHUDStyle)style
+ + + +
+

Parameters

+ + + + + + + +
style

The appearance style of the HUD.

+
+ + + + + + + +
+

Discussion

+

Designated initializer.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

+ progressHUDWithStyle: +

+ +
+
+ +
+ + +
+

Convenience initializer.

+
+ + + +
+ (instancetype __nonnull)progressHUDWithStyle:(JGProgressHUDStyle)style
+ + + +
+

Parameters

+ + + + + + + +
style

The appearance style of the HUD.

+
+ + + + + + + +
+

Discussion

+

Convenience initializer.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  style +

+ +
+
+ +
+ + +
+

The appearance style of the HUD. +@b Default: JGProgressHUDStyleExtraLight.

+
+ + + +
@property (nonatomic, assign, readonly) JGProgressHUDStyle style
+ + + + + + + + + +
+

Discussion

+

The appearance style of the HUD. +@b Default: JGProgressHUDStyleExtraLight.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  targetView +

+ +
+
+ +
+ + +
+

The view in which the HUD is presented.

+
+ + + +
@property (nonatomic, weak, readonly, nullable) UIView *targetView
+ + + + + + + + + +
+

Discussion

+

The view in which the HUD is presented.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

The delegate of the HUD.

+
+ + + +
@property (nonatomic, weak, nullable) id<JGProgressHUDDelegate> delegate
+ + + + + + + + + +
+

Discussion

+

The delegate of the HUD.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  HUDView +

+ +
+
+ +
+ + +
+

The actual HUD view visible on screen. You may add animations to this view.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) UIView *HUDView
+ + + + + + + + + +
+

Discussion

+

The actual HUD view visible on screen. You may add animations to this view.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  contentView +

+ +
+
+ +
+ + +
+

The content view inside the @c HUDView. If you want to add additional views to the HUD you should add them as subview to the @c contentView.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) UIView *contentView
+ + + + + + + + + +
+

Discussion

+

The content view inside the @c HUDView. If you want to add additional views to the HUD you should add them as subview to the @c contentView.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  textLabel +

+ +
+
+ +
+ + +
+

The label used to present text on the HUD. Set the @c text or @c attributedText property of this label to change the displayed text. You may not change the label’s @c frame or @c bounds.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) UILabel *textLabel
+ + + + + + + + + +
+

Discussion

+

The label used to present text on the HUD. Set the @c text or @c attributedText property of this label to change the displayed text. You may not change the label’s @c frame or @c bounds.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  detailTextLabel +

+ +
+
+ +
+ + +
+

The label used to present detail text on the HUD. Set the @c text or @c attributedText property of this label to change the displayed text. You may not change the label’s @c frame or @c bounds.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) UILabel *detailTextLabel
+ + + + + + + + + +
+

Discussion

+

The label used to present detail text on the HUD. Set the @c text or @c attributedText property of this label to change the displayed text. You may not change the label’s @c frame or @c bounds.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  indicatorView +

+ +
+
+ +
+ + +
+

The indicator view. You can assign a custom subclass of @c JGProgressHUDIndicatorView to this property or one of the default indicator views (if you do so, you should assign it before showing the HUD). This value is optional. +@b Default: JGProgressHUDIndeterminateIndicatorView.

+
+ + + +
@property (nonatomic, strong, nullable) JGProgressHUDIndicatorView *indicatorView
+ + + + + + + + + +
+

Discussion

+

The indicator view. You can assign a custom subclass of @c JGProgressHUDIndicatorView to this property or one of the default indicator views (if you do so, you should assign it before showing the HUD). This value is optional. +@b Default: JGProgressHUDIndeterminateIndicatorView.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  shadow +

+ +
+
+ +
+ + +
+

The shadow cast by the @c HUDView. This value is optional. Setting this to @c nil means no shadow is cast by the HUD. +@b Default: nil.

+
+ + + +
@property (nonatomic, strong, nullable) JGProgressHUDShadow *shadow
+ + + + + + + + + +
+

Discussion

+

The shadow cast by the @c HUDView. This value is optional. Setting this to @c nil means no shadow is cast by the HUD. +@b Default: nil.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  position +

+ +
+
+ +
+ + +
+

The position of the HUD inside the hosting view’s frame, or inside the specified frame. +@b Default: JGProgressHUDPositionCenter

+
+ + + +
@property (nonatomic, assign) JGProgressHUDPosition position
+ + + + + + + + + +
+

Discussion

+

The position of the HUD inside the hosting view’s frame, or inside the specified frame. +@b Default: JGProgressHUDPositionCenter

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  animation +

+ +
+
+ +
+ + +
+

The animation used for showing and dismissing the HUD. +@b Default: JGProgressHUDFadeAnimation.

+
+ + + +
@property (nonatomic, strong, nonnull) JGProgressHUDAnimation *animation
+ + + + + + + + + +
+

Discussion

+

The animation used for showing and dismissing the HUD. +@b Default: JGProgressHUDFadeAnimation.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  interactionType +

+ +
+
+ +
+ + +
+

Interaction type of the HUD. Determines whether touches should be let through to the views behind the HUD.

+
+ + + +
@property (nonatomic, assign) JGProgressHUDInteractionType interactionType
+ + + + + + + + + +
+

Discussion

+

Interaction type of the HUD. Determines whether touches should be let through to the views behind the HUD.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  parallaxMode +

+ +
+
+ +
+ + +
+

Parallax mode for the HUD. This setting determines whether the HUD should have a parallax (@c UIDeviceMotion) effect. This effect is controlled by device motion on iOS and remote touchpad panning gestures on tvOS.

+
+ + + +
@property (nonatomic, assign) JGProgressHUDParallaxMode parallaxMode
+ + + + + + + + + +
+

Discussion

+

Parallax mode for the HUD. This setting determines whether the HUD should have a parallax (@c UIDeviceMotion) effect. This effect is controlled by device motion on iOS and remote touchpad panning gestures on tvOS.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  wantsFocus +

+ +
+
+ +
+ + +
+

When this property is set to @c YES the HUD will try to become focused, which prevents interactions with the @c targetView. If set to @c NO the HUD will not become focused and interactions with @c targetView remain possible. Default: @c YES.

+
+ + + +
@property (nonatomic, assign) BOOL wantsFocus
+ + + + + + + + + +
+

Discussion

+

When this property is set to @c YES the HUD will try to become focused, which prevents interactions with the @c targetView. If set to @c NO the HUD will not become focused and interactions with @c targetView remain possible. Default: @c YES.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  square +

+ +
+
+ +
+ + +
+

If the HUD should always have the same width and height. +@b Default: NO.

+
+ + + +
@property (nonatomic, assign) BOOL square
+ + + + + + + + + +
+

Discussion

+

If the HUD should always have the same width and height. +@b Default: NO.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  vibrancyEnabled +

+ +
+
+ +
+ + +
+

Internally @c JGProgressHUD uses an @c UIVisualEffectView with a @c UIBlurEffect. A second @c UIVisualEffectView can be added on top of that with a @c UIVibrancyEffect which amplifies and adjusts the color of content layered behind the view, allowing content placed inside the contentView to become more vivid. This flag sets whether the @c UIVibrancyEffect should be used. Using the vibrancy effect can sometimes, depending on the contents of the display, result in a weird look (especially on iOS < 9.3). +@b Default: NO.

+
+ + + +
@property (nonatomic, assign) BOOL vibrancyEnabled
+ + + + + + + + + +
+

Discussion

+

Internally @c JGProgressHUD uses an @c UIVisualEffectView with a @c UIBlurEffect. A second @c UIVisualEffectView can be added on top of that with a @c UIVibrancyEffect which amplifies and adjusts the color of content layered behind the view, allowing content placed inside the contentView to become more vivid. This flag sets whether the @c UIVibrancyEffect should be used. Using the vibrancy effect can sometimes, depending on the contents of the display, result in a weird look (especially on iOS < 9.3). +@b Default: NO.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  cornerRadius +

+ +
+
+ +
+ + +
+

The radius used for rounding the four corners of the HUD view. +@b Default: 10.0.

+
+ + + +
@property (nonatomic, assign) CGFloat cornerRadius
+ + + + + + + + + +
+

Discussion

+

The radius used for rounding the four corners of the HUD view. +@b Default: 10.0.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  contentInsets +

+ +
+
+ +
+ + +
+

Insets the contents of the HUD. +@b Default: (20, 20, 20, 20).

+
+ + + +
@property (nonatomic, assign) UIEdgeInsets contentInsets
+ + + + + + + + + +
+

Discussion

+

Insets the contents of the HUD. +@b Default: (20, 20, 20, 20).

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  ) +

+ +
+
+ +
+ + +
+

Insets the HUD from the frame of the hosting view or from the specified frame to present the HUD from. +@b Default: (20, 20, 20, 20).

+
+ + + +
@property (nonatomic, assign) UIEdgeInsets marginInsets __attribute ( ( deprecated ( ( "Use layoutMargins instead." )
+ + + + + + + + + +
+

Discussion

+

Insets the HUD from the frame of the hosting view or from the specified frame to present the HUD from. +@b Default: (20, 20, 20, 20).

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  visible +

+ +
+
+ +
+ + +
+

Whether the HUD is visible on screen.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isVisible) BOOL visible
+ + + + + +
+

Return Value

+

Whether the HUD is visible on screen.

+
+ + + + + + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  progress +

+ +
+
+ +
+ + +
+

The progress to display using the @c progressIndicatorView. A change of this property is not animated. Use the @c setProgress:animated: method for an animated progress change. +@b Default: 0.0.

+
+ + + +
@property (nonatomic, assign) float progress
+ + + + + + + + + +
+

Discussion

+

The progress to display using the @c progressIndicatorView. A change of this property is not animated. Use the @c setProgress:animated: method for an animated progress change. +@b Default: 0.0.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– setProgress:animated: +

+ +
+
+ +
+ + +
+

Adjusts the current progress shown by the receiver, optionally animating the change.

+
+ + + +
- (void)setProgress:(float)progress animated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + + + + + + +
progress

The new progress value.

animated

YES if the change should be animated, NO if the change should happen immediately.

+
+ + + + + + + +
+

Discussion

+

Adjusts the current progress shown by the receiver, optionally animating the change.

+ +

The current progress is represented by a floating-point value between 0.0 and 1.0, inclusive, where 1.0 indicates the completion of the task. The default value is 0.0. Values less than 0.0 and greater than 1.0 are pinned to those limits.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  minimumDisplayTime +

+ +
+
+ +
+ + +
+

Specifies a minimum time that the HUD will be on-screen. Useful to prevent the HUD from flashing quickly on the screen when indeterminate tasks complete more quickly than expected. +@b Default: 0.0.

+
+ + + +
@property (nonatomic, assign) NSTimeInterval minimumDisplayTime
+ + + + + + + + + +
+

Discussion

+

Specifies a minimum time that the HUD will be on-screen. Useful to prevent the HUD from flashing quickly on the screen when indeterminate tasks complete more quickly than expected. +@b Default: 0.0.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  voiceOverEnabled +

+ +
+
+ +
+ + +
+

Determines whether Voice Over announcements should be made upon displaying the HUD (if Voice Over is active). +@b Default: YES

+
+ + + +
@property (nonatomic, assign) BOOL voiceOverEnabled
+ + + + + + + + + +
+

Discussion

+

Determines whether Voice Over announcements should be made upon displaying the HUD (if Voice Over is active). +@b Default: YES

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  tapOnHUDViewBlock +

+ +
+
+ +
+ + +
+

A block to be invoked when the HUD view is tapped.

+
+ + + +
@property (nonatomic, copy, nullable) void ( ^ ) ( JGProgressHUD *__nonnull HUD ) tapOnHUDViewBlock
+ + + + + + + + + +
+

Discussion

+

A block to be invoked when the HUD view is tapped.

Note: The interaction type of the HUD must be @c JGProgressHUDInteractionTypeBlockTouchesOnHUDView or @c JGProgressHUDInteractionTypeBlockAllTouches, otherwise this block won’t be fired.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

  tapOutsideBlock +

+ +
+
+ +
+ + +
+

A block to be invoked when the area outside of the HUD view is tapped.

+
+ + + +
@property (nonatomic, copy, nullable) void ( ^ ) ( JGProgressHUD *__nonnull HUD ) tapOutsideBlock
+ + + + + + + + + +
+

Discussion

+

A block to be invoked when the area outside of the HUD view is tapped.

Note: The interaction type of the HUD must be @c JGProgressHUDInteractionTypeBlockAllTouches, otherwise this block won’t be fired.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– showInView: +

+ +
+
+ +
+ + +
+

Shows the HUD animated. You should preferably show the HUD in a UIViewController’s view. The HUD will be repositioned in response to rotation and keyboard show/hide notifications.

+
+ + + +
- (void)showInView:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + +
view

The view to show the HUD in. The frame of the @c view will be used to calculate the position of the HUD.

+
+ + + + + + + +
+

Discussion

+

Shows the HUD animated. You should preferably show the HUD in a UIViewController’s view. The HUD will be repositioned in response to rotation and keyboard show/hide notifications.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– showInView:animated: +

+ +
+
+ +
+ + +
+

Shows the HUD. You should preferably show the HUD in a UIViewController’s view. The HUD will be repositioned in response to rotation and keyboard show/hide notifications.

+
+ + + +
- (void)showInView:(UIView *__nonnull)view animated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + + + + + + +
view

The view to show the HUD in. The frame of the @c view will be used to calculate the position of the HUD.

animated

If the HUD should show with an animation.

+
+ + + + + + + +
+

Discussion

+

Shows the HUD. You should preferably show the HUD in a UIViewController’s view. The HUD will be repositioned in response to rotation and keyboard show/hide notifications.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– dismiss +

+ +
+
+ +
+ + +
+

Dismisses the HUD animated.

+
+ + + +
- (void)dismiss
+ + + + + + + + + +
+

Discussion

+

Dismisses the HUD animated.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– dismissAnimated: +

+ +
+
+ +
+ + +
+

Dismisses the HUD.

+
+ + + +
- (void)dismissAnimated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + +
animated

If the HUD should dismiss with an animation.

+
+ + + + + + + +
+

Discussion

+

Dismisses the HUD.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– dismissAfterDelay: +

+ +
+
+ +
+ + +
+

Dismisses the HUD animated after a delay.

+
+ + + +
- (void)dismissAfterDelay:(NSTimeInterval)delay
+ + + +
+

Parameters

+ + + + + + + +
delay

The delay until the HUD will be dismissed.

+
+ + + + + + + +
+

Discussion

+

Dismisses the HUD animated after a delay.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– dismissAfterDelay:animated: +

+ +
+
+ +
+ + +
+

Dismisses the HUD after a delay.

+
+ + + +
- (void)dismissAfterDelay:(NSTimeInterval)delay animated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + + + + + + +
delay

The delay until the HUD will be dismissed.

animated

If the HUD should dismiss with an animation.

+
+ + + + + + + +
+

Discussion

+

Dismisses the HUD after a delay.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+
+ + + +

HUDManagement Methods

+ +
+
+ +

+ allProgressHUDsInView: +

+ +
+
+ +
+ + +
+

The view to return all visible progress HUDs for.

+
+ + + +
+ (NSArray<JGProgressHUD*> *__nonnull)allProgressHUDsInView:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + +
view

The view to return all visible progress HUDs for.

+
+ + + +
+

Return Value

+

All visible progress HUDs in the view.

+
+ + + + + + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

+ allProgressHUDsInViewHierarchy: +

+ +
+
+ +
+ + +
+

The view to return all visible progress HUDs for.

+
+ + + +
+ (NSArray<JGProgressHUD*> *__nonnull)allProgressHUDsInViewHierarchy:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + +
view

The view to return all visible progress HUDs for.

+
+ + + +
+

Return Value

+

All visible progress HUDs in the view and its subviews.

+
+ + + + + + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+
+ + + +

Deprecated Methods

+ +
+
+ +

– showInRect:inView: +

+ +
+
+ +
+ + +
+

Shows the HUD animated. You should preferably show the HUD in a UIViewController’s view.

+
+ + + +
- (void)showInRect:(CGRect)rect inView:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + + + + + + +
rect

The rect allocated in @c view for displaying the HUD.

view

The view to show the HUD in.

+
+ + + + + + + +
+

Discussion

+

Shows the HUD animated. You should preferably show the HUD in a UIViewController’s view.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– showInRect:inView:animated: +

+ +
+
+ +
+ + +
+

Shows the HUD. You should preferably show the HUD in a UIViewController’s view.

+
+ + + +
- (void)showInRect:(CGRect)rect inView:(UIView *__nonnull)view animated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
rect

The rect allocated in @c view for displaying the HUD.

view

The view to show the HUD in.

animated

If the HUD should show with an animation.

+
+ + + + + + + +
+

Discussion

+

Shows the HUD. You should preferably show the HUD in a UIViewController’s view.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDAnimation.html b/Documentation/html/Classes/JGProgressHUDAnimation.html new file mode 100644 index 0000000..f42625f --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDAnimation.html @@ -0,0 +1,402 @@ + + + + + + JGProgressHUDAnimation Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDAnimation Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inJGProgressHUDAnimation.h
JGProgressHUDAnimation.m
+ + + + +
+ +

Overview

+

You may subclass this class to create a custom progress indicator view.

+
+ + + + + +
+ + + + +

Other Methods

+ +
+
+ +

+ animation +

+ +
+
+ +
+ + +
+

Convenience initializer.

+
+ + + +
+ (instancetype)animation
+ + + + + + + + + +
+

Discussion

+

Convenience initializer.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+ +

– show +

+ +
+
+ +
+ + +
+

The @c progressHUD is hidden from screen with @c alpha = 1 and @c hidden = @c YES. Ideally, you should prepare the HUD for presentation, then set @c hidden to @c NO on the @c progressHUD and then perform the animation. + @post Call @c animationFinished.

+
+ + + +
- (void)show
+ + + + + + + + + +
+

Discussion

+

The @c progressHUD is hidden from screen with @c alpha = 1 and @c hidden = @c YES. Ideally, you should prepare the HUD for presentation, then set @c hidden to @c NO on the @c progressHUD and then perform the animation. + @post Call @c animationFinished.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+ +

– hide +

+ +
+
+ +
+ + +
+

The @c progressHUD wis visible on screen with @c alpha = 1 and @c hidden = @c NO. You should only perform the animation in this method, the @c progressHUD itself will take care of hiding itself and removing itself from superview. +@post Call @c animationFinished.

+
+ + + +
- (void)hide
+ + + + + + + + + +
+

Discussion

+

The @c progressHUD wis visible on screen with @c alpha = 1 and @c hidden = @c NO. You should only perform the animation in this method, the @c progressHUD itself will take care of hiding itself and removing itself from superview. +@post Call @c animationFinished.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+ +

– animationFinished +

+ +
+
+ +
+ + +
+

@pre This method should only be called at the end of a @c show or @c hide animaiton. +@attention ALWAYS call this method after completing a @c show or @c hide animation.

+
+ + + +
- (void)animationFinished
+ + + + + + + + + +
+

Discussion

+

@pre This method should only be called at the end of a @c show or @c hide animaiton. +@attention ALWAYS call this method after completing a @c show or @c hide animation.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+
+ + + +

Other Methods

+ +
+
+ +

  progressHUD +

+ +
+
+ +
+ + +
+

The HUD using this animation.

+
+ + + +
@property (nonatomic, weak, readonly, nullable) JGProgressHUD *progressHUD
+ + + + + + + + + +
+

Discussion

+

The HUD using this animation.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDErrorIndicatorView.html b/Documentation/html/Classes/JGProgressHUDErrorIndicatorView.html new file mode 100644 index 0000000..166fe08 --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDErrorIndicatorView.html @@ -0,0 +1,344 @@ + + + + + + JGProgressHUDErrorIndicatorView Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDErrorIndicatorView Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDImageIndicatorView : JGProgressHUDIndicatorView : UIView
Declared inJGProgressHUDErrorIndicatorView.h
JGProgressHUDErrorIndicatorView.m
+ + + + +
+ +

Overview

+

An image indicator showing a cross, representing a failed operation.

+
+ + + + + +
+ + + + + + +
+
+ +

– initWithContentView: +

+ +
+
+ +
+ + +
+

Designated initializer for this class.

+
+ + + +
- (instancetype)initWithContentView:(UIView *__unused)contentView
+ + + +
+

Parameters

+ + + + + + + +
contentView

The content view to place on the container view (the container is the JGProgressHUDIndicatorView).

+
+ + + + + + + +
+

Discussion

+

Designated initializer for this class.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Default initializer for this class.

+
+ + + +
- (instancetype)init
+ + + + + + + + + +
+

Discussion

+

Default initializer for this class.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDErrorIndicatorView.h

+
+ + +
+
+
+ +

– updateAccessibility +

+ +
+
+ +
+ + +
+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + +
- (void)updateAccessibility
+ + + + + + + + + +
+

Discussion

+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setUpForHUDStyle:vibrancyEnabled: +

+ +
+
+ +
+ + +
+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + +
- (void)setUpForHUDStyle:(JGProgressHUDStyle)style vibrancyEnabled:(BOOL)vibrancyEnabled
+ + + + + + + + + +
+

Discussion

+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDFadeAnimation.html b/Documentation/html/Classes/JGProgressHUDFadeAnimation.html new file mode 100644 index 0000000..69386d8 --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDFadeAnimation.html @@ -0,0 +1,352 @@ + + + + + + JGProgressHUDFadeAnimation Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDFadeAnimation Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDAnimation : NSObject
Declared inJGProgressHUDFadeAnimation.h
JGProgressHUDFadeAnimation.m
+ + + + +
+ +

Overview

+

A simple fade animation that fades the HUD from alpha @c 0.0 to alpha @c 1.0.

+
+ + + + + +
+ + + + +

Other Methods

+ +
+
+ +

  duration +

+ +
+
+ +
+ + +
+

Duration of the animation.

+
+ + + +
@property (nonatomic, assign) NSTimeInterval duration
+ + + + + + + + + +
+

Discussion

+

Duration of the animation.

+ +

@b Default: 0.4.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDFadeAnimation.h

+
+ + +
+
+
+ +

  animationOptions +

+ +
+
+ +
+ + +
+

Animation options

+
+ + + +
@property (nonatomic, assign) UIViewAnimationOptions animationOptions
+ + + + + + + + + +
+

Discussion

+

Animation options

+ +

@b Default: UIViewAnimationOptionCurveEaseInOut.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDFadeAnimation.h

+
+ + +
+
+
+
+ + + +

Other Methods

+ +
+
+ +

– show +

+ +
+
+ +
+ + +
+

The @c progressHUD is hidden from screen with @c alpha = 1 and @c hidden = @c YES. Ideally, you should prepare the HUD for presentation, then set @c hidden to @c NO on the @c progressHUD and then perform the animation. + @post Call @c animationFinished.

+
+ + + +
- (void)show
+ + + + + + + + + +
+

Discussion

+

The @c progressHUD is hidden from screen with @c alpha = 1 and @c hidden = @c YES. Ideally, you should prepare the HUD for presentation, then set @c hidden to @c NO on the @c progressHUD and then perform the animation. + @post Call @c animationFinished.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+ +

– hide +

+ +
+
+ +
+ + +
+

The @c progressHUD wis visible on screen with @c alpha = 1 and @c hidden = @c NO. You should only perform the animation in this method, the @c progressHUD itself will take care of hiding itself and removing itself from superview. +@post Call @c animationFinished.

+
+ + + +
- (void)hide
+ + + + + + + + + +
+

Discussion

+

The @c progressHUD wis visible on screen with @c alpha = 1 and @c hidden = @c NO. You should only perform the animation in this method, the @c progressHUD itself will take care of hiding itself and removing itself from superview. +@post Call @c animationFinished.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDFadeZoomAnimation.html b/Documentation/html/Classes/JGProgressHUDFadeZoomAnimation.html new file mode 100644 index 0000000..ce03024 --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDFadeZoomAnimation.html @@ -0,0 +1,402 @@ + + + + + + JGProgressHUDFadeZoomAnimation Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDFadeZoomAnimation Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDAnimation : NSObject
Declared inJGProgressHUDFadeZoomAnimation.h
JGProgressHUDFadeZoomAnimation.m
+ + + + +
+ +

Overview

+

An animation that fades in the HUD and expands the HUD from scale @c (0, 0) to a customizable scale, and finally to scale @c (1, 1), creating a bouncing effect.

+
+ + + + + +
+ + + + +

Other Methods

+ +
+
+ +

– show +

+ +
+
+ +
+ + +
+

The @c progressHUD is hidden from screen with @c alpha = 1 and @c hidden = @c YES. Ideally, you should prepare the HUD for presentation, then set @c hidden to @c NO on the @c progressHUD and then perform the animation. + @post Call @c animationFinished.

+
+ + + +
- (void)show
+ + + + + + + + + +
+

Discussion

+

The @c progressHUD is hidden from screen with @c alpha = 1 and @c hidden = @c YES. Ideally, you should prepare the HUD for presentation, then set @c hidden to @c NO on the @c progressHUD and then perform the animation. + @post Call @c animationFinished.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+ +

– hide +

+ +
+
+ +
+ + +
+

The @c progressHUD wis visible on screen with @c alpha = 1 and @c hidden = @c NO. You should only perform the animation in this method, the @c progressHUD itself will take care of hiding itself and removing itself from superview. +@post Call @c animationFinished.

+
+ + + +
- (void)hide
+ + + + + + + + + +
+

Discussion

+

The @c progressHUD wis visible on screen with @c alpha = 1 and @c hidden = @c NO. You should only perform the animation in this method, the @c progressHUD itself will take care of hiding itself and removing itself from superview. +@post Call @c animationFinished.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDAnimation.h

+
+ + +
+
+
+
+ + + +

Other Methods

+ +
+
+ +

  shrinkAnimationDuaration +

+ +
+
+ +
+ + +
+

Duration of the animation from or to the shrinked state.

+
+ + + +
@property (nonatomic, assign) NSTimeInterval shrinkAnimationDuaration
+ + + + + + + + + +
+

Discussion

+

Duration of the animation from or to the shrinked state.

+ +

@b Default: 0.2.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDFadeZoomAnimation.h

+
+ + +
+
+
+ +

  expandAnimationDuaration +

+ +
+
+ +
+ + +
+

Duration of the animation from or to the expanded state.

+
+ + + +
@property (nonatomic, assign) NSTimeInterval expandAnimationDuaration
+ + + + + + + + + +
+

Discussion

+

Duration of the animation from or to the expanded state.

+ +

@b Default: 0.1.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDFadeZoomAnimation.h

+
+ + +
+
+
+ +

  expandScale +

+ +
+
+ +
+ + +
+

The scale to apply to the HUD when expanding.

+
+ + + +
@property (nonatomic, assign) CGSize expandScale
+ + + + + + + + + +
+

Discussion

+

The scale to apply to the HUD when expanding.

+ +

@b Default: (1.1, 1.1).

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDFadeZoomAnimation.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDImageIndicatorView.html b/Documentation/html/Classes/JGProgressHUDImageIndicatorView.html new file mode 100644 index 0000000..fa692bb --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDImageIndicatorView.html @@ -0,0 +1,202 @@ + + + + + + JGProgressHUDImageIndicatorView Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDImageIndicatorView Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDIndicatorView : UIView
Declared inJGProgressHUDImageIndicatorView.h
JGProgressHUDImageIndicatorView.m
+ + + + +
+ +

Overview

+

An indicator for displaying custom images. Supports animated images.

+ +

You may subclass this class to create a custom image indicator view.

+
+ + + + + +
+ + + + + + +
+
+ +

– initWithImage: +

+ +
+
+ +
+ + +
+

Initializes the indicator view with an UIImageView showing the @c image.

+
+ + + +
- (instancetype __nonnull)initWithImage:(UIImage *__nonnull)image
+ + + +
+

Parameters

+ + + + + + + +
image

The image to show in the indicator view.

+
+ + + + + + + +
+

Discussion

+

Initializes the indicator view with an UIImageView showing the @c image.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDImageIndicatorView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDIndeterminateIndicatorView.html b/Documentation/html/Classes/JGProgressHUDIndeterminateIndicatorView.html new file mode 100644 index 0000000..777c462 --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDIndeterminateIndicatorView.html @@ -0,0 +1,344 @@ + + + + + + JGProgressHUDIndeterminateIndicatorView Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDIndeterminateIndicatorView Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDIndicatorView : UIView
Declared inJGProgressHUDIndeterminateIndicatorView.h
JGProgressHUDIndeterminateIndicatorView.m
+ + + + +
+ +

Overview

+

An indeterminate progress indicator showing a @c UIActivityIndicatorView.

+
+ + + + + +
+ + + + + + +
+
+ +

– initWithHUDStyle: +

+ +
+
+ +
+ + +
+

Initializes the indicator view and sets the correct color to match the HUD style.

+
+ + + +
- (instancetype)initWithHUDStyle:(JGProgressHUDStyle)style
+ + + + + + + + + +
+

Discussion

+

Initializes the indicator view and sets the correct color to match the HUD style.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndeterminateIndicatorView.h

+
+ + +
+
+
+ +

– setUpForHUDStyle:vibrancyEnabled: +

+ +
+
+ +
+ + +
+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + +
- (void)setUpForHUDStyle:(JGProgressHUDStyle)style vibrancyEnabled:(BOOL)vibrancyEnabled
+ + + + + + + + + +
+

Discussion

+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setColor: +

+ +
+
+ +
+ + +
+

Set the color of the activity indicator view.

+
+ + + +
- (void)setColor:(UIColor *)color
+ + + +
+

Parameters

+ + + + + + + +
color

The color to apply to the activity indicator view.

+
+ + + + + + + +
+

Discussion

+

Set the color of the activity indicator view.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndeterminateIndicatorView.h

+
+ + +
+
+
+ +

– updateAccessibility +

+ +
+
+ +
+ + +
+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + +
- (void)updateAccessibility
+ + + + + + + + + +
+

Discussion

+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDIndicatorView.html b/Documentation/html/Classes/JGProgressHUDIndicatorView.html new file mode 100644 index 0000000..4c15488 --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDIndicatorView.html @@ -0,0 +1,559 @@ + + + + + + JGProgressHUDIndicatorView Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDIndicatorView Class Reference

+ + +
+ + + + + + + +
Inherits fromUIView
Declared inJGProgressHUDIndicatorView.h
JGProgressHUDIndicatorView.m
+ + + + +
+ +

Overview

+

You may subclass this class to create a custom progress indicator view.

+
+ + + + + +
+ + + + + + +
+
+ +

– initWithContentView: +

+ +
+
+ +
+ + +
+

Designated initializer for this class.

+
+ + + +
- (instancetype __nonnull)initWithContentView:(UIView *__nullable)contentView
+ + + +
+

Parameters

+ + + + + + + +
contentView

The content view to place on the container view (the container is the JGProgressHUDIndicatorView).

+
+ + + + + + + +
+

Discussion

+

Designated initializer for this class.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setUpForHUDStyle:vibrancyEnabled: +

+ +
+
+ +
+ + +
+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + +
- (void)setUpForHUDStyle:(JGProgressHUDStyle)style vibrancyEnabled:(BOOL)vibrancyEnabled
+ + + + + + + + + +
+

Discussion

+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

  progress +

+ +
+
+ +
+ + +
+

Ranges from 0.0 to 1.0.

+
+ + + +
@property (nonatomic, assign) float progress
+ + + + + + + + + +
+

Discussion

+

Ranges from 0.0 to 1.0.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setProgress:animated: +

+ +
+
+ +
+ + +
+

Adjusts the current progress shown by the receiver, optionally animating the change.

+
+ + + +
- (void)setProgress:(float)progress animated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + + + + + + +
progress

The new progress value.

animated

YES if the change should be animated, NO if the change should happen immediately.

+
+ + + + + + + +
+

Discussion

+

Adjusts the current progress shown by the receiver, optionally animating the change.

+ +

The current progress is represented by a floating-point value between 0.0 and 1.0, inclusive, where 1.0 indicates the completion of the task. The default value is 0.0. Values less than 0.0 and greater than 1.0 are pinned to those limits.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

  contentView +

+ +
+
+ +
+ + +
+

The content view which displays the progress.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) UIView *contentView
+ + + + + + + + + +
+

Discussion

+

The content view which displays the progress.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setNeedsAccessibilityUpdate +

+ +
+
+ +
+ + +
+

Schedules an accessibility update on the next run loop.

+
+ + + +
- (void)setNeedsAccessibilityUpdate
+ + + + + + + + + +
+

Discussion

+

Schedules an accessibility update on the next run loop.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– updateAccessibilityIfNeeded +

+ +
+
+ +
+ + +
+

Runs @c updateAccessibility immediately if an accessibility update has been scheduled (through @c setNeedsAccessibilityUpdate) but has not executed yet.

+
+ + + +
- (void)updateAccessibilityIfNeeded
+ + + + + + + + + +
+

Discussion

+

Runs @c updateAccessibility immediately if an accessibility update has been scheduled (through @c setNeedsAccessibilityUpdate) but has not executed yet.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– updateAccessibility +

+ +
+
+ +
+ + +
+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + +
- (void)updateAccessibility
+ + + + + + + + + +
+

Discussion

+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDPieIndicatorView.html b/Documentation/html/Classes/JGProgressHUDPieIndicatorView.html new file mode 100644 index 0000000..65b00d5 --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDPieIndicatorView.html @@ -0,0 +1,479 @@ + + + + + + JGProgressHUDPieIndicatorView Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDPieIndicatorView Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDIndicatorView : UIView
Declared inJGProgressHUDPieIndicatorView.h
JGProgressHUDPieIndicatorView.m
+ + + + +
+ +

Overview

+

A pie shaped determinate progress indicator.

+
+ + + + + +
+ + + + +

Other Methods

+ +
+
+ +

– initWithHUDStyle: +

+ +
+
+ +
+ + +
+

Initializes the indicator view and sets the correct color to match the HUD style.

+
+ + + +
- (instancetype __nonnull)initWithHUDStyle:(JGProgressHUDStyle)style
+ + + + + + + + + +
+

Discussion

+

Initializes the indicator view and sets the correct color to match the HUD style.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDPieIndicatorView.h

+
+ + +
+
+
+ +

  color +

+ +
+
+ +
+ + +
+

Tint color of the Pie. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+
+ + + +
@property (nonatomic, strong, nonnull) UIColor *color
+ + + + + + + + + +
+

Discussion

+

Tint color of the Pie. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+ +

@b Default: White for JGProgressHUDStyleDark, otherwise black.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDPieIndicatorView.h

+
+ + +
+
+
+ +

  fillColor +

+ +
+
+ +
+ + +
+

The background fill color inside the pie. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+
+ + + +
@property (nonatomic, strong, nonnull) UIColor *fillColor
+ + + + + + + + + +
+

Discussion

+

The background fill color inside the pie. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+ +

@b Default: Dark gray for JGProgressHUDStyleDark, otherwise light gray.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDPieIndicatorView.h

+
+ + +
+
+
+
+ + + +

Other Methods

+ +
+
+ +

– initWithContentView: +

+ +
+
+ +
+ + +
+

Designated initializer for this class.

+
+ + + +
- (instancetype)initWithContentView:(UIView *)contentView
+ + + +
+

Parameters

+ + + + + + + +
contentView

The content view to place on the container view (the container is the JGProgressHUDIndicatorView).

+
+ + + + + + + +
+

Discussion

+

Designated initializer for this class.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setProgress:animated: +

+ +
+
+ +
+ + +
+

Adjusts the current progress shown by the receiver, optionally animating the change.

+
+ + + +
- (void)setProgress:(float)progress animated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + + + + + + +
progress

The new progress value.

animated

YES if the change should be animated, NO if the change should happen immediately.

+
+ + + + + + + +
+

Discussion

+

Adjusts the current progress shown by the receiver, optionally animating the change.

+ +

The current progress is represented by a floating-point value between 0.0 and 1.0, inclusive, where 1.0 indicates the completion of the task. The default value is 0.0. Values less than 0.0 and greater than 1.0 are pinned to those limits.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setUpForHUDStyle:vibrancyEnabled: +

+ +
+
+ +
+ + +
+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + +
- (void)setUpForHUDStyle:(JGProgressHUDStyle)style vibrancyEnabled:(BOOL)vibrancyEnabled
+ + + + + + + + + +
+

Discussion

+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDRingIndicatorView.html b/Documentation/html/Classes/JGProgressHUDRingIndicatorView.html new file mode 100644 index 0000000..f980a01 --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDRingIndicatorView.html @@ -0,0 +1,579 @@ + + + + + + JGProgressHUDRingIndicatorView Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDRingIndicatorView Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDIndicatorView : UIView
Declared inJGProgressHUDRingIndicatorView.h
JGProgressHUDRingIndicatorView.m
+ + + + +
+ +

Overview

+

A ring shaped determinate progress indicator.

+
+ + + + + +
+ + + + +

Other Methods

+ +
+
+ +

– initWithHUDStyle: +

+ +
+
+ +
+ + +
+

Initializes the indicator view and sets the correct color to match the HUD style.

+
+ + + +
- (instancetype __nonnull)initWithHUDStyle:(JGProgressHUDStyle)style
+ + + + + + + + + +
+

Discussion

+

Initializes the indicator view and sets the correct color to match the HUD style.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDRingIndicatorView.h

+
+ + +
+
+
+ +

  ringBackgroundColor +

+ +
+
+ +
+ + +
+

Background color of the ring. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+
+ + + +
@property (nonatomic, strong, nonnull) UIColor *ringBackgroundColor
+ + + + + + + + + +
+

Discussion

+

Background color of the ring. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+ +

@b Default: Black for JGProgressHUDStyleDark, light gray otherwise.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDRingIndicatorView.h

+
+ + +
+
+
+ +

  ringColor +

+ +
+
+ +
+ + +
+

Progress color of the progress ring. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+
+ + + +
@property (nonatomic, strong, nonnull) UIColor *ringColor
+ + + + + + + + + +
+

Discussion

+

Progress color of the progress ring. +@attention Custom values need to be set after assigning the indicator view to @c JGProgressHUD’s @c indicatorView property.

+ +

@b Default: White for JGProgressHUDStyleDark, otherwise black.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDRingIndicatorView.h

+
+ + +
+
+
+ +

  roundProgressLine +

+ +
+
+ +
+ + +
+

Sets if the progress ring should have a rounded line cap.

+
+ + + +
@property (nonatomic, assign) BOOL roundProgressLine
+ + + + + + + + + +
+

Discussion

+

Sets if the progress ring should have a rounded line cap.

+ +

@b Default: NO.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDRingIndicatorView.h

+
+ + +
+
+
+ +

  ringWidth +

+ +
+
+ +
+ + +
+

Width of the ring.

+
+ + + +
@property (nonatomic, assign) CGFloat ringWidth
+ + + + + + + + + +
+

Discussion

+

Width of the ring.

+ +

@b Default: 3.0.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDRingIndicatorView.h

+
+ + +
+
+
+
+ + + +

Other Methods

+ +
+
+ +

– initWithContentView: +

+ +
+
+ +
+ + +
+

Designated initializer for this class.

+
+ + + +
- (instancetype)initWithContentView:(UIView *)contentView
+ + + +
+

Parameters

+ + + + + + + +
contentView

The content view to place on the container view (the container is the JGProgressHUDIndicatorView).

+
+ + + + + + + +
+

Discussion

+

Designated initializer for this class.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setProgress:animated: +

+ +
+
+ +
+ + +
+

Adjusts the current progress shown by the receiver, optionally animating the change.

+
+ + + +
- (void)setProgress:(float)progress animated:(BOOL)animated
+ + + +
+

Parameters

+ + + + + + + + + + + + +
progress

The new progress value.

animated

YES if the change should be animated, NO if the change should happen immediately.

+
+ + + + + + + +
+

Discussion

+

Adjusts the current progress shown by the receiver, optionally animating the change.

+ +

The current progress is represented by a floating-point value between 0.0 and 1.0, inclusive, where 1.0 indicates the completion of the task. The default value is 0.0. Values less than 0.0 and greater than 1.0 are pinned to those limits.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setUpForHUDStyle:vibrancyEnabled: +

+ +
+
+ +
+ + +
+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + +
- (void)setUpForHUDStyle:(JGProgressHUDStyle)style vibrancyEnabled:(BOOL)vibrancyEnabled
+ + + + + + + + + +
+

Discussion

+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDShadow.html b/Documentation/html/Classes/JGProgressHUDShadow.html new file mode 100644 index 0000000..d297a1f --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDShadow.html @@ -0,0 +1,384 @@ + + + + + + JGProgressHUDShadow Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDShadow Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inJGProgressHUDShadow.h
JGProgressHUDShadow.m
+ + + + +
+ +

Overview

+

A wrapper representing properties of a shadow.

+
+ + + + + +
+ + + + + + +
+
+ +

+ shadowWithColor:offset:radius:opacity: +

+ +
+
+ +
+ + +
+

Convenience initializer.

+
+ + + +
+ (instancetype __nonnull)shadowWithColor:(UIColor *__nonnull)color offset:(CGSize)offset radius:(CGFloat)radius opacity:(float)opacity
+ + + + + + + + + +
+

Discussion

+

Convenience initializer.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDShadow.h

+
+ + +
+
+
+ +

  color +

+ +
+
+ +
+ + +
+

The color of the shadow. Colors created from patterns are currently NOT supported.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) UIColor *color
+ + + + + + + + + +
+

Discussion

+

The color of the shadow. Colors created from patterns are currently NOT supported.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDShadow.h

+
+ + +
+
+
+ +

  offset +

+ +
+
+ +
+ + +
+

The shadow offset.

+
+ + + +
@property (nonatomic, assign, readonly) CGSize offset
+ + + + + + + + + +
+

Discussion

+

The shadow offset.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDShadow.h

+
+ + +
+
+
+ +

  radius +

+ +
+
+ +
+ + +
+

The blur radius used to create the shadow.

+
+ + + +
@property (nonatomic, assign, readonly) CGFloat radius
+ + + + + + + + + +
+

Discussion

+

The blur radius used to create the shadow.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDShadow.h

+
+ + +
+
+
+ +

  opacity +

+ +
+
+ +
+ + +
+

The opacity of the shadow. Specifying a value outside the [0,1] range will give undefined results.

+
+ + + +
@property (nonatomic, assign, readonly) float opacity
+ + + + + + + + + +
+

Discussion

+

The opacity of the shadow. Specifying a value outside the [0,1] range will give undefined results.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDShadow.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Classes/JGProgressHUDSuccessIndicatorView.html b/Documentation/html/Classes/JGProgressHUDSuccessIndicatorView.html new file mode 100644 index 0000000..0fada7b --- /dev/null +++ b/Documentation/html/Classes/JGProgressHUDSuccessIndicatorView.html @@ -0,0 +1,352 @@ + + + + + + JGProgressHUDSuccessIndicatorView Class Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDSuccessIndicatorView Class Reference

+ + +
+ + + + + + + +
Inherits fromJGProgressHUDImageIndicatorView : JGProgressHUDIndicatorView : UIView
Declared inJGProgressHUDSuccessIndicatorView.h
JGProgressHUDSuccessIndicatorView.m
+ + + + +
+ +

Overview

+

An image indicator showing a checkmark, representing a failed operation.

+
+ + + + + +
+ + + + +

Other Methods

+ +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Default initializer for this class.

+
+ + + +
- (instancetype __nonnull)init
+ + + + + + + + + +
+

Discussion

+

Default initializer for this class.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDSuccessIndicatorView.h

+
+ + +
+
+
+
+ + + +

Other Methods

+ +
+
+ +

– initWithContentView: +

+ +
+
+ +
+ + +
+

Designated initializer for this class.

+
+ + + +
- (instancetype)initWithContentView:(UIView *__unused)contentView
+ + + +
+

Parameters

+ + + + + + + +
contentView

The content view to place on the container view (the container is the JGProgressHUDIndicatorView).

+
+ + + + + + + +
+

Discussion

+

Designated initializer for this class.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– updateAccessibility +

+ +
+
+ +
+ + +
+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + +
- (void)updateAccessibility
+ + + + + + + + + +
+

Discussion

+

Override to set custom accessibility properties. This method gets called once when initializing the view and after calling @c setNeedsAccessibilityUpdate.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+ +

– setUpForHUDStyle:vibrancyEnabled: +

+ +
+
+ +
+ + +
+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + +
- (void)setUpForHUDStyle:(JGProgressHUDStyle)style vibrancyEnabled:(BOOL)vibrancyEnabled
+ + + + + + + + + +
+

Discussion

+

Use this method to set up the indicator view to fit the HUD style and vibrancy setting. This method is called by @c JGProgressHUD when the indicator view is added to the HUD and when the HUD’s @c vibrancyEnabled property changes. This method may be called multiple times with different values. The default implementation does nothing.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUDIndicatorView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Constants/JGProgressHUDInteractionType.html b/Documentation/html/Constants/JGProgressHUDInteractionType.html new file mode 100644 index 0000000..7001bb6 --- /dev/null +++ b/Documentation/html/Constants/JGProgressHUDInteractionType.html @@ -0,0 +1,194 @@ + + + + + + JGProgressHUDInteractionType Constants Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDInteractionType Constants Reference

+ + +
+ + + + +
Declared inJGProgressHUD-Defines.h
+ + + + + + + +

JGProgressHUDInteractionType

+ + +
+

Interaction types.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, JGProgressHUDInteractionType ) {
+ +    JGProgressHUDInteractionTypeBlockAllTouches = 0,
+ +    JGProgressHUDInteractionTypeBlockTouchesOnHUDView,
+ +    JGProgressHUDInteractionTypeBlockNoTouches,
+ + }; + +
+ +
+

Constants

+
+ +
JGProgressHUDInteractionTypeBlockAllTouches
+
+ + +

Block all touches. No interaction behin the HUD is possible.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDInteractionTypeBlockTouchesOnHUDView
+
+ + +

Block touches on the HUD view.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDInteractionTypeBlockNoTouches
+
+ + +

Block no touches.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

JGProgressHUD-Defines.h

+
+ + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Constants/JGProgressHUDParallaxMode.html b/Documentation/html/Constants/JGProgressHUDParallaxMode.html new file mode 100644 index 0000000..08c56d5 --- /dev/null +++ b/Documentation/html/Constants/JGProgressHUDParallaxMode.html @@ -0,0 +1,194 @@ + + + + + + JGProgressHUDParallaxMode Constants Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDParallaxMode Constants Reference

+ + +
+ + + + +
Declared inJGProgressHUD-Defines.h
+ + + + + + + +

JGProgressHUDParallaxMode

+ + +
+

Parallax Modes.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, JGProgressHUDParallaxMode ) {
+ +    JGProgressHUDParallaxModeDevice = 0,
+ +    JGProgressHUDParallaxModeAlwaysOn,
+ +    JGProgressHUDParallaxModeAlwaysOff,
+ + }; + +
+ +
+

Constants

+
+ +
JGProgressHUDParallaxModeDevice
+
+ + +

Follows the device setting for parallax. If “Reduce Motion” is enabled, no parallax effect is added to the HUD, if “Reduce Motion” is disabled the HUD will have a parallax effect. This behaviour is only supported on iOS 8 and higher.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDParallaxModeAlwaysOn
+
+ + +

Always adds a parallax effect to the HUD. Parallax is only supported on iOS 7 and higher.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDParallaxModeAlwaysOff
+
+ + +

Never adds a parallax effect to the HUD.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

JGProgressHUD-Defines.h

+
+ + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Constants/JGProgressHUDPosition.html b/Documentation/html/Constants/JGProgressHUDPosition.html new file mode 100644 index 0000000..d043893 --- /dev/null +++ b/Documentation/html/Constants/JGProgressHUDPosition.html @@ -0,0 +1,308 @@ + + + + + + JGProgressHUDPosition Constants Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDPosition Constants Reference

+ + +
+ + + + +
Declared inJGProgressHUD-Defines.h
+ + + + + + + +

JGProgressHUDPosition

+ + +
+

Positions of the HUD.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, JGProgressHUDPosition ) {
+ +    JGProgressHUDPositionCenter = 0,
+ +    JGProgressHUDPositionTopLeft,
+ +    JGProgressHUDPositionTopCenter,
+ +    JGProgressHUDPositionTopRight,
+ +    JGProgressHUDPositionCenterLeft,
+ +    JGProgressHUDPositionCenterRight,
+ +    JGProgressHUDPositionBottomLeft,
+ +    JGProgressHUDPositionBottomCenter,
+ +    JGProgressHUDPositionBottomRight,
+ + }; + +
+ +
+

Constants

+
+ +
JGProgressHUDPositionCenter
+
+ + +

Center position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionTopLeft
+
+ + +

Top left position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionTopCenter
+
+ + +

Top center position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionTopRight
+
+ + +

Top right position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionCenterLeft
+
+ + +

Center left position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionCenterRight
+
+ + +

Center right position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionBottomLeft
+
+ + +

Bottom left position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionBottomCenter
+
+ + +

Bottom center position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDPositionBottomRight
+
+ + +

Bottom right position.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

JGProgressHUD-Defines.h

+
+ + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Constants/JGProgressHUDStyle.html b/Documentation/html/Constants/JGProgressHUDStyle.html new file mode 100644 index 0000000..ab695fa --- /dev/null +++ b/Documentation/html/Constants/JGProgressHUDStyle.html @@ -0,0 +1,194 @@ + + + + + + JGProgressHUDStyle Constants Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDStyle Constants Reference

+ + +
+ + + + +
Declared inJGProgressHUD-Defines.h
+ + + + + + + +

JGProgressHUDStyle

+ + +
+

Appearance styles of the HUD.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, JGProgressHUDStyle ) {
+ +    JGProgressHUDStyleExtraLight = 0,
+ +    JGProgressHUDStyleLight,
+ +    JGProgressHUDStyleDark,
+ + }; + +
+ +
+

Constants

+
+ +
JGProgressHUDStyleExtraLight
+
+ + +

Extra light HUD with dark elements.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDStyleLight
+
+ + +

Light HUD with dark elemets.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
JGProgressHUDStyleDark
+
+ + +

Dark HUD with light elements.

+ + + + + + +

+ Declared In JGProgressHUD-Defines.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

JGProgressHUD-Defines.h

+
+ + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/Protocols/JGProgressHUDDelegate.html b/Documentation/html/Protocols/JGProgressHUDDelegate.html new file mode 100644 index 0000000..4428f5b --- /dev/null +++ b/Documentation/html/Protocols/JGProgressHUDDelegate.html @@ -0,0 +1,370 @@ + + + + + + JGProgressHUDDelegate Protocol Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUDDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inJGProgressHUD.h
+ + + + + + +
+ + + + + + +
+
+ +

– progressHUD:willPresentInView: +

+ +
+
+ +
+ + +
+

Called before the HUD will appear.

+
+ + + +
- (void)progressHUD:(JGProgressHUD *__nonnull)progressHUD willPresentInView:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + +
view

The view in which the HUD is presented.

+
+ + + + + + + +
+

Discussion

+

Called before the HUD will appear.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– progressHUD:didPresentInView: +

+ +
+
+ +
+ + +
+

Called after the HUD appeared.

+
+ + + +
- (void)progressHUD:(JGProgressHUD *__nonnull)progressHUD didPresentInView:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + +
view

The view in which the HUD is presented.

+
+ + + + + + + +
+

Discussion

+

Called after the HUD appeared.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– progressHUD:willDismissFromView: +

+ +
+
+ +
+ + +
+

Called before the HUD will disappear.

+
+ + + +
- (void)progressHUD:(JGProgressHUD *__nonnull)progressHUD willDismissFromView:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + +
view

The view in which the HUD is presented and will be dismissed from.

+
+ + + + + + + +
+

Discussion

+

Called before the HUD will disappear.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+ +

– progressHUD:didDismissFromView: +

+ +
+
+ +
+ + +
+

Called after the HUD has disappeared.

+
+ + + +
- (void)progressHUD:(JGProgressHUD *__nonnull)progressHUD didDismissFromView:(UIView *__nonnull)view
+ + + +
+

Parameters

+ + + + + + + +
view

The view in which the HUD was presented and was be dismissed from.

+
+ + + + + + + +
+

Discussion

+

Called after the HUD has disappeared.

+
+ + + + + + + +
+

Declared In

+

JGProgressHUD.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/css/scss/_index.scss b/Documentation/html/css/scss/_index.scss new file mode 100755 index 0000000..6a57ec5 --- /dev/null +++ b/Documentation/html/css/scss/_index.scss @@ -0,0 +1,17 @@ +.index-container { + -webkit-flex-direction: column; + flex-direction: column; + + @media (min-width: $desktop-min-width) { + display: flex; + -webkit-flex-direction: row; + flex-direction: row; + -webkit-flex-wrap: wrap; + flex-wrap: wrap; + } + + .index-column { + -webkit-flex: 1 1 33%; + flex: 1 1 33%; + } +} diff --git a/Documentation/html/css/scss/_layout.scss b/Documentation/html/css/scss/_layout.scss new file mode 100755 index 0000000..da46aef --- /dev/null +++ b/Documentation/html/css/scss/_layout.scss @@ -0,0 +1,302 @@ +* { + box-sizing: border-box; +} + +.clear { + clear: both; +} + +.clearfix { + &:before, &:after { + clear: both; + display: table; + content: ""; + } +} + +.xcode .hide-in-xcode { + display: none; +} + +body { + font: 62.5% $body-font; + background: $body-background; + + @media (max-width: $mobile-max-width) { + background-color: $content-background; + } +} + +h1, h2, h3 { + font-weight: 300; + color: #808080; +} + +h1 { + font-size: 2em; + color: #000; +} + +h4 { + font-size: 13px; + line-height: 1.5; + margin: 21px 0 0 0; +} + +a { + color: $tint-color; + text-decoration: none; +} + +pre, code { + font-family: $code-font; + word-wrap: break-word; +} + +pre > code, .method-declaration code { + display: inline-block; + font-size: .85em; + padding: 4px 0 4px 10px; + border-left: 5px solid rgba(0, 155, 51, .2); + + &:before { + content: "Objective-C"; + display: block; + + font: 9px/1 $body-font; + color: #009b33; + text-transform: uppercase; + letter-spacing: 2px; + padding-bottom: 6px; + } +} + +pre > code { + font-size: inherit; +} + +table, th, td { + border: 1px solid #e9e9e9; +} + +table { + width: 100%; +} + +th, td { + padding: 7px; + + > :first-child { + margin-top: 0; + } + + > :last-child { + margin-bottom: 0; + } +} + +.container { + @extend .clearfix; + + max-width: 980px; + padding: 0 10px; + margin: 0 auto; + + @media (max-width: $mobile-max-width) { + padding: 0; + } +} + +header { + position: fixed; + top: 0; + left: 0; + width: 100%; + z-index: 2; + + background: #414141; + color: #fff; + font-size: 1.1em; + line-height: 25px; + letter-spacing: .05em; + + #library-title { + float: left; + } + + #developer-home { + float: right; + } + + h1 { + font-size: inherit; + font-weight: inherit; + margin: 0; + } + + p { + margin: 0; + } + + h1, a { + color: inherit; + } + + @media (max-width: $mobile-max-width) { + .container { + padding: 0 10px; + } + } +} + +aside { + position: fixed; + top: 25px; + left: 0; + width: 100%; + height: 25px; + z-index: 2; + + font-size: 1.1em; + + #header-buttons { + background: rgba(255, 255, 255, .8); + margin: 0 1px; + padding: 0; + list-style: none; + text-align: right; + line-height: 32px; + + li { + display: inline-block; + cursor: pointer; + padding: 0 10px; + } + + label, select { + cursor: inherit; + } + + #on-this-page { + position: relative; + + .chevron { + display: inline-block; + width: 14px; + height: 4px; + position: relative; + + .chevy { + background: #878787; + height: 2px; + position: absolute; + width: 10px; + + &.chevron-left { + left: 0; + transform: rotateZ(45deg) scale(0.6); + } + + &.chevron-right { + right: 0; + transform: rotateZ(-45deg) scale(0.6); + } + } + } + + #jump-to { + opacity: 0; + font-size: 16px; + + position: absolute; + top: 5px; + left: 0; + width: 100%; + height: 100%; + } + } + } +} + +article { + margin-top: 25px; + + #content { + @extend .clearfix; + + background: $content-background; + border: 1px solid $content-border; + padding: 15px 25px 30px 25px; + + font-size: 1.4em; + line-height: 1.45; + + position: relative; + + @media (max-width: $mobile-max-width) { + padding: 15px 10px 20px 10px; + border: none; + } + + .navigation-top { + position: absolute; + top: 15px; + right: 25px; + } + + .title { + margin: 21px 0 0 0; + padding: 15px 0; + } + + p { + color: #414141; + margin: 0 0 15px 0; + } + + th, td { + p:last-child { + margin-bottom: 0; + } + } + + main { + ul { + list-style: none; + margin-left: 24px; + margin-bottom: 12px; + padding: 0; + + li { + position: relative; + padding-left: 1.3em; + + &:before { + content: "\02022"; + + color: #414141; + font-size: 1.08em; + line-height: 1; + + position: absolute; + left: 0; + padding-top: 2px; + } + } + } + } + + footer { + @extend .clearfix; + + .footer-copyright { + margin: 70px 25px 10px 0; + } + + p { + font-size: .71em; + color: #a0a0a0; + } + } + } +} diff --git a/Documentation/html/css/scss/_normalize.scss b/Documentation/html/css/scss/_normalize.scss new file mode 100755 index 0000000..9b8848a --- /dev/null +++ b/Documentation/html/css/scss/_normalize.scss @@ -0,0 +1,581 @@ +/* ========================================================================== + Normalize.scss settings + ========================================================================== */ +/** + * Includes legacy browser support IE6/7 + * + * Set to false if you want to drop support for IE6 and IE7 + */ + +$legacy_browser_support: false !default; + +/* Base + ========================================================================== */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + * 3. Corrects text resizing oddly in IE 6/7 when body `font-size` is set using + * `em` units. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ + @if $legacy_browser_support { + *font-size: 100%; /* 3 */ + } +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ + @if $legacy_browser_support { + *display: inline; + *zoom: 1; + } +} + +/** + * Prevents modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a { + &:active, &:hover { + outline: 0; + }; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +@if $legacy_browser_support { + blockquote { + margin: 1em 40px; + } +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +@if $legacy_browser_support { + h2 { + font-size: 1.5em; + margin: 0.83em 0; + } + + h3 { + font-size: 1.17em; + margin: 1em 0; + } + + h4 { + font-size: 1em; + margin: 1.33em 0; + } + + h5 { + font-size: 0.83em; + margin: 1.67em 0; + } + + h6 { + font-size: 0.67em; + margin: 2.33em 0; + } +} + +/** + * Addresses styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +@if $legacy_browser_support { + + /** + * Addresses margins set differently in IE 6/7. + */ + + p, + pre { + *margin: 1em 0; + } + + /* + * Addresses CSS quotes not supported in IE 6/7. + */ + + q { + *quotes: none; + } + + /* + * Addresses `quotes` property not supported in Safari 4. + */ + + q:before, + q:after { + content: ''; + content: none; + } +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +@if $legacy_browser_support { + + /* ========================================================================== + Lists + ========================================================================== */ + + /* + * Addresses margins set differently in IE 6/7. + */ + + dl, + menu, + ol, + ul { + *margin: 1em 0; + } + + dd { + *margin: 0 0 0 40px; + } + + /* + * Addresses paddings set differently in IE 6/7. + */ + + menu, + ol, + ul { + *padding: 0 0 0 40px; + } + + /* + * Corrects list images handled incorrectly in IE 7. + */ + + nav ul, + nav ol { + *list-style: none; + *list-style-image: none; + } + +} + +/* Embedded content + ========================================================================== */ + +/** + * 1. Remove border when inside `a` element in IE 8/9/10. + * 2. Improves image quality when scaled in IE 7. + */ + +img { + border: 0; + @if $legacy_browser_support { + *-ms-interpolation-mode: bicubic; /* 2 */ + } +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + @if $legacy_browser_support { + _font-family: 'courier new', monospace; + } + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + * 4. Improves appearance and consistency in all browsers. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ + @if $legacy_browser_support { + vertical-align: baseline; /* 3 */ + *vertical-align: middle; /* 3 */ + } +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + * 4. Removes inner spacing in IE 7 without affecting normal text inputs. + * Known issue: inner spacing remains in IE 6. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ + @if $legacy_browser_support { + *overflow: visible; /* 4 */ + } +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + * Known issue: excess padding remains in IE 6. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + *height: 13px; /* 3 */ + *width: 13px; /* 3 */ + } +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + * 3. Corrects text not wrapping in Firefox 3. + * 4. Corrects alignment displayed oddly in IE 6/7. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + white-space: normal; /* 3 */ + *margin-left: -7px; /* 4 */ + } +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/Documentation/html/css/scss/_object.scss b/Documentation/html/css/scss/_object.scss new file mode 100755 index 0000000..22eebd8 --- /dev/null +++ b/Documentation/html/css/scss/_object.scss @@ -0,0 +1,89 @@ +.section-specification { + table { + width: auto; + + th { + text-align: left; + } + } +} + +.method-title { + margin-left: -15px; + margin-bottom: 8px; + transition: margin-left .3s ease-out; + + .section-method.hide & { + margin-left: 0; + } + + code { + font-weight: 400; + font-size: .85em; + } +} + +.method-info { + background: $object-background; + border-bottom: 1px solid $object-border; + margin: 0 -25px; + padding: 20px 25px 0 25px; + transition: height .3s ease-out; + + position: relative; + + .pointy-thing { + background: $content-background; + height: 10px; + border-bottom: 1px solid $object-border; + margin: -20px -25px 16px -25px; + + &:before { + display: inline-block; + content: ""; + + background: $object-background; + border: 1px solid $object-border; + border-bottom: 0; + border-right: 0; + + position: absolute; + left: 21px; + top: 3px; + width: 12px; + height: 12px; + transform: rotate(45deg); + } + } + + .method-subsection { + margin-bottom: 15px; + + .argument-name { + width: 1px; + text-align: right; + + code { + color: #808080; + font-style: italic; + font-weight: 400; + } + } + } +} + +.section-method { + &.hide .method-info { + height: 0 !important; + overflow: hidden; + display: none; + } + + &.hide.animating .method-info { + display: block; + } + + &.animating .method-info { + overflow: hidden; + } +} diff --git a/Documentation/html/css/scss/_print.scss b/Documentation/html/css/scss/_print.scss new file mode 100755 index 0000000..61bdf99 --- /dev/null +++ b/Documentation/html/css/scss/_print.scss @@ -0,0 +1,42 @@ +@media print { + body { + background: #fff; + padding: 8px; + } + + header { + position: static; + background: #fff; + color: #000; + } + + aside { + display: none; + } + + .container { + max-width: none; + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + background: #fff; + padding: 15px 0 0 0; + + .title { + margin-top: 0; + padding-top: 0; + } + } + } + + .method-info { + &, & .pointy-thing { + background: #fff; + } + } +} diff --git a/Documentation/html/css/scss/_variables.scss b/Documentation/html/css/scss/_variables.scss new file mode 100755 index 0000000..38e072d --- /dev/null +++ b/Documentation/html/css/scss/_variables.scss @@ -0,0 +1,12 @@ +$body-font: -apple-system-font, "Helvetica Neue", Helvetica, sans-serif; +$code-font: "Source Code Pro", Monaco, Menlo, Consolas, monospace; + +$body-background: #f2f2f2; +$content-background: #fff; +$content-border: #e9e9e9; +$tint-color: #08c; +$object-background: #f9f9f9; +$object-border: #e9e9e9; + +$mobile-max-width: 650px; +$desktop-min-width: 768px; \ No newline at end of file diff --git a/Documentation/html/css/scss/_xcode.scss b/Documentation/html/css/scss/_xcode.scss new file mode 100755 index 0000000..340b1f6 --- /dev/null +++ b/Documentation/html/css/scss/_xcode.scss @@ -0,0 +1,29 @@ +.xcode { + header, aside { + display: none; + } + + .container { + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + margin: 0; + } + } + + .method-info { + &, .section-method.hide & { + max-height: auto; + overflow: visible; + + &.hiding { + display: block; + } + } + } +} diff --git a/Documentation/html/css/scss/style.scss b/Documentation/html/css/scss/style.scss new file mode 100755 index 0000000..648a608 --- /dev/null +++ b/Documentation/html/css/scss/style.scss @@ -0,0 +1 @@ +@import "variables", "normalize", "layout", "index", "object", "print", "xcode"; diff --git a/Documentation/html/css/style.css b/Documentation/html/css/style.css new file mode 100755 index 0000000..d9d59dd --- /dev/null +++ b/Documentation/html/css/style.css @@ -0,0 +1,2 @@ +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:0.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace, monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:0.35em 0.625em 0.75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}*{box-sizing:border-box}.clear{clear:both}.clearfix:before,.container:before,article #content:before,article #content footer:before,.clearfix:after,.container:after,article #content:after,article #content footer:after{clear:both;display:table;content:""}.xcode .hide-in-xcode{display:none}body{font:62.5% -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;background:#f2f2f2}@media (max-width: 650px){body{background-color:#fff}}h1,h2,h3{font-weight:300;color:#808080}h1{font-size:2em;color:#000}h4{font-size:13px;line-height:1.5;margin:21px 0 0 0}a{color:#08c;text-decoration:none}pre,code{font-family:"Source Code Pro",Monaco,Menlo,Consolas,monospace;word-wrap:break-word}pre>code,.method-declaration code{display:inline-block;font-size:.85em;padding:4px 0 4px 10px;border-left:5px solid rgba(0,155,51,0.2)}pre>code:before,.method-declaration code:before{content:"Objective-C";display:block;font:9px/1 -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;color:#009b33;text-transform:uppercase;letter-spacing:2px;padding-bottom:6px}pre>code{font-size:inherit}table,th,td{border:1px solid #e9e9e9}table{width:100%}th,td{padding:7px}th>:first-child,td>:first-child{margin-top:0}th>:last-child,td>:last-child{margin-bottom:0}.container{max-width:980px;padding:0 10px;margin:0 auto}@media (max-width: 650px){.container{padding:0}}header{position:fixed;top:0;left:0;width:100%;z-index:2;background:#414141;color:#fff;font-size:1.1em;line-height:25px;letter-spacing:.05em}header #library-title{float:left}header #developer-home{float:right}header h1{font-size:inherit;font-weight:inherit;margin:0}header p{margin:0}header h1,header a{color:inherit}@media (max-width: 650px){header .container{padding:0 10px}}aside{position:fixed;top:25px;left:0;width:100%;height:25px;z-index:2;font-size:1.1em}aside #header-buttons{background:rgba(255,255,255,0.8);margin:0 1px;padding:0;list-style:none;text-align:right;line-height:32px}aside #header-buttons li{display:inline-block;cursor:pointer;padding:0 10px}aside #header-buttons label,aside #header-buttons select{cursor:inherit}aside #header-buttons #on-this-page{position:relative}aside #header-buttons #on-this-page .chevron{display:inline-block;width:14px;height:4px;position:relative}aside #header-buttons #on-this-page .chevron .chevy{background:#878787;height:2px;position:absolute;width:10px}aside #header-buttons #on-this-page .chevron .chevy.chevron-left{left:0;transform:rotateZ(45deg) scale(0.6)}aside #header-buttons #on-this-page .chevron .chevy.chevron-right{right:0;transform:rotateZ(-45deg) scale(0.6)}aside #header-buttons #on-this-page #jump-to{opacity:0;font-size:16px;position:absolute;top:5px;left:0;width:100%;height:100%}article{margin-top:25px}article #content{background:#fff;border:1px solid #e9e9e9;padding:15px 25px 30px 25px;font-size:1.4em;line-height:1.45;position:relative}@media (max-width: 650px){article #content{padding:15px 10px 20px 10px;border:none}}article #content .navigation-top{position:absolute;top:15px;right:25px}article #content .title{margin:21px 0 0 0;padding:15px 0}article #content p{color:#414141;margin:0 0 15px 0}article #content th p:last-child,article #content td p:last-child{margin-bottom:0}article #content main ul{list-style:none;margin-left:24px;margin-bottom:12px;padding:0}article #content main ul li{position:relative;padding-left:1.3em}article #content main ul li:before{content:"\02022";color:#414141;font-size:1.08em;line-height:1;position:absolute;left:0;padding-top:2px}article #content footer .footer-copyright{margin:70px 25px 10px 0}article #content footer p{font-size:.71em;color:#a0a0a0}.index-container{-webkit-flex-direction:column;flex-direction:column}@media (min-width: 768px){.index-container{display:flex;-webkit-flex-direction:row;flex-direction:row;-webkit-flex-wrap:wrap;flex-wrap:wrap}}.index-container .index-column{-webkit-flex:1 1 33%;flex:1 1 33%}.section-specification table{width:auto}.section-specification table th{text-align:left}.method-title{margin-left:-15px;margin-bottom:8px;transition:margin-left .3s ease-out}.section-method.hide .method-title{margin-left:0}.method-title code{font-weight:400;font-size:.85em}.method-info{background:#f9f9f9;border-bottom:1px solid #e9e9e9;margin:0 -25px;padding:20px 25px 0 25px;transition:height .3s ease-out;position:relative}.method-info .pointy-thing{background:#fff;height:10px;border-bottom:1px solid #e9e9e9;margin:-20px -25px 16px -25px}.method-info .pointy-thing:before{display:inline-block;content:"";background:#f9f9f9;border:1px solid #e9e9e9;border-bottom:0;border-right:0;position:absolute;left:21px;top:3px;width:12px;height:12px;-webkit-transform:rotate(45deg);transform:rotate(45deg) }.method-info .method-subsection{margin-bottom:15px}.method-info .method-subsection .argument-name{width:1px;text-align:right}.method-info .method-subsection .argument-name code{color:#808080;font-style:italic;font-weight:400}.section-method.hide .method-info{height:0 !important;overflow:hidden;display:none}.section-method.hide.animating .method-info{display:block}.section-method.animating .method-info{overflow:hidden}@media print{body{background:#fff;padding:8px}header{position:static;background:#fff;color:#000}aside{display:none}.container{max-width:none;padding:0}article{margin-top:0}article #content{border:0;background:#fff;padding:15px 0 0 0}article #content .title{margin-top:0;padding-top:0}.method-info,.method-info .pointy-thing{background:#fff}}.xcode header,.xcode aside{display:none}.xcode .container{padding:0}.xcode article{margin-top:0}.xcode article #content{border:0;margin:0}.xcode .method-info,.section-method.hide .xcode .method-info{max-height:auto;overflow:visible}.xcode .method-info.hiding,.section-method.hide .xcode .method-info.hiding{display:block} + diff --git a/Documentation/html/hierarchy.html b/Documentation/html/hierarchy.html new file mode 100644 index 0000000..6aca45c --- /dev/null +++ b/Documentation/html/hierarchy.html @@ -0,0 +1,147 @@ + + + + + + JGProgressHUD Hierarchy + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUD Hierarchy

+ + +
+

Class Hierarchy

+ + + +
+ + + +
+ +

Protocol References

+ + + +

Constant References

+ + + +
+ + + +
+
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/img/button_bar_background.png b/Documentation/html/img/button_bar_background.png new file mode 100755 index 0000000..71d1019 Binary files /dev/null and b/Documentation/html/img/button_bar_background.png differ diff --git a/Documentation/html/img/disclosure.png b/Documentation/html/img/disclosure.png new file mode 100755 index 0000000..4c5cbf4 Binary files /dev/null and b/Documentation/html/img/disclosure.png differ diff --git a/Documentation/html/img/disclosure_open.png b/Documentation/html/img/disclosure_open.png new file mode 100755 index 0000000..82396fe Binary files /dev/null and b/Documentation/html/img/disclosure_open.png differ diff --git a/Documentation/html/img/library_background.png b/Documentation/html/img/library_background.png new file mode 100755 index 0000000..3006248 Binary files /dev/null and b/Documentation/html/img/library_background.png differ diff --git a/Documentation/html/img/title_background.png b/Documentation/html/img/title_background.png new file mode 100755 index 0000000..846e496 Binary files /dev/null and b/Documentation/html/img/title_background.png differ diff --git a/Documentation/html/index.html b/Documentation/html/index.html new file mode 100644 index 0000000..9a8a5ab --- /dev/null +++ b/Documentation/html/index.html @@ -0,0 +1,129 @@ + + + + + + JGProgressHUD Reference + + + + + + +
+
+ +

+ JGProgressHUD +

+ +

+ Jonas Gessner +

+ +
+
+ + + +
+
+
+
+

JGProgressHUD Reference

+ + + +
+ + + +
+

Class References

+ +
+ + + +
+ +

Protocol References

+ + + + +

Constant References

+ + + + +
+ +
+ + +
+
+
+
+ + + + \ No newline at end of file diff --git a/Documentation/html/js/script.js b/Documentation/html/js/script.js new file mode 100755 index 0000000..4074361 --- /dev/null +++ b/Documentation/html/js/script.js @@ -0,0 +1,59 @@ +function $() { + return document.querySelector.apply(document, arguments); +} + +if (navigator.userAgent.indexOf("Xcode") != -1) { + document.documentElement.classList.add("xcode"); +} + +var jumpTo = $("#jump-to"); + +if (jumpTo) { + jumpTo.addEventListener("change", function(e) { + location.hash = this.options[this.selectedIndex].value; + }); +} + +function hashChanged() { + if (/^#\/\/api\//.test(location.hash)) { + var element = document.querySelector("a[name='" + location.hash.substring(1) + "']"); + + if (!element) { + return; + } + + element = element.parentNode; + + element.classList.remove("hide"); + fixScrollPosition(element); + } +} + +function fixScrollPosition(element) { + var scrollTop = element.offsetTop - 150; + document.documentElement.scrollTop = scrollTop; + document.body.scrollTop = scrollTop; +} + +[].forEach.call(document.querySelectorAll(".section-method"), function(element) { + element.classList.add("hide"); + + element.querySelector(".method-title a").addEventListener("click", function(e) { + var info = element.querySelector(".method-info"), + infoContainer = element.querySelector(".method-info-container"); + + element.classList.add("animating"); + info.style.height = (infoContainer.clientHeight + 40) + "px"; + fixScrollPosition(element); + element.classList.toggle("hide"); + if (element.classList.contains("hide")) { + e.preventDefault(); + } + setTimeout(function() { + element.classList.remove("animating"); + }, 300); + }); +}); + +window.addEventListener("hashchange", hashChanged); +hashChanged(); diff --git a/README.md b/README.md index 6a23629..7c4c668 100644 --- a/README.md +++ b/README.md @@ -161,8 +161,8 @@ JGProgressHUD can also be used by projects written in Swift. See CocoaDocs.

-Each method is well documented, making it easy to quickly get a great overview of JGProgressHUD. To start, see JGProgressHUD.h. +Detailed documentation can be found on here.

+Each class and method is well documented, making it easy to quickly get a good overview. To start, see JGProgressHUD.h. License ---------