CPObjectCPResponder
CPView
CPProgressIndicator
@implementation CPProgressIndicator : CPView
This class is used in a Cappuccino GUI to display the progress of a function or task. If the duration of the task is unknown, there is also an indeterminate mode for the indicator.
Method Summary | |
---|---|
-(id) | initWithFrame:(CGRect)aFrame Initializes the receiver for usage with the specified bounding rectangle. |
-(CPControlSize) | controlSize Returns the progress indicator's size. |
-(CPControlTint) | controlTint Not yet impemented. |
-(double) | doubleValue Returns the value of the progress indicator. |
-(void) | incrementBy:(double)aValue Increases the progress of the bar by the specified value. |
-(BOOL) | isBezeled Not yet implemented. |
-(BOOL) | isDisplayedWhenStopped Returns YES if the progress bar is displayed when not animating. |
-(BOOL) | isIndeterminate Returns YES if the progress bar is indeterminate. |
-(double) | maxValue Returns the maximum value of the progress indicator. |
-(double) | minValue Returns the minimum value of the progress indicator. |
-(void) | setBezeled:(BOOL)isBezeled Not yet implemented. |
-(void) | setControlSize:(CPControlSize)aControlSize Sets the progress indicator's size. |
-(void) | setControlTint:(CPControlTint)aControlTint Not yet implemented. |
-(void) | setDisplayedWhenStopped:(BOOL)isDisplayedWhenStopped Sets whether the indicator should be displayed when it isn't animating. |
-(void) | setDoubleValue:(double)aValue Sets the progress value of the indicator. |
-(void) | setFrameSize:(CGSize)aSize Sets the receiver's frame size. |
-(void) | setIndeterminate:(BOOL)isIndeterminate Specifies whether this progress indicator should be indeterminate or display progress based on it's max and min. |
-(void) | setMaxValue:(double)aValue Sets the maximum value of the progress indicator. |
-(void) | setMinValue:(double)aValue Sets the minimum value of the progress indicator. |
-(void) | setStyle:(CPProgressIndicatorStyle)aStyle Sets the progress indicator's style. |
-(void) | sizeToFit Resizes the indicator based on it's style. |
-(void) | startAnimation:(id)aSender Starts the animation of the progress indicator in indeterminate mode. |
-(void) | stopAnimation:(id)aSender Stops the animation of the progress indicator in indeterminate mode. |
-(BOOL) | usesThreadedAnimation Always returns NO . |
Method Detail |
---|
-(id)initWithFrame:(CGRect)aFrame
aFrame
-(CPControlSize)controlSize
-(CPControlTint)controlTint
-(double)doubleValue
-(void)incrementBy:(double)aValue
aValue
- the amount to increase the progress value-(BOOL)isBezeled
-(BOOL)isDisplayedWhenStopped
YES
if the progress bar is displayed when not animating.-(BOOL)isIndeterminate
YES
if the progress bar is indeterminate.-(double)maxValue
-(double)minValue
-(void)setBezeled:(BOOL)isBezeled
isBezeled
-(void)setControlSize:(CPControlSize)aControlSize
aControlSize
- the new size-(void)setControlTint:(CPControlTint)aControlTint
aControlTint
-(void)setDisplayedWhenStopped:(BOOL)isDisplayedWhenStopped
YES
if the style
is CPProgressIndicatorBarStyle
, and NO
if it's CPProgressIndicatorSpinningStyle
.isDisplayedWhenStopped
- YES
means the indicator will be displayed when it's not animating.-(void)setDoubleValue:(double)aValue
aValue
-(void)setFrameSize:(CGSize)aSize
aSize
is the same as the frame's current dimensions, this
method simply returns. The method posts a CPViewFrameDidChangeNotification
to the
default notification center if the receiver is configured to do so.aSize
- the new size for the frame-(void)setIndeterminate:(BOOL)isIndeterminate
isIndeterminate
-(void)setMaxValue:(double)aValue
aValue
- the new maximum value.-(void)setMinValue:(double)aValue
aValue
- the new minimum value-(void)setStyle:(CPProgressIndicatorStyle)aStyle
aStyle
- the style to set it to-(void)sizeToFit
-(void)startAnimation:(id)aSender
aSender
-(void)stopAnimation:(id)aSender
aSender
-(BOOL)usesThreadedAnimation
NO
. Cappuccino does not have multiple threads.Created on Sat Sep 13 14:15:43 PDT 2008