CPProgressIndicator Class Reference

List of all members.

Public Member Functions

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

Static Public Member Functions

(void) + initialize [implementation]


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 58 of file CPProgressIndicator.j.


Member Function Documentation

- (CPControlSize) controlSize   [implementation]

Returns the progress indicator's size

Definition at line 293 of file CPProgressIndicator.j.

- (CPControlTint) controlTint   [implementation]

Definition at line 308 of file CPProgressIndicator.j.

- (double) doubleValue   [implementation]

Returns the value of the progress indicator.

Definition at line 236 of file CPProgressIndicator.j.

- (void) drawBar   [implementation]

Definition at line 422 of file CPProgressIndicator.j.

- (void) incrementBy: (double)  aValue   [implementation]

Increases the progress of the bar by the specified value.

Parameters:
aValue the amount to increase the progress value

Definition at line 218 of file CPProgressIndicator.j.

+ (void) initialize   [implementation]

Definition at line 81 of file CPProgressIndicator.j.

- (id) initWithFrame: (CGRect)  aFrame   [implementation]

Definition at line 153 of file CPProgressIndicator.j.

- (BOOL) isBezeled   [implementation]

Definition at line 323 of file CPProgressIndicator.j.

- (BOOL) isDisplayedWhenStopped   [implementation]

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

Definition at line 397 of file CPProgressIndicator.j.

- (BOOL) isIndeterminate   [implementation]

Returns YES if the progress bar is indeterminate.

Definition at line 345 of file CPProgressIndicator.j.

- (double) maxValue   [implementation]

Returns the maximum value of the progress indicator.

Definition at line 270 of file CPProgressIndicator.j.

- (double) minValue   [implementation]

Returns the minimum value of the progress indicator.

Definition at line 253 of file CPProgressIndicator.j.

- (void) setBezeled: (BOOL)  isBezeled   [implementation]

Definition at line 316 of file CPProgressIndicator.j.

- (void) setControlSize: (CPControlSize)  aControlSize   [implementation]

Sets the progress indicator's size.

Parameters:
aControlSize the new size

Definition at line 280 of file CPProgressIndicator.j.

- (void) setControlTint: (CPControlTint)  aControlTint   [implementation]

Definition at line 301 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.

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

Definition at line 382 of file CPProgressIndicator.j.

- (void) setDoubleValue: (double)  aValue   [implementation]

Sets the progress value of the indicator.

Definition at line 226 of file CPProgressIndicator.j.

- (void) setFrameSize: (CGSize)  aSize   [implementation]

Definition at line 414 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.

Parameters:
isDeterminate YES makes the indicator indeterminate

Definition at line 332 of file CPProgressIndicator.j.

- (void) setMaxValue: (double)  aValue   [implementation]

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

Parameters:
aValue the new maximum value.

Definition at line 262 of file CPProgressIndicator.j.

- (void) setMinValue: (double)  aValue   [implementation]

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

Parameters:
aValue the new minimum value

Definition at line 245 of file CPProgressIndicator.j.

- (void) setStyle: (CPProgressIndicatorStyle)  aStyle   [implementation]

Sets the progress indicator's style

Parameters:
aStyle the style to set it to

Definition at line 354 of file CPProgressIndicator.j.

- (void) setUsesThreadedAnimation: (BOOL)  aFlag   [implementation]

Definition at line 179 of file CPProgressIndicator.j.

- (void) sizeToFit   [implementation]

Resizes the indicator based on it's style.

Definition at line 367 of file CPProgressIndicator.j.

- (void) startAnimation: (id)  aSender   [implementation]

Starts the animation of the progress indicator in indeterminate mode.

Parameters:
the requesting object

Definition at line 187 of file CPProgressIndicator.j.

- (void) stopAnimation: (id)  aSender   [implementation]

Stops the animation of the progress indicator in indeterminate mode.

Parameters:
the requesting object

Definition at line 198 of file CPProgressIndicator.j.

- (void) updateBackgroundColor   [implementation]

Definition at line 447 of file CPProgressIndicator.j.

- (BOOL) usesThreadedAnimation   [implementation]

Always returns NO. Cappuccino does not have multiple threads.

Definition at line 208 of file CPProgressIndicator.j.


The documentation for this class was generated from the following file:

Generated on Thu Dec 11 01:55:50 2008 for Cappuccino by  doxygen 1.5.7.1