CPScroller Class Reference

#import <CPScroller.h>

Inheritance diagram for CPScroller:

Instance Methods
(BOOL)	- allowFadingOut
(void)	- animationDidEnd:
(void)	- checkSpaceForParts
(CPControlSize)	- controlSize
(CPView)	- createEphemeralSubviewNamed:
(CPView)	- createViewForPart:
(id)	- currentValueForThemeAttribute:
(void)	- drawArrow:highlight:
(void)	- drawKnob
(void)	- drawKnobSlot
(void)	- drawParts
(void)	- encodeWithCoder:
(void)	- fadeIn
(void)	- fadeOut
(CPScrollerPart)	- hitPart
(id)	- initWithCoder:
(id)	- initWithFrame:
(BOOL)	- isVertical
(float)	- knobProportion
(void)	- layoutSubviews
(void)	- mouseDown:
(void)	- mouseEntered:
(void)	- mouseExited:
(CGRect)	- rectForEphemeralSubviewNamed:
(CGRect)	- rectForPart:
(void)	- setControlSize:
(void)	- setFloatValue:knobProportion:
(void)	- setFrameSize:
(void)	- setKnobProportion:
(void)	- setObjectValue:
(void)	- setStyle:
(void)	- style
(CPScrollerPart)	- testPart:
(void)	- trackKnob:
(void)	- trackScrollButtons:
(CPUsableScrollerParts)	- usableParts
Instance Methods inherited from CPControl
(SEL)	- action
(CPTextAlignment)	- alignment
(BOOL)	- continueTracking:at:
(double)	- doubleValue
(float)	- floatValue
(CPFont)	- font
(CPFormatter)	- formatter
(void)	- highlight:
(CPCellImagePosition)	- imagePosition
(CPImageScaling)	- imageScaling
(int)	- integerValue
(int)	- intValue
(BOOL)	- isContinuous
(BOOL)	- isEnabled
(BOOL)	- isHighlighted
(CPLineBreakMode)	- lineBreakMode
(unsigned)	- mouseDownFlags
(int)	- nextState
(id)	- objectValue
(void)	- performClick:
(BOOL)	- sendAction:to:
(int)	- sendActionOn:
(BOOL)	- sendsActionOnEndEditing
(void)	- setAction:
(void)	- setAlignment:
(void)	- setContinuous:
(void)	- setDoubleValue:
(void)	- setEnabled:
(void)	- setFloatValue:
(void)	- setFont:
(void)	- setFormatter:
(void)	- setHighlighted:
(void)	- setImagePosition:
(void)	- setImageScaling:
(void)	- setIntegerValue:
(void)	- setIntValue:
(void)	- setLineBreakMode:
(void)	- setSendsActionOnEndEditing:
(void)	- setState:
(void)	- setStringValue:
(void)	- setTarget:
(void)	- setTextColor:
(void)	- setTextShadowColor:
(void)	- setTextShadowOffset:
(void)	- setVerticalAlignment:
(BOOL)	- startTrackingAt:
(void)	- stopTracking:at:mouseIsUp:
(CPString)	- stringValue
(void)	- takeDoubleValueFrom:
(void)	- takeFloatValueFrom:
(void)	- takeIntegerValueFrom:
(void)	- takeIntValueFrom:
(void)	- takeObjectValueFrom:
(void)	- takeStringValueFrom:
(id)	- target
(CPColor)	- textColor
(void)	- textDidBeginEditing:
(void)	- textDidChange:
(void)	- textDidEndEditing:
(CPColor)	- textShadowColor
(CGSize)	- textShadowOffset
(void)	- trackMouse:
(BOOL)	- tracksMouseOutsideOfFrame
(void)	- unhighlightButtonTimerDidFinish:
(CPTextVerticalAlignment)	- verticalAlignment
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:
(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)	- lockFocus
(CPMenu)	- menuForEvent:
(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)	- 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
(CPString)	+ defaultThemeClass
(float)	+ scrollerOverlay
(float)	+ scrollerWidth
(float)	+ scrollerWidthForControlSize:
(float)	+ scrollerWidthInStyle:
(id)	+ themeAttributes
Class Methods inherited from CPControl
(void)	+ initialize
Class Methods inherited from CPView
(CPMenu)	+ defaultMenu
(CPSet)	+ keyPathsForValuesAffectingBounds
(CPSet)	+ keyPathsForValuesAffectingFrame
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

Definition at line 2 of file CPScroller.h.

Method Documentation

- (BOOL) allowFadingOut

implementation

Synthesized accessor method.

Provided by category CPScroller(CPSynthesizedAccessors).

Definition at line 870 of file CPScroller.j.

- (void) animationDidEnd: (CPAnimation)  animation

implementation

Definition at line 781 of file CPScroller.j.

- (void) checkSpaceForParts

implementation

Check if there's enough space in the scroller to display the knob

Definition at line 350 of file CPScroller.j.

- (CPControlSize) controlSize

implementation

Returns the scroller's control size

Definition at line 230 of file CPScroller.j.

- (CPView) createEphemeralSubviewNamed: (CPString)  aName

implementation

Reimplemented from CPView.

Definition at line 514 of file CPScroller.j.

- (CPView) createViewForPart: (CPScrollerPart)  aPart

implementation

Definition at line 500 of file CPScroller.j.

- (id) currentValueForThemeAttribute: (CPString)  anAttributeName

implementation

Reimplemented from CPView.

Definition at line 716 of file CPScroller.j.

+ (CPString) defaultThemeClass

implementation

Reimplemented from CPView.

Definition at line 98 of file CPScroller.j.

- (void) drawArrow: (CPScrollerArrow)  anArrow highlight: (BOOL)  shouldHighlight

implementation

Draws the specified arrow and sets the highlight.

Parameters

anArrow	the arrow to draw
shouldHighlight	sets whether the arrow should be highlighted

Definition at line 482 of file CPScroller.j.

- (void) drawKnob

implementation

Draws the knob

Definition at line 489 of file CPScroller.j.

- (void) drawKnobSlot

implementation

Draws the knob's slot

Definition at line 496 of file CPScroller.j.

- (void) drawParts

implementation

Caches images for the scroll arrow and knob.

Definition at line 548 of file CPScroller.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 CPControl.

Provided by category CPScroller(CPCoding).

Definition at line 831 of file CPScroller.j.

- (void) fadeIn

implementation

Display the scroller

Definition at line 451 of file CPScroller.j.

- (void) fadeOut

implementation

Start the fade out anination

Definition at line 465 of file CPScroller.j.

- (CPScrollerPart) hitPart

implementation

Returns the part of the scroller that was hit.

Definition at line 560 of file CPScroller.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 CPControl.

Provided by category CPScroller(CPCoding).

Definition at line 794 of file CPScroller.j.

- (id) initWithFrame: (CGRect)  aFrame

implementation

Initializes the receiver for usage with the specified bounding rectangle

Returns

the initialized view

Reimplemented from CPControl.

Definition at line 158 of file CPScroller.j.

- (BOOL) isVertical

implementation

Synthesized accessor method.

Provided by category CPScroller(CPSynthesizedAccessors).

Definition at line 862 of file CPScroller.j.

- (float) knobProportion

implementation

Return's the knob's proportion

Definition at line 253 of file CPScroller.j.

- (void) layoutSubviews

implementation

Reimplemented from CPView.

Definition at line 523 of file CPScroller.j.

- (void) mouseDown: (CPEvent)  anEvent

implementation

Notifies the receiver that the user has clicked the mouse down in its area.

Parameters

anEvent

contains information about the click

Reimplemented from CPControl.

Definition at line 726 of file CPScroller.j.

- (void) mouseEntered: (CPEvent)  anEvent

implementation

Reimplemented from CPControl.

Definition at line 744 of file CPScroller.j.

- (void) mouseExited: (CPEvent)  anEvent

implementation

Notifies the receiver that the mouse exited the receiver's area.

Parameters

anEvent

contains information about the exit

Reimplemented from CPControl.

Definition at line 761 of file CPScroller.j.

- (CGRect) rectForEphemeralSubviewNamed: (CPString)  aName

implementation

Reimplemented from CPView.

Definition at line 509 of file CPScroller.j.

- (CGRect) rectForPart: (CPScrollerPart)  aPart

implementation

Definition at line 303 of file CPScroller.j.

+ (float) scrollerOverlay

implementation

Returns the CPScroller's overlay value.

Definition at line 140 of file CPScroller.j.

+ (float) scrollerWidth

implementation

Definition at line 120 of file CPScroller.j.

+ (float) scrollerWidthForControlSize: (CPControlSize)  aControlSize

implementation

Returns the width of a CPScroller for the specified CPControlSize.

Parameters

aControlSize

the size of a controller to return the width for

Definition at line 149 of file CPScroller.j.

+ (float) scrollerWidthInStyle: (int)  aStyle

implementation

Returns the CPScroller's width for a CPRegularControlSize.

Definition at line 128 of file CPScroller.j.

- (void) setControlSize: (CPControlSize)  aControlSize

implementation

Sets the scroller's size.

Parameters

aControlSize

the scroller's size

Definition at line 239 of file CPScroller.j.

- (void) setFloatValue: (float)  aValue knobProportion: (float)  aProportion

implementation

Sets the position and proportion of the knob.

Parameters

aValue	the knob position (ranges from 0.0 to 1.0)
aProportion	the knob's proportion (ranges from 0.0 to 1.0)

Provided by category CPScroller(Deprecated).

Definition at line 849 of file CPScroller.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 704 of file CPScroller.j.

- (void) setKnobProportion: (float)  aProportion

implementation

Set the knob's proportion

Parameters

aProportion

the desired proportion

Definition at line 262 of file CPScroller.j.

- (void) setObjectValue: (id)  anObject

implementation

Sets the receiver's object value.

Reimplemented from CPControl.

Definition at line 222 of file CPScroller.j.

- (void) setStyle: (id)  aStyle

implementation

Set the scroller's control size

Parameters

aStyle

the scroller style: CPScrollerStyleLegacy or CPScrollerStyleOverlay

Definition at line 201 of file CPScroller.j.

- (void) style

implementation

Returns the scroller's style

Definition at line 192 of file CPScroller.j.

- (CPScrollerPart) testPart: (CGPoint)  aPoint

implementation

Returns the part of the scroller that would be hit by aPoint.

Parameters

aPoint

the simulated point hit

Returns

the part of the scroller that intersects the point

Definition at line 316 of file CPScroller.j.

+ (id) themeAttributes

implementation

Reimplemented from CPControl.

Definition at line 103 of file CPScroller.j.

- (void) trackKnob: (CPEvent)  anEvent

implementation

Tracks the knob.

Parameters

anEvent

the input event

Definition at line 569 of file CPScroller.j.

- (void) trackScrollButtons: (CPEvent)  anEvent

implementation

Tracks the scroll button.

Parameters

anEvent

the input event

Definition at line 613 of file CPScroller.j.

- (CPUsableScrollerParts) usableParts

implementation

Returns all the parts of the scroller that are usable for displaying.

Definition at line 443 of file CPScroller.j.

---

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

• AppKit/CPScroller.h
• AppKit/CPScroller.j