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
(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
Instance Methods inherited from CPView
(BOOL)	- acceptsFirstMouse:
(void)	- addSubview:
(void)	- addSubview:positioned:relativeTo:
(CGRect)	- adjustScroll:
(float)	- alphaValue
(BOOL)	- autoresizesSubviews
(unsigned)	- autoresizingMask
(BOOL)	- autoscroll:
(CPColor)	- backgroundColor
(CGRect)	- bounds
(CGPoint)	- boundsOrigin
(CGSize)	- boundsSize
(BOOL)	- canBecomeKeyView
(CGPoint)	- center
(BOOL)	- clipsToBounds
(CGPoint)	- convertPoint:fromView:
(CGPoint)	- convertPoint:toView:
(CGPoint)	- convertPointFromBase:
(CGPoint)	- convertPointToBase:
(CGRect)	- convertRect:fromView:
(CGRect)	- convertRect:toView:
(CGRect)	- convertRectFromBase:
(CGRect)	- convertRectToBase:
(CGSize)	- convertSize:fromView:
(CGSize)	- convertSize:toView:
(id)	- currentValueForThemeAttribute:
(void)	- didAddSubview:
(void)	- display
(void)	- displayIfNeeded
(void)	- displayIfNeededInRect:
(void)	- displayRect:
(void)	- displayRectIgnoringOpacity:inContext:
(void)	- dragImage:at:offset:event:pasteboard:source:slideBack:
(void)	- dragView:at:offset:event:pasteboard:source:slideBack:
(void)	- drawRect:
(CPMenuItem)	- enclosingMenuItem
(CPScrollView)	- enclosingScrollView
(BOOL)	- enterFullScreenMode
(BOOL)	- enterFullScreenMode:withOptions:
(CPView)	- ephemeralSubviewNamed:
(void)	- exitFullScreenMode
(void)	- exitFullScreenModeWithOptions:
(CGRect)	- frame
(CGPoint)	- frameOrigin
(CGSize)	- frameSize
(BOOL)	- hasThemeAttribute:
(BOOL)	- hasThemeState:
(CPView)	- hitTest:
(BOOL)	- hitTests
(id)	- init
(BOOL)	- inLiveResize
(BOOL)	- isDescendantOf:
(BOOL)	- isFlipped
(BOOL)	- isHidden
(BOOL)	- isHiddenOrHasHiddenAncestor
(BOOL)	- isInFullScreenMode
(BOOL)	- isOpaque
(CALayer)	- layer
(CPView)	- layoutEphemeralSubviewNamed:positioned:relativeToEphemeralSubviewNamed:
(void)	- layoutIfNeeded
(void)	- layoutSubviews
(void)	- lockFocus
(CPMenu)	- menuForEvent:
(void)	- mouseDown:
(BOOL)	- mouseDownCanMoveWindow
(BOOL)	- needsDisplay
(BOOL)	- needsPanelToBecomeKey
(CPView)	- nextKeyView
(CPView)	- nextValidKeyView
(BOOL)	- performKeyEquivalent:
(BOOL)	- postsBoundsChangedNotifications
(BOOL)	- postsFrameChangedNotifications
(CPView)	- previousKeyView
(CPView)	- previousValidKeyView
(void)	- reflectScrolledClipView:
(CPArray)	- registeredDraggedTypes
(void)	- registerForDraggedTypes:
(void)	- registerThemeValues:
(void)	- registerThemeValues:inherit:
(void)	- removeFromSuperview
(void)	- replaceSubview:with:
(void)	- resizeSubviewsWithOldSize:
(void)	- resizeWithOldSuperviewSize:
(void)	- rightMouseDown:
(void)	- scrollClipView:toPoint:
(void)	- scrollPoint:
(void)	- scrollRect:by:
(BOOL)	- scrollRectToVisible:
(void)	- setAlphaValue:
(void)	- setAutoresizesSubviews:
(void)	- setAutoresizingMask:
(void)	- setBackgroundColor:
(void)	- setBounds:
(void)	- setBoundsOrigin:
(void)	- setBoundsSize:
(void)	- setCenter:
(void)	- setClipsToBounds:
(void)	- setFrame:
(void)	- setFrameOrigin:
(void)	- setHidden:
(void)	- setHitTests:
(void)	- setLayer:
(void)	- setNeedsDisplay:
(void)	- setNeedsDisplayInRect:
(void)	- setNeedsLayout
(void)	- setNextKeyView:
(void)	- setPostsBoundsChangedNotifications:
(void)	- setPostsFrameChangedNotifications:
(void)	- setSubviews:
(void)	- setTag:
(void)	- setTheme:
(void)	- setThemeClass:
(BOOL)	- setThemeState:
(void)	- setToolTip:
(void)	- setValue:forThemeAttribute:
(void)	- setValue:forThemeAttribute:inState:
(void)	- setWantsLayer:
(CPArray)	- subviews
(CPView)	- superview
(CPInteger)	- tag
(CPTheme)	- theme
(CPString)	- themeClass
(unsigned)	- themeState
(CPString)	- toolTip
(void)	- unlockFocus
(void)	- unregisterDraggedTypes
(BOOL)	- unsetThemeState:
(id)	- valueForThemeAttribute:
(id)	- valueForThemeAttribute:inState:
(void)	- viewDidChangeTheme
(void)	- viewDidEndLiveResize
(void)	- viewDidHide
(void)	- viewDidMoveToSuperview
(void)	- viewDidMoveToWindow
(void)	- viewDidUnhide
(void)	- viewWillDraw
(void)	- viewWillMoveToSuperview:
(void)	- viewWillMoveToWindow:
(void)	- viewWillStartLiveResize
(CPView)	- viewWithTag:
(CGRect)	- visibleRect
(BOOL)	- wantsLayer
(void)	- willRemoveSubview:
(CPWindow)	- window
Instance Methods inherited from CPResponder
(BOOL)	- acceptsFirstResponder
(BOOL)	- becomeFirstResponder
(void)	- doCommandBySelector:
(void)	- flagsChanged:
(void)	- insertBackTab:
(void)	- insertLineBreak:
(void)	- insertNewline:
(void)	- insertTab:
(void)	- insertText:
(void)	- interpretKeyEvents:
(void)	- keyDown:
(void)	- keyUp:
(CPMenu)	- menu
(void)	- mouseDragged:
(void)	- mouseEntered:
(void)	- mouseExited:
(void)	- mouseMoved:
(void)	- mouseUp:
(CPResponder)	- nextResponder
(void)	- noResponderFor:
(BOOL)	- resignFirstResponder
(void)	- rightMouseUp:
(void)	- scrollWheel:
(void)	- setMenu:
(void)	- setNextResponder:
(BOOL)	- tryToPerform:with:
(CPUndoManager)	- undoManager
Instance Methods inherited from CPObject
(void)	- addObserver:forKeyPath:options:context:
(void)	- applyChange:toKeyPath:
(id)	- autorelease
(id)	- awakeAfterUsingCoder:
(void)	- awakeFromCib
(void)	- bind:toObject:withKeyPath:options:
(Class)	- classForCoder
(Class)	- classForKeyedArchiver
(CPString)	- className
(id)	- copy
(void)	- dealloc
(CPString)	- description
(CPDictionary)	- dictionaryWithValuesForKeys:
(void)	- didChange:valuesAtIndexes:forKey:
(void)	- didChangeValueForKey:
(void)	- didChangeValueForKey:withSetMutation:usingObjects:
(void)	- doesNotRecognizeSelector:
(CPArray)	- exposedBindings
(id)	- forwardingTargetForSelector:
(void)	- forwardInvocation:
(unsigned)	- hash
(BOOL)	- implementsSelector:
(CPDictionary)	- infoForBinding:
(BOOL)	- isEqual:
(BOOL)	- isKindOfClass:
(BOOL)	- isMemberOfClass:
(BOOL)	- isProxy
(IMP)	- methodForSelector:
(CPMethodSignature)	- methodSignatureForSelector:
(id)	- mutableArrayValueForKey:
(id)	- mutableArrayValueForKeyPath:
(id)	- mutableCopy
(id)	- mutableSetValueForKey:
(id)	- mutableSetValueForKeyPath:
(id)	- performSelector:
(id)	- performSelector:withObject:
(id)	- performSelector:withObject:withObject:
(id)	- performSelector:withObjects:
(void)	- release
(void)	- removeObserver:forKeyPath:
(id)	- replacementObjectForArchiver:
(id)	- replacementObjectForCoder:
(id)	- replacementObjectForKeyedArchiver:
(BOOL)	- respondsToSelector:
(id)	- retain
(id)	- self
(void)	- setValue:forKey:
(void)	- setValue:forKeyPath:
(void)	- setValue:forUndefinedKey:
(void)	- setValuesForKeysWithDictionary:
(CPString)	- UID
(void)	- unbind:
(Class)	- valueClassForBinding:
(id)	- valueForKey:
(id)	- valueForKeyPath:
(id)	- valueForUndefinedKey:
(void)	- willChange:valuesAtIndexes:forKey:
(void)	- willChangeValueForKey:
(void)	- willChangeValueForKey:withSetMutation:usingObjects:

Class Methods
(void)	+ initialize
Class Methods inherited from CPView
(CPMenu)	+ defaultMenu
(CPString)	+ defaultThemeClass
(CPSet)	+ keyPathsForValuesAffectingBounds
(CPSet)	+ keyPathsForValuesAffectingFrame
(CPDictionary)	+ themeAttributes
Class Methods inherited from CPObject
(BOOL)	+ accessInstanceVariablesDirectly
(id)	+ alloc
(id)	+ allocWithCoder:
(BOOL)	+ automaticallyNotifiesObserversForKey:
(Class)	+ class
(void)	+ exposeBinding:
(IMP)	+ instanceMethodForSelector:
(BOOL)	+ instancesRespondToSelector:
(BOOL)	+ isSubclassOfClass:
(CPSet)	+ keyPathsForValuesAffectingValueForKey:
(void)	+ load
(id)	+ new
(void)	+ setVersion:
(Class)	+ superclass
(int)	+ version

Additional Inherited Members
Instance Variables inherited from CPObject
Class	isa

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

- (CPControlTint) controlTint

implementation

Definition at line 290 of file CPProgressIndicator.j.

- (CPView) createEphemeralSubviewNamed: (CPString)  aName

implementation

Reimplemented from CPView.

Definition at line 421 of file CPProgressIndicator.j.

- (double) doubleValue

implementation

Returns the value of the progress indicator.

Definition at line 218 of file CPProgressIndicator.j.

- (void) drawBar

implementation

Definition at line 403 of file CPProgressIndicator.j.

- (void) encodeWithCoder: (CPCoder)  aCoder

implementation

Archives the view to a coder.

Parameters

aCoder

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

Reimplemented from CPView.

Provided by category CPProgressIndicator(CPCoding).

Definition at line 498 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 200 of file CPProgressIndicator.j.

+ (void) initialize

implementation

Reimplemented from CPView.

Definition at line 76 of file CPProgressIndicator.j.

- (id) initWithCoder: (CPCoder)  aCoder

implementation

Initializes the view from an archive.

Parameters

aCoder

the coder from which to initialize

Returns

the initialized view

Reimplemented from CPView.

Provided by category CPProgressIndicator(CPCoding).

Definition at line 478 of file CPProgressIndicator.j.

- (id) initWithFrame: (CGRect)  aFrame

implementation

Initializes the receiver for usage with the specified bounding rectangle

Returns

the initialized view

Reimplemented from CPView.

Definition at line 135 of file CPProgressIndicator.j.

- (BOOL) isBezeled

implementation

Definition at line 305 of file CPProgressIndicator.j.

- (BOOL) isDisplayedWhenStopped

implementation

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

Definition at line 378 of file CPProgressIndicator.j.

- (BOOL) isIndeterminate

implementation

Returns YES if the progress bar is indeterminate.

Definition at line 327 of file CPProgressIndicator.j.

- (double) maxValue

implementation

Returns the maximum value of the progress indicator.

Definition at line 252 of file CPProgressIndicator.j.

- (double) minValue

implementation

Returns the minimum value of the progress indicator.

Definition at line 235 of file CPProgressIndicator.j.

- (CGRect) rectForEphemeralSubviewNamed: (CPString)  aViewName

implementation

Reimplemented from CPView.

Definition at line 426 of file CPProgressIndicator.j.

- (void) setBezeled: (BOOL)  isBezeled

implementation

Definition at line 298 of file CPProgressIndicator.j.

- (void) setControlSize: (CPControlSize)  aControlSize

implementation

Sets the progress indicator's size.

Parameters

aControlSize

the new size

Definition at line 262 of file CPProgressIndicator.j.

- (void) setControlTint: (CPControlTint)  aControlTint

implementation

Definition at line 283 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 363 of file CPProgressIndicator.j.

- (void) setDoubleValue: (double)  aValue

implementation

Sets the progress value of the indicator.

Definition at line 208 of file CPProgressIndicator.j.

- (void) setFrameSize: (CGSize)  aSize

implementation

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

aSize

the new size for the frame

Reimplemented from CPView.

Definition at line 395 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 314 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 244 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 227 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 336 of file CPProgressIndicator.j.

- (void) setUsesThreadedAnimation: (BOOL)  aFlag

implementation

Definition at line 161 of file CPProgressIndicator.j.

- (void) sizeToFit

implementation

Resizes the indicator based on it's style.

Definition at line 349 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 169 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 180 of file CPProgressIndicator.j.

- (void) updateBackgroundColor

implementation

Definition at line 443 of file CPProgressIndicator.j.

- (BOOL) usesThreadedAnimation

implementation

Always returns NO. Cappuccino does not have multiple threads.

Definition at line 190 of file CPProgressIndicator.j.

---

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

• AppKit/CPProgressIndicator.h
• AppKit/CPProgressIndicator.j