RTSpinKitView.h

//
// RTSpinKitView.h
// SpinKit
//
// Copyright (c) 2014 Ramon Torres
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

#import <Cocoa/Cocoa.h>

typedef NS_ENUM(NSInteger, RTSpinKitViewStyle) {
    RTSpinKitViewStyleCustom,
    RTSpinKitViewStylePlane,
    RTSpinKitViewStyleCircleFlip,
    RTSpinKitViewStyleBounce,
    RTSpinKitViewStyleWave,
    RTSpinKitViewStyleWanderingCubes,
    RTSpinKitViewStylePulse,
    RTSpinKitViewStyleChasingDots,
    RTSpinKitViewStyleThreeBounce,
    RTSpinKitViewStyleCircle,
    RTSpinKitViewStyle9CubeGrid,
    RTSpinKitViewStyleWordPress,
    RTSpinKitViewStyleFadingCircle,
    RTSpinKitViewStyleFadingCircleAlt,
    RTSpinKitViewStyleArc,
    RTSpinKitViewStyleArcAlt
};

@protocol RTSpinKitAnimating;

/**
 The `RTSpinKitView` defines an activity indicator view. It's interface is very similar
 to `UIActivityIndicatorView`.
 */
@interface RTSpinKitView : NSView

/**
 The color of the activity indicator.
 */
@property (nonatomic, strong) NSColor *color;

/**
 Whether or not the receiver should be hidden when not animating.
 */
@property (nonatomic, assign) BOOL hidesWhenStopped;

/**
 The style for the activity indicator.

 @see RTSpinKitViewStyle
 */
@property (nonatomic, assign) RTSpinKitViewStyle style;

/**
 The size of the spinner. The view will be automatically resized to fit the activity indicator.
 */
@property (nonatomic, assign) CGFloat spinnerSize;

@property (nonatomic, assign, getter = isStopped) BOOL stopped;

/**
 Returns an object initialized from data in a given unarchiver.

 @return The initialized SpinKit view using the data in aDecoder;
 */
- (instancetype)initWithCoder:(NSCoder *)aDecoder NS_DESIGNATED_INITIALIZER;

/**
 Initializes and returns an activity indicator object.

 @param style The style of the activity indicator.
 
 @return The newly-initialized SpinKit view.
 */
-(instancetype)initWithStyle:(RTSpinKitViewStyle)style;

/**
 Initializes and returns an activity indicator object.

 @param style The style of the activity indicator.
 @param color The color of the activity indicator.

 @return The newly-initialized SpinKit view.
 */
-(instancetype)initWithStyle:(RTSpinKitViewStyle)style
                       color:(NSColor*)color;

/**
 Initializes and returns an activity indicator object.
 
 @param animator The RTSpinKitAnimating conforming animator object that will perform the animation.
 @param color The color of the activity indicator.
 @param spinnerSize The size of the spinner.
 
 @return The newly-initialized SpinKit view.
 */
-(instancetype)initWithAnimator:(id<RTSpinKitAnimating>)animator
                          color:(NSColor*)color
                    spinnerSize:(CGFloat)spinnerSize;

/**
 Initializes and returns an activity indicator object.

 Designated initializer.

 @param style The style of the activity indicator.
 @param color The color of the activity indicator.
 @param spinnerSize The size of the spinner.

 @return The newly-initialized SpinKit view.
 */
-(instancetype)initWithStyle:(RTSpinKitViewStyle)style
                       color:(NSColor*)color
                 spinnerSize:(CGFloat)spinnerSize NS_DESIGNATED_INITIALIZER;

/**
 Starts the animation of the activity indicator.
 */
-(void)startAnimating;

/**
 Stops the animation of the activity indicator.
 */
-(void)stopAnimating;

/**
 Returns whether the receiver is animating.

 @return `YES` if the receiver is animating, otherwise `NO`.
 */
-(BOOL)isAnimating;

/**
 Sets the color of the spinner.
 
 @param color The desired color for the spinner.
 @param animated Whether or not to animate.
 */
-(void)setColor:(NSColor *)color animated:(BOOL)animated;

@end