Public Member Functions | |
(CPControlSize) | - controlSize [implementation] |
(CPControlTint) | - controlTint [implementation] |
(double) | - doubleValue [implementation] |
(void) | - drawBar [implementation] |
(void) | - incrementBy: [implementation] |
(id) | - initWithFrame: [implementation] |
(BOOL) | - isBezeled [implementation] |
(BOOL) | - isDisplayedWhenStopped [implementation] |
(BOOL) | - isIndeterminate [implementation] |
(double) | - maxValue [implementation] |
(double) | - minValue [implementation] |
(void) | - setBezeled: [implementation] |
(void) | - setControlSize: [implementation] |
(void) | - setControlTint: [implementation] |
(void) | - setDisplayedWhenStopped: [implementation] |
(void) | - setDoubleValue: [implementation] |
(void) | - setFrameSize: [implementation] |
(void) | - setIndeterminate: [implementation] |
(void) | - setMaxValue: [implementation] |
(void) | - setMinValue: [implementation] |
(void) | - setStyle: [implementation] |
(void) | - setUsesThreadedAnimation: [implementation] |
(void) | - sizeToFit [implementation] |
(void) | - startAnimation: [implementation] |
(void) | - stopAnimation: [implementation] |
(void) | - updateBackgroundColor [implementation] |
(BOOL) | - usesThreadedAnimation [implementation] |
Static Public Member Functions | |
(void) | + initialize [implementation] |
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 60 of file CPProgressIndicator.j.
- (CPControlSize) controlSize | [implementation] |
Returns the progress indicator's size
Definition at line 282 of file CPProgressIndicator.j.
- (CPControlTint) controlTint | [implementation] |
Definition at line 297 of file CPProgressIndicator.j.
- (double) doubleValue | [implementation] |
Returns the value of the progress indicator.
Definition at line 225 of file CPProgressIndicator.j.
- (void) drawBar | [implementation] |
Definition at line 411 of file CPProgressIndicator.j.
- (void) incrementBy: | (double) | aValue | [implementation] |
Increases the progress of the bar by the specified value.
aValue | the amount to increase the progress value |
Definition at line 207 of file CPProgressIndicator.j.
+ (void) initialize | [implementation] |
Definition at line 83 of file CPProgressIndicator.j.
- (id) initWithFrame: | (CGRect) | aFrame | [implementation] |
Definition at line 142 of file CPProgressIndicator.j.
- (BOOL) isBezeled | [implementation] |
Definition at line 312 of file CPProgressIndicator.j.
- (BOOL) isDisplayedWhenStopped | [implementation] |
Returns YES
if the progress bar is displayed when not animating.
Definition at line 386 of file CPProgressIndicator.j.
- (BOOL) isIndeterminate | [implementation] |
Returns YES
if the progress bar is indeterminate.
Definition at line 334 of file CPProgressIndicator.j.
- (double) maxValue | [implementation] |
Returns the maximum value of the progress indicator.
Definition at line 259 of file CPProgressIndicator.j.
- (double) minValue | [implementation] |
Returns the minimum value of the progress indicator.
Definition at line 242 of file CPProgressIndicator.j.
- (void) setBezeled: | (BOOL) | isBezeled | [implementation] |
Definition at line 305 of file CPProgressIndicator.j.
- (void) setControlSize: | (CPControlSize) | aControlSize | [implementation] |
Sets the progress indicator's size.
aControlSize | the new size |
Definition at line 269 of file CPProgressIndicator.j.
- (void) setControlTint: | (CPControlTint) | aControlTint | [implementation] |
Definition at line 290 of file CPProgressIndicator.j.
- (void) setDisplayedWhenStopped: | (BOOL) | isDisplayedWhenStopped | [implementation] |
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.
isDisplayedWhenStopped | YES means the indicator will be displayed when it's not animating. |
Definition at line 371 of file CPProgressIndicator.j.
- (void) setDoubleValue: | (double) | aValue | [implementation] |
Sets the progress value of the indicator.
Definition at line 215 of file CPProgressIndicator.j.
- (void) setFrameSize: | (CGSize) | aSize | [implementation] |
Definition at line 403 of file CPProgressIndicator.j.
- (void) setIndeterminate: | (BOOL) | isIndeterminate | [implementation] |
Specifies whether this progress indicator should be indeterminate or display progress based on it's max and min.
isDeterminate | YES makes the indicator indeterminate |
Definition at line 321 of file CPProgressIndicator.j.
- (void) setMaxValue: | (double) | aValue | [implementation] |
Sets the maximum value of the progress indicator. The default is 100.0.
aValue | the new maximum value. |
Definition at line 251 of file CPProgressIndicator.j.
- (void) setMinValue: | (double) | aValue | [implementation] |
Sets the minimum value of the progress indicator. The default is 0.0.
aValue | the new minimum value |
Definition at line 234 of file CPProgressIndicator.j.
- (void) setStyle: | (CPProgressIndicatorStyle) | aStyle | [implementation] |
Sets the progress indicator's style
aStyle | the style to set it to |
Definition at line 343 of file CPProgressIndicator.j.
- (void) setUsesThreadedAnimation: | (BOOL) | aFlag | [implementation] |
Definition at line 168 of file CPProgressIndicator.j.
- (void) sizeToFit | [implementation] |
Resizes the indicator based on it's style.
Definition at line 356 of file CPProgressIndicator.j.
- (void) startAnimation: | (id) | aSender | [implementation] |
Starts the animation of the progress indicator in indeterminate mode.
the | requesting object |
Definition at line 176 of file CPProgressIndicator.j.
- (void) stopAnimation: | (id) | aSender | [implementation] |
Stops the animation of the progress indicator in indeterminate mode.
the | requesting object |
Definition at line 187 of file CPProgressIndicator.j.
- (void) updateBackgroundColor | [implementation] |
Definition at line 440 of file CPProgressIndicator.j.
- (BOOL) usesThreadedAnimation | [implementation] |
Always returns NO
. Cappuccino does not have multiple threads.
Definition at line 197 of file CPProgressIndicator.j.