API 0.9.5
CPProgressIndicator Class Reference

#import <CPProgressIndicator.h>

Inheritance diagram for CPProgressIndicator:

List of all members.

Instance Methods

(CPControlSize) - controlSize
(CPControlTint) - controlTint
(double) - doubleValue
(void) - drawBar
(void) - encodeWithCoder:
(void) - incrementBy:
(id) - initWithCoder:
(id) - initWithFrame:
(BOOL) - isBezeled
(BOOL) - isDisplayedWhenStopped
(BOOL) - isIndeterminate
(double) - maxValue
(double) - minValue
(void) - setBezeled:
(void) - setControlSize:
(void) - setControlTint:
(void) - setDisplayedWhenStopped:
(void) - setDoubleValue:
(void) - setFrameSize:
(void) - setIndeterminate:
(void) - setMaxValue:
(void) - setMinValue:
(void) - setStyle:
(void) - setUsesThreadedAnimation:
(void) - sizeToFit
(void) - startAnimation:
(void) - stopAnimation:
(void) - updateBackgroundColor
(BOOL) - usesThreadedAnimation

Class Methods

(void) + initialize

Detailed Description

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.

Definition at line 2 of file CPProgressIndicator.h.


Method Documentation

- (CPControlSize) controlSize

Returns the progress indicator's size

Definition at line 277 of file CPProgressIndicator.j.

- (CPControlTint) controlTint

Definition at line 292 of file CPProgressIndicator.j.

- (double) doubleValue

Returns the value of the progress indicator.

Definition at line 220 of file CPProgressIndicator.j.

- (void) drawBar

Definition at line 405 of file CPProgressIndicator.j.

- (void) encodeWithCoder: (CPCoder aCoder

Archives the view to a coder.

Parameters:
aCoderthe object into which the view's data will be archived.

Reimplemented from CPView.

Definition at line 486 of file CPProgressIndicator.j.

- (void) incrementBy: (double)  aValue

Increases the progress of the bar by the specified value.

Parameters:
aValuethe amount to increase the progress value

Definition at line 202 of file CPProgressIndicator.j.

+ (void) initialize

Reimplemented from CPView.

Definition at line 78 of file CPProgressIndicator.j.

- (id) initWithCoder: (CPCoder aCoder

Initializes the view from an archive.

Parameters:
aCoderthe coder from which to initialize
Returns:
the initialized view

Reimplemented from CPView.

Definition at line 468 of file CPProgressIndicator.j.

- (id) initWithFrame: (CGRect)  aFrame

Initializes the receiver for usage with the specified bounding rectangle

Returns:
the initialized view

Reimplemented from CPView.

Definition at line 137 of file CPProgressIndicator.j.

- (BOOL) isBezeled

Definition at line 307 of file CPProgressIndicator.j.

- (BOOL) isDisplayedWhenStopped

Returns YES if the progress bar is displayed when not animating.

Definition at line 380 of file CPProgressIndicator.j.

- (BOOL) isIndeterminate

Returns YES if the progress bar is indeterminate.

Definition at line 329 of file CPProgressIndicator.j.

- (double) maxValue

Returns the maximum value of the progress indicator.

Definition at line 254 of file CPProgressIndicator.j.

- (double) minValue

Returns the minimum value of the progress indicator.

Definition at line 237 of file CPProgressIndicator.j.

- (void) setBezeled: (BOOL)  isBezeled

Definition at line 300 of file CPProgressIndicator.j.

- (void) setControlSize: (CPControlSize)  aControlSize

Sets the progress indicator's size.

Parameters:
aControlSizethe new size

Definition at line 264 of file CPProgressIndicator.j.

- (void) setControlTint: (CPControlTint)  aControlTint

Definition at line 285 of file CPProgressIndicator.j.

- (void) setDisplayedWhenStopped: (BOOL)  isDisplayedWhenStopped

Sets whether the indicator should be displayed when it isn't animating. By default this is YES if the style is CPProgressIndicatorBarStyle, and NO if it's CPProgressIndicatorSpinningStyle.

Parameters:
isDisplayedWhenStoppedYES means the indicator will be displayed when it's not animating.

Definition at line 365 of file CPProgressIndicator.j.

- (void) setDoubleValue: (double)  aValue

Sets the progress value of the indicator.

Definition at line 210 of file CPProgressIndicator.j.

- (void) setFrameSize: (CGSize)  aSize

Sets the receiver's frame size. If 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.

Parameters:
aSizethe new size for the frame

Reimplemented from CPView.

Definition at line 397 of file CPProgressIndicator.j.

- (void) setIndeterminate: (BOOL)  isIndeterminate

Specifies whether this progress indicator should be indeterminate or display progress based on it's max and min.

Parameters:
isDeterminateYES makes the indicator indeterminate

Definition at line 316 of file CPProgressIndicator.j.

- (void) setMaxValue: (double)  aValue

Sets the maximum value of the progress indicator. The default is 100.0.

Parameters:
aValuethe new maximum value.

Definition at line 246 of file CPProgressIndicator.j.

- (void) setMinValue: (double)  aValue

Sets the minimum value of the progress indicator. The default is 0.0.

Parameters:
aValuethe new minimum value

Definition at line 229 of file CPProgressIndicator.j.

- (void) setStyle: (CPProgressIndicatorStyle)  aStyle

Sets the progress indicator's style

Parameters:
aStylethe style to set it to

Definition at line 338 of file CPProgressIndicator.j.

- (void) setUsesThreadedAnimation: (BOOL)  aFlag

Definition at line 163 of file CPProgressIndicator.j.

- (void) sizeToFit

Resizes the indicator based on it's style.

Definition at line 351 of file CPProgressIndicator.j.

- (void) startAnimation: (id)  aSender

Starts the animation of the progress indicator in indeterminate mode.

Parameters:
therequesting object

Definition at line 171 of file CPProgressIndicator.j.

- (void) stopAnimation: (id)  aSender

Stops the animation of the progress indicator in indeterminate mode.

Parameters:
therequesting object

Definition at line 182 of file CPProgressIndicator.j.

- (void) updateBackgroundColor

Definition at line 434 of file CPProgressIndicator.j.

- (BOOL) usesThreadedAnimation

Always returns NO. Cappuccino does not have multiple threads.

Definition at line 192 of file CPProgressIndicator.j.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines