CPScroller Class Reference

#import <CPScroller.h>

Inheritance diagram for CPScroller:

Instance Methods
(BOOL)	- allowFadingOut
(void)	- animationDidEnd:
(void)	- checkSpaceForParts
(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)	- 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
(BOOL)	- acceptsFirstMouse:
(SEL)	- action
(CPTextAlignment)	- alignment
(CPWritingDirection)	- baseWritingDirection
(BOOL)	- continueTracking:at:
(CPControlSize)	- controlSize
(double)	- doubleValue
(float)	- floatValue
(CPFont)	- font
(CPFormatter)	- formatter
(void)	- highlight:
(CPCellImagePosition)	- imagePosition
(CPUInteger)	- imageScaling
(int)	- integerValue
(int)	- intValue
(BOOL)	- isContinuous
(BOOL)	- isEnabled
(BOOL)	- isHighlighted
(CPLineBreakMode)	- lineBreakMode
(unsigned)	- mouseDownFlags
(CPInteger)	- nextState
(id)	- objectValue
(void)	- performClick:
(BOOL)	- sendAction:to:
(int)	- sendActionOn:
(BOOL)	- sendsActionOnEndEditing
(void)	- setAction:
(void)	- setAlignment:
(void)	- setBaseWritingDirection:
(void)	- setContinuous:
(void)	- setControlSize:
(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:
(void)	- updateTrackingAreas
(CPTextVerticalAlignment)	- verticalAlignment
Instance Methods inherited from CPView
(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:
(void)	- drawRect:
(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:
(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)	- 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
(float)	+ scrollerOverlay
(float)	+ scrollerWidth
(float)	+ scrollerWidthForControlSize:
(float)	+ scrollerWidthInStyle:
(CPDictionary)	+ themeAttributes
Class Methods inherited from CPControl
(void)	+ initialize
Class Methods inherited from CPView
(Class)	+ animatorClass
(CAAnimation)	+ defaultAnimationForKey:
(CPMenu)	+ defaultMenu
(BOOL)	+ isHighDPIDrawingEnabled
(CPSet)	+ keyPathsForValuesAffectingBounds
(CPSet)	+ keyPathsForValuesAffectingFrame
(void)	+ setHighDPIDrawingEnabled:

Detailed Description

Definition at line 2 of file CPScroller.h.

Method Documentation

allowFadingOut()

- (BOOL) allowFadingOut

implementation

Synthesized accessor method.

Provided by category CPScroller(CPSynthesizedAccessors).

Definition at line 866 of file CPScroller.j.

animationDidEnd:()

- (void) animationDidEnd: (CPAnimation)  animation

implementation

Definition at line 780 of file CPScroller.j.

checkSpaceForParts()

- (void) checkSpaceForParts

implementation

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

Definition at line 342 of file CPScroller.j.

createEphemeralSubviewNamed:()

- (CPView) createEphemeralSubviewNamed: (CPString)  aName

implementation

Reimplemented from CPView.

Definition at line 505 of file CPScroller.j.

createViewForPart:()

- (CPView) createViewForPart: (CPScrollerPart)  aPart

implementation

Definition at line 491 of file CPScroller.j.

currentValueForThemeAttribute:()

- (id) currentValueForThemeAttribute: (CPString)  anAttributeName

implementation

Definition at line 703 of file CPScroller.j.

defaultThemeClass()

+ (CPString) defaultThemeClass

implementation

Reimplemented from CPView.

Definition at line 102 of file CPScroller.j.

drawArrow:highlight:()

- (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 473 of file CPScroller.j.

drawKnob()

- (void) drawKnob

implementation

Draws the knob

Definition at line 480 of file CPScroller.j.

drawKnobSlot()

- (void) drawKnobSlot

implementation

Draws the knob's slot

Definition at line 487 of file CPScroller.j.

drawParts()

- (void) drawParts

implementation

Caches images for the scroll arrow and knob.

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

Provided by category CPScroller(CPCoding).

Definition at line 827 of file CPScroller.j.

fadeIn()

- (void) fadeIn

implementation

Display the scroller

Definition at line 445 of file CPScroller.j.

fadeOut()

- (void) fadeOut

implementation

Start the fade out anination

Definition at line 459 of file CPScroller.j.

hitPart()

- (CPScrollerPart) hitPart

implementation

Returns the part of the scroller that was hit.

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

Provided by category CPScroller(CPCoding).

Definition at line 793 of file CPScroller.j.

initWithFrame:()

- (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 167 of file CPScroller.j.

isVertical()

- (BOOL) isVertical

implementation

Synthesized accessor method.

Provided by category CPScroller(CPSynthesizedAccessors).

Definition at line 858 of file CPScroller.j.

knobProportion()

- (float) knobProportion

implementation

Return's the knob's proportion

Definition at line 245 of file CPScroller.j.

layoutSubviews()

- (void) layoutSubviews

implementation

Reimplemented from CPView.

Definition at line 514 of file CPScroller.j.

mouseDown:()

- (void) mouseDown: (CPEvent)  anEvent

implementation

Reimplemented from CPControl.

Definition at line 713 of file CPScroller.j.

mouseEntered:()

- (void) mouseEntered: (CPEvent)  anEvent

implementation

Reimplemented from CPControl.

Definition at line 733 of file CPScroller.j.

mouseExited:()

- (void) mouseExited: (CPEvent)  anEvent

implementation

Reimplemented from CPControl.

Definition at line 750 of file CPScroller.j.

rectForEphemeralSubviewNamed:()

- (CGRect) rectForEphemeralSubviewNamed: (CPString)  aName

implementation

Reimplemented from CPView.

Definition at line 500 of file CPScroller.j.

rectForPart:()

- (CGRect) rectForPart: (CPScrollerPart)  aPart

implementation

Definition at line 295 of file CPScroller.j.

scrollerOverlay()

+ (float) scrollerOverlay

implementation

Returns the CPScroller's overlay value.

Definition at line 146 of file CPScroller.j.

scrollerWidth()

+ (float) scrollerWidth

implementation

Definition at line 124 of file CPScroller.j.

scrollerWidthForControlSize:()

+ (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 158 of file CPScroller.j.

scrollerWidthInStyle:()

+ (float) scrollerWidthInStyle: (int)  aStyle

implementation

Returns the CPScroller's width for a CPRegularControlSize.

Definition at line 132 of file CPScroller.j.

setFloatValue:knobProportion:()

- (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 845 of file CPScroller.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 691 of file CPScroller.j.

setKnobProportion:()

- (void) setKnobProportion: (float)  aProportion

implementation

Set the knob's proportion

Parameters

aProportion

the desired proportion

Definition at line 254 of file CPScroller.j.

setObjectValue:()

- (void) setObjectValue: (id)  anObject

implementation

Sets the receiver's object value.

Reimplemented from CPControl.

Definition at line 237 of file CPScroller.j.

setStyle:()

- (void) setStyle: (id)  aStyle

implementation

Set the scroller's control size

Parameters

aStyle

the scroller style: CPScrollerStyleLegacy or CPScrollerStyleOverlay

Definition at line 215 of file CPScroller.j.

style()

- (void) style

implementation

Returns the scroller's style

Definition at line 206 of file CPScroller.j.

testPart:()

- (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 308 of file CPScroller.j.

themeAttributes()

+ (CPDictionary) themeAttributes

implementation

Reimplemented from CPControl.

Definition at line 107 of file CPScroller.j.

trackKnob:()

- (void) trackKnob: (CPEvent)  anEvent

implementation

Tracks the knob.

Parameters

anEvent

the input event

Definition at line 561 of file CPScroller.j.

trackScrollButtons:()

- (void) trackScrollButtons: (CPEvent)  anEvent

implementation

Tracks the scroll button.

Parameters

anEvent

the input event

Definition at line 605 of file CPScroller.j.

usableParts()

- (CPUsableScrollerParts) usableParts

implementation

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

Definition at line 437 of file CPScroller.j.

---

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

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