CPProgressIndicator Class Reference

#import <CPProgressIndicator.h>

Inheritance diagram for CPProgressIndicator:

Instance Methods
(CPControlSize)	- controlSize
(CPControlTint)	- controlTint
(CPView)	- createEphemeralSubviewNamed:
(double)	- doubleValue
(void)	- drawBar
(void)	- drawRect:
(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
Instance Methods inherited from CPView
(BOOL)	- acceptsFirstMouse:
(void)	- addSubview:
(void)	- addSubview:positioned:relativeTo:
(void)	- addTrackingArea:
(CGRect)	- adjustScroll:
(float)	- alphaValue
(CAAnimation)	- animationForKey:
(CPDictionary)	- animations
(id)	- animator
(BOOL)	- autoresizesSubviews
(unsigned)	- autoresizingMask
(BOOL)	- autoscroll:
(CPColor)	- backgroundColor
(BOOL)	- becomeFirstResponder
(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:
(CPString)	- debug_description
(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:
(CPAppearance)	- effectiveAppearance
(CPMenuItem)	- enclosingMenuItem
(CPScrollView)	- enclosingScrollView
(BOOL)	- enterFullScreenMode
(BOOL)	- enterFullScreenMode:withOptions:
(CPView)	- ephemeralSubviewNamed:
(void)	- exitFullScreenMode
(void)	- exitFullScreenModeWithOptions:
(CGRect)	- frame
(CGPoint)	- frameOrigin
(CGRect)	- frameRectOfView:inSuperviewSize:
(CGSize)	- frameSize
(CGRect)	- frameWithNewSuperviewSize:
(BOOL)	- hasCustomDrawRect
(BOOL)	- hasCustomLayoutSubviews
(CPView)	- hitTest:
(BOOL)	- hitTests
(id)	- init
(BOOL)	- inLiveResize
(BOOL)	- isDescendantOf:
(BOOL)	- isFlipped
(BOOL)	- isHidden
(BOOL)	- isHiddenOrHasHiddenAncestor
(BOOL)	- isInFullScreenMode
(BOOL)	- isOpaque
(CALayer)	- layer
(void)	- layout
(CPView)	- layoutEphemeralSubviewNamed:positioned:relativeToEphemeralSubviewNamed:
(void)	- layoutIfNeeded
(void)	- lockFocus
(CPMenu)	- menuForEvent:
(void)	- mouseDown:
(BOOL)	- mouseDownCanMoveWindow
(BOOL)	- needsDisplay
(BOOL)	- needsLayout
(BOOL)	- needsPanelToBecomeKey
(CPView)	- nextKeyView
(CPView)	- nextValidKeyView
(void)	- objectDidChangeTheme
(BOOL)	- performKeyEquivalent:
(BOOL)	- postsBoundsChangedNotifications
(BOOL)	- postsFrameChangedNotifications
(CPView)	- previousKeyView
(CPView)	- previousValidKeyView
(void)	- reflectScrolledClipView:
(CPArray)	- registeredDraggedTypes
(void)	- registerForDraggedTypes:
(void)	- removeFromSuperview
(void)	- removeTrackingArea:
(void)	- replaceSubview:with:
(BOOL)	- resignFirstResponder
(void)	- resizeSubviewsWithOldSize:
(void)	- resizeWithOldSuperviewSize:
(void)	- rightMouseDown:
(CGSize)	- scaleSize
(void)	- scaleUnitSquareToSize:
(void)	- scrollClipView:toPoint:
(void)	- scrollPoint:
(void)	- scrollRect:by:
(BOOL)	- scrollRectToVisible:
(void)	- setAlphaValue:
(void)	- setAnimations:
(void)	- setAppearance:
(void)	- setAutoresizesSubviews:
(void)	- setAutoresizingMask:
(void)	- setBackgroundColor:
(void)	- setBounds:
(void)	- setBoundsOrigin:
(void)	- setBoundsSize:
(void)	- setCenter:
(void)	- setClipsToBounds:
(void)	- setDOMClassName:
(void)	- setFrame:
(void)	- setFrameOrigin:
(void)	- setHidden:
(void)	- setHitTests:
(void)	- setLayer:
(void)	- setNeedsDisplay:
(void)	- setNeedsDisplayInRect:
(void)	- setNeedsLayout
(void)	- setNeedsLayout:
(void)	- setNextKeyView:
(void)	- setPostsBoundsChangedNotifications:
(void)	- setPostsFrameChangedNotifications:
(void)	- setScaleSize:
(void)	- setSubviews:
(void)	- setTag:
(void)	- setThemeClass:
(BOOL)	- setThemeState:
(void)	- setToolTip:
(void)	- setValue:forThemeAttribute:
(void)	- setValue:forThemeAttribute:inState:
(void)	- setWantsLayer:
(CPArray)	- subviews
(CPView)	- superview
(CPInteger)	- tag
(void)	- unlockFocus
(void)	- unregisterDraggedTypes
(BOOL)	- unsetThemeState:
(void)	- updateTrackingAreas
(void)	- viewDidEndLiveResize
(void)	- viewDidHide
(void)	- viewDidLayout
(void)	- viewDidMoveToSuperview
(void)	- viewDidMoveToWindow
(void)	- viewDidUnhide
(void)	- viewWillDraw
(void)	- viewWillLayout
(void)	- viewWillMoveToSuperview:
(void)	- viewWillMoveToWindow:
(void)	- viewWillStartLiveResize
(CPView)	- viewWithTag:
(CGRect)	- visibleRect
(BOOL)	- wantsLayer
(void)	- willRemoveSubview:
(CPWindow)	- window

Class Methods
(CPString)	+ defaultThemeClass
(CPDictionary)	+ themeAttributes
Class Methods inherited from CPView
(Class)	+ animatorClass
(CAAnimation)	+ defaultAnimationForKey:
(CPMenu)	+ defaultMenu
(void)	+ initialize
(BOOL)	+ isHighDPIDrawingEnabled
(CPSet)	+ keyPathsForValuesAffectingBounds
(CPSet)	+ keyPathsForValuesAffectingFrame
(void)	+ setHighDPIDrawingEnabled:

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

controlSize()

- (CPControlSize) controlSize

implementation

Returns the progress indicator's size

Definition at line 237 of file CPProgressIndicator.j.

controlTint()

- (CPControlTint) controlTint

implementation

Definition at line 252 of file CPProgressIndicator.j.

createEphemeralSubviewNamed:()

- (CPView) createEphemeralSubviewNamed: (CPString)  aName

implementation

Reimplemented from CPView.

Definition at line 372 of file CPProgressIndicator.j.

defaultThemeClass()

+ (CPString) defaultThemeClass

implementation

Reimplemented from CPView.

Definition at line 69 of file CPProgressIndicator.j.

doubleValue()

- (double) doubleValue

implementation

Returns the value of the progress indicator.

Definition at line 180 of file CPProgressIndicator.j.

drawBar()

- (void) drawBar

implementation

Definition at line 366 of file CPProgressIndicator.j.

drawRect:()

- (void) drawRect: (CGRect)  aRect

implementation

Draws the receiver into aRect. This method should be overridden by subclasses.

Parameters

aRect

the area that should be drawn into

Reimplemented from CPView.

Definition at line 443 of file CPProgressIndicator.j.

encodeWithCoder:()

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

incrementBy:()

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

initWithCoder:()

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

initWithFrame:()

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

isBezeled()

- (BOOL) isBezeled

implementation

Definition at line 267 of file CPProgressIndicator.j.

isDisplayedWhenStopped()

- (BOOL) isDisplayedWhenStopped

implementation

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

Definition at line 341 of file CPProgressIndicator.j.

isIndeterminate()

- (BOOL) isIndeterminate

implementation

Returns YES if the progress bar is indeterminate.

Definition at line 289 of file CPProgressIndicator.j.

layoutSubviews()

- (void) layoutSubviews

implementation

Reimplemented from CPView.

Definition at line 409 of file CPProgressIndicator.j.

maxValue()

- (double) maxValue

implementation

Returns the maximum value of the progress indicator.

Definition at line 214 of file CPProgressIndicator.j.

minValue()

- (double) minValue

implementation

Returns the minimum value of the progress indicator.

Definition at line 197 of file CPProgressIndicator.j.

rectForEphemeralSubviewNamed:()

- (CGRect) rectForEphemeralSubviewNamed: (CPString)  aViewName

implementation

Reimplemented from CPView.

Definition at line 377 of file CPProgressIndicator.j.

setBezeled:()

- (void) setBezeled: (BOOL)  isBezeled

implementation

Definition at line 260 of file CPProgressIndicator.j.

setControlSize:()

- (void) setControlSize: (CPControlSize)  aControlSize

implementation

Sets the progress indicator's size.

Parameters

aControlSize

the new size

Definition at line 224 of file CPProgressIndicator.j.

setControlTint:()

- (void) setControlTint: (CPControlTint)  aControlTint

implementation

Definition at line 245 of file CPProgressIndicator.j.

setDisplayedWhenStopped:()

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

setDoubleValue:()

- (void) setDoubleValue: (double)  aValue

implementation

Sets the progress value of the indicator.

Definition at line 170 of file CPProgressIndicator.j.

setFrameSize:()

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

setIndeterminate:()

- (void) setIndeterminate: (BOOL)  indeterminate

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

setMaxValue:()

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

setMinValue:()

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

setStyle:()

- (void) setStyle: (CPProgressIndicatorStyle)  aStyle

implementation

Sets the progress indicator's style

Parameters

aStyle

the style to set it to

Definition at line 298 of file CPProgressIndicator.j.

setUsesThreadedAnimation:()

- (void) setUsesThreadedAnimation: (BOOL)  aFlag

implementation

Definition at line 123 of file CPProgressIndicator.j.

sizeToFit()

- (void) sizeToFit

implementation

Resizes the indicator based on it's style.

Definition at line 313 of file CPProgressIndicator.j.

startAnimation:()

- (void) startAnimation: (id)  aSender

implementation

Starts the animation of the progress indicator in indeterminate mode.

Parameters

the	requesting object

Definition at line 131 of file CPProgressIndicator.j.

stopAnimation:()

- (void) stopAnimation: (id)  aSender

implementation

Stops the animation of the progress indicator in indeterminate mode.

Parameters

the	requesting object

Definition at line 142 of file CPProgressIndicator.j.

themeAttributes()

+ (CPDictionary) themeAttributes

implementation

Reimplemented from CPView.

Definition at line 74 of file CPProgressIndicator.j.

updateBackgroundColor()

- (void) updateBackgroundColor

implementation

Definition at line 397 of file CPProgressIndicator.j.

usesThreadedAnimation()

- (BOOL) usesThreadedAnimation

implementation

Always returns NO. Cappuccino does not have multiple threads.

Definition at line 152 of file CPProgressIndicator.j.

---

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

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