API  0.9.7
 All Classes Files Functions Variables Macros Groups Pages
CPProgressIndicator Class Reference

#import <CPProgressIndicator.h>

+ Inheritance diagram for CPProgressIndicator:

Instance Methods

(CPControlSize) - controlSize
 
(CPControlTint) - controlTint
 
(CPView- createEphemeralSubviewNamed:
 
(double) - doubleValue
 
(void) - drawBar
 
(void) - encodeWithCoder:
 
(void) - incrementBy:
 
(id) - initWithCoder:
 
(id) - initWithFrame:
 
(BOOL) - isBezeled
 
(BOOL) - isDisplayedWhenStopped
 
(BOOL) - isIndeterminate
 
(void) - layoutSubviews
 
(double) - maxValue
 
(double) - minValue
 
(CGRect) - rectForEphemeralSubviewNamed:
 
(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

(CPString+ defaultThemeClass
 
(CPDictionary+ themeAttributes
 

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
implementation

Returns the progress indicator's size

Definition at line 234 of file CPProgressIndicator.j.

- (CPControlTint) controlTint
implementation

Definition at line 249 of file CPProgressIndicator.j.

- (CPView) createEphemeralSubviewNamed: (CPString aName
implementation

Definition at line 368 of file CPProgressIndicator.j.

+ (CPString) defaultThemeClass
implementation

Definition at line 69 of file CPProgressIndicator.j.

- (double) doubleValue
implementation

Returns the value of the progress indicator.

Definition at line 177 of file CPProgressIndicator.j.

- (void) drawBar
implementation

Definition at line 363 of file CPProgressIndicator.j.

- (void) encodeWithCoder: (CPCoder aCoder
implementation

Provided by category CPProgressIndicator(CPCoding).

Definition at line 461 of file CPProgressIndicator.j.

- (void) incrementBy: (double)  aValue
implementation

Increases the progress of the bar by the specified value.

Parameters
aValuethe amount to increase the progress value

Definition at line 159 of file CPProgressIndicator.j.

- (id) initWithCoder: (CPCoder aCoder
implementation

Provided by category CPProgressIndicator(CPCoding).

Definition at line 441 of file CPProgressIndicator.j.

- (id) initWithFrame: (CGRect)  aFrame
implementation

Definition at line 95 of file CPProgressIndicator.j.

- (BOOL) isBezeled
implementation

Definition at line 264 of file CPProgressIndicator.j.

- (BOOL) isDisplayedWhenStopped
implementation

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

Definition at line 338 of file CPProgressIndicator.j.

- (BOOL) isIndeterminate
implementation

Returns YES if the progress bar is indeterminate.

Definition at line 286 of file CPProgressIndicator.j.

- (void) layoutSubviews
implementation

Definition at line 405 of file CPProgressIndicator.j.

- (double) maxValue
implementation

Returns the maximum value of the progress indicator.

Definition at line 211 of file CPProgressIndicator.j.

- (double) minValue
implementation

Returns the minimum value of the progress indicator.

Definition at line 194 of file CPProgressIndicator.j.

- (CGRect) rectForEphemeralSubviewNamed: (CPString aViewName
implementation

Definition at line 373 of file CPProgressIndicator.j.

- (void) setBezeled: (BOOL)  isBezeled
implementation

Definition at line 257 of file CPProgressIndicator.j.

- (void) setControlSize: (CPControlSize)  aControlSize
implementation

Sets the progress indicator's size.

Parameters
aControlSizethe new size

Definition at line 221 of file CPProgressIndicator.j.

- (void) setControlTint: (CPControlTint)  aControlTint
implementation

Definition at line 242 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
isDisplayedWhenStoppedYES means the indicator will be displayed when it's not animating.

Definition at line 323 of file CPProgressIndicator.j.

- (void) setDoubleValue: (double)  aValue
implementation

Sets the progress value of the indicator.

Definition at line 167 of file CPProgressIndicator.j.

- (void) setFrameSize: (CGSize)  aSize
implementation

Definition at line 355 of file CPProgressIndicator.j.

- (void) setIndeterminate: (BOOL)  indeterminate
implementation

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

- (void) setMaxValue: (double)  aValue
implementation

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

Parameters
aValuethe new maximum value.

Definition at line 203 of file CPProgressIndicator.j.

- (void) setMinValue: (double)  aValue
implementation

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

Parameters
aValuethe new minimum value

Definition at line 186 of file CPProgressIndicator.j.

- (void) setStyle: (CPProgressIndicatorStyle)  aStyle
implementation

Sets the progress indicator's style

Parameters
aStylethe style to set it to

Definition at line 295 of file CPProgressIndicator.j.

- (void) setUsesThreadedAnimation: (BOOL)  aFlag
implementation

Definition at line 120 of file CPProgressIndicator.j.

- (void) sizeToFit
implementation

Resizes the indicator based on it's style.

Definition at line 310 of file CPProgressIndicator.j.

- (void) startAnimation: (id)  aSender
implementation

Starts the animation of the progress indicator in indeterminate mode.

Parameters
therequesting object

Definition at line 128 of file CPProgressIndicator.j.

- (void) stopAnimation: (id)  aSender
implementation

Stops the animation of the progress indicator in indeterminate mode.

Parameters
therequesting object

Definition at line 139 of file CPProgressIndicator.j.

+ (CPDictionary) themeAttributes
implementation

Definition at line 74 of file CPProgressIndicator.j.

- (void) updateBackgroundColor
implementation

Definition at line 393 of file CPProgressIndicator.j.

- (BOOL) usesThreadedAnimation
implementation

Always returns NO. Cappuccino does not have multiple threads.

Definition at line 149 of file CPProgressIndicator.j.


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