ITProgressIndicator.h 2.55 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
//Copyright 2013-2015 Ilija Tovilo
//
//Licensed under the Apache License, Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
//http://www.apache.org/licenses/LICENSE-2.0
//
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.


#import <Cocoa/Cocoa.h>
#import <QuartzCore/QuartzCore.h>

//
// !!!IMPORTANT!!! - Embedd ITProgressIndicator in a layer-backed view to avoid side-effects!
//

/**
 *  @class ITProgressIndicator
 *
 *  A replacement for `NSProgressIndicator`.
 *  It's a highly customizable control, driven by Core Animation, which makes it much more performant.
 *
 *  So basically, it's awesome.
 *
 */
@interface ITProgressIndicator : NSView

#pragma mark - Methods

/**
 *  Override this method to achieve a custom animation
 *
 *  @return CAKeyframeAnimation - animation which will be put on the progress indicator layer
 */
- (CAKeyframeAnimation *)keyFrameAnimationForCurrentPreferences;

#pragma mark - Properties


/// @property isIndeterminate - Indicates if the view will show the progress, or just spin
@property (nonatomic, setter = setIndeterminate:) BOOL isIndeterminate;


/// @property progress - The amount that should be shown when `isIndeterminate` is set to `YES`
@property (nonatomic) CGFloat progress;


/// @property animates - Indicates if the view is animating
@property (nonatomic) BOOL animates;


/// @property hideWhenStopped - Indicates if the view will be hidden if it's stopped
@property (nonatomic) BOOL hideWhenStopped;


/// @property lengthOfLine - The length of a single line
@property (nonatomic) CGFloat lengthOfLine;


/// @property widthOfLine - The width of a single line
@property (nonatomic) CGFloat widthOfLine;


/// @property numberOfLines - The number of lines of the indicator
@property (nonatomic) NSUInteger numberOfLines;


/// @property innerMargin - The distance of the lines from the middle
@property (nonatomic) CGFloat innerMargin;


/// @property animationDuration - Duration of a single rotation
@property (nonatomic) CGFloat animationDuration;


/// @property gradualAnimation - Defines if the animation is smooth or gradual
@property (nonatomic) BOOL steppedAnimation;

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

@end