CPScrollView Class Reference

#import <CPScrollView.h>

Inheritance diagram for CPScrollView:

Instance Methods
(BOOL)	- autohidesScrollers
(void)	- awakeFromCib
(CPBorderType)	- borderType
(CPView)	- bottomCornerView
(CGSize)	- contentSize
(CPClipView)	- contentView
(id)	- delegate
(id)	- documentView
(void)	- drawRect:
(void)	- encodeWithCoder:
(void)	- flashScrollers
(BOOL)	- hasHorizontalScroller
(BOOL)	- hasVerticalScroller
(float)	- horizontalLineScroll
(float)	- horizontalPageScroll
(CPScroller)	- horizontalScroller
(id)	- initWithCoder:
(id)	- initWithFrame:
(float)	- lineScroll
(void)	- moveByOffset:
(void)	- moveDown:
(void)	- moveLeft:
(void)	- moveRight:
(void)	- moveUp:
(float)	- pageScroll
(void)	- reflectScrolledClipView:
(void)	- resizeSubviewsWithOldSize:
(int)	- scrollerKnobStyle
(int)	- scrollerStyle
(void)	- scrollPageDown:
(void)	- scrollPageUp:
(void)	- scrollToBeginningOfDocument:
(void)	- scrollToEndOfDocument:
(void)	- scrollWheel:
(void)	- setAutohidesScrollers:
(void)	- setBorderType:
(void)	- setBottomCornerView:
(void)	- setContentView:
(void)	- setDelegate:
(void)	- setDocumentView:
(void)	- setHasHorizontalScroller:
(void)	- setHasVerticalScroller:
(void)	- setHorizontalLineScroll:
(void)	- setHorizontalPageScroll:
(void)	- setHorizontalScroller:
(void)	- setLineScroll:
(void)	- setPageScroll:
(void)	- setScrollerKnobStyle:
(void)	- setScrollerStyle:
(void)	- setVerticalLineScroll:
(void)	- setVerticalPageScroll:
(void)	- setVerticalScroller:
(void)	- tile
(float)	- verticalLineScroll
(float)	- verticalPageScroll
(CPScroller)	- verticalScroller
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:
(CPView)	- createEphemeralSubviewNamed:
(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:
(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
(CGRect)	- rectForEphemeralSubviewNamed:
(CPArray)	- registeredDraggedTypes
(void)	- registerForDraggedTypes:
(void)	- registerThemeValues:
(void)	- registerThemeValues:inherit:
(void)	- removeFromSuperview
(void)	- replaceSubview:with:
(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)	- setFrameSize:
(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)	- 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)	- 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
(CGSize)	+ contentSizeForFrameSize:hasHorizontalScroller:hasVerticalScroller:borderType:
(CPString)	+ defaultThemeClass
(CGSize)	+ frameSizeForContentSize:hasHorizontalScroller:hasVerticalScroller:borderType:
(int)	+ globalScrollerStyle
(void)	+ initialize
(void)	+ setGlobalScrollerStyle:
(CPDictionary)	+ themeAttributes
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

Used to display views that are too large for the viewing area. the CPScrollView places scroll bars on the side of the view to allow the user to scroll and see the entire contents of the view.

Definition at line 2 of file CPScrollView.h.

Method Documentation

- (BOOL) autohidesScrollers

implementation

Returns YES if the scroll view hides its scroll bars when not necessary.

Definition at line 590 of file CPScrollView.j.

- (void) awakeFromCib

implementation

Do final init that can only be done when we are sure all subviews have been initialized.

Reimplemented from CPObject.

Provided by category CPScrollView(CPCoding).

Definition at line 1522 of file CPScrollView.j.

- (CPBorderType) borderType

implementation

Returns the border type drawn around the view.

Definition at line 431 of file CPScrollView.j.

- (CPView) bottomCornerView

implementation

Definition at line 611 of file CPScrollView.j.

- (CGSize) contentSize

implementation

Returns the size of the scroll view's content view.

Definition at line 401 of file CPScrollView.j.

+ (CGSize) contentSizeForFrameSize: (CGSize)  frameSize hasHorizontalScroller: (BOOL)  hFlag hasVerticalScroller: (BOOL)  vFlag borderType: (CPBorderType)  borderType

implementation

Definition at line 147 of file CPScrollView.j.

- (CPClipView) contentView

implementation

Returns the content view that clips the document.

Definition at line 366 of file CPScrollView.j.

+ (CPString) defaultThemeClass

implementation

Reimplemented from CPView.

Definition at line 134 of file CPScrollView.j.

- (id) delegate

implementation

The delegate of the scroll view

Definition at line 269 of file CPScrollView.j.

- (id) documentView

implementation

Returns the view that is scrolled for the user.

Definition at line 409 of file CPScrollView.j.

- (void) drawRect: (CPRect)  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 1254 of file CPScrollView.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 CPScrollView(CPCoding).

Definition at line 1528 of file CPScrollView.j.

- (void) flashScrollers

implementation

Momentarily display the scrollers if the scroller style is CPScrollerStyleOverlay.

Definition at line 1221 of file CPScrollView.j.

+ (CGSize) frameSizeForContentSize: (CGSize)  contentSize hasHorizontalScroller: (BOOL)  hFlag hasVerticalScroller: (BOOL)  vFlag borderType: (CPBorderType)  borderType

implementation

Definition at line 161 of file CPScrollView.j.

+ (int) globalScrollerStyle

implementation

Get the system wide scroller style.

Definition at line 201 of file CPScrollView.j.

- (BOOL) hasHorizontalScroller

implementation

Returns YES if the scroll view can have a horizontal scroller.

Definition at line 493 of file CPScrollView.j.

- (BOOL) hasVerticalScroller

implementation

Returns YES if the scroll view can have a vertical scroller.

Definition at line 557 of file CPScrollView.j.

- (float) horizontalLineScroll

implementation

Returns how much the document moves horizontally when scrolled.

Definition at line 653 of file CPScrollView.j.

- (float) horizontalPageScroll

implementation

Returns the horizontal page scroll amount.

Definition at line 708 of file CPScrollView.j.

- (CPScroller) horizontalScroller

implementation

Returns the scroll view's horizontal scroller.

Definition at line 461 of file CPScrollView.j.

+ (void) initialize

implementation

Reimplemented from CPView.

Definition at line 121 of file CPScrollView.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 CPScrollView(CPCoding).

Definition at line 1472 of file CPScrollView.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 221 of file CPScrollView.j.

- (float) lineScroll

implementation

Returns how much the document moves when scrolled.

Definition at line 634 of file CPScrollView.j.

- (void) moveByOffset: (CGSize)  aSize

implementation

Definition at line 1438 of file CPScrollView.j.

- (void) moveDown: (id)  sender

implementation

Definition at line 1433 of file CPScrollView.j.

- (void) moveLeft: (id)  sender

implementation

Definition at line 1418 of file CPScrollView.j.

- (void) moveRight: (id)  sender

implementation

Definition at line 1423 of file CPScrollView.j.

- (void) moveUp: (id)  sender

implementation

Definition at line 1428 of file CPScrollView.j.

- (float) pageScroll

implementation

Returns the vertical and horizontal page scroll amount.

Definition at line 689 of file CPScrollView.j.

- (void) reflectScrolledClipView: (CPClipView)  aClipView

implementation

Resizes the scroll view to contain the specified clip view.

Parameters

aClipView

the clip view to resize to

Reimplemented from CPView.

Definition at line 1073 of file CPScrollView.j.

- (void) resizeSubviewsWithOldSize: (CGSize)  aSize

implementation

Initiates -superviewSizeChanged: messages to subviews.

Parameters

aSize

the size for the subviews

Reimplemented from CPView.

Definition at line 1245 of file CPScrollView.j.

- (int) scrollerKnobStyle

implementation

Returns the style of the scroller knob, the bit which moves when scrolling, of the receiver.

Valid values are:

    CPScrollerKnobStyleLight
    CPScrollerKnobStyleDark
    CPScrollerKnobStyleDefault

Definition at line 338 of file CPScrollView.j.

- (int) scrollerStyle

implementation

Definition at line 307 of file CPScrollView.j.

- (void) scrollPageDown: (id)  sender

implementation

Definition at line 1396 of file CPScrollView.j.

- (void) scrollPageUp: (id)  sender

implementation

Definition at line 1390 of file CPScrollView.j.

- (void) scrollToBeginningOfDocument: (id)  sender

implementation

Definition at line 1402 of file CPScrollView.j.

- (void) scrollToEndOfDocument: (id)  sender

implementation

Definition at line 1408 of file CPScrollView.j.

- (void) scrollWheel: (CPEvent)  anEvent

implementation

Handles a scroll wheel event from the user.

Parameters

anEvent

the scroll wheel event

Reimplemented from CPResponder.

Definition at line 1376 of file CPScrollView.j.

- (void) setAutohidesScrollers: (BOOL)  autohidesScrollers

implementation

Sets whether the scroll view hides its scroll bars when not needed.

Parameters

autohidesScrollers

YES causes the scroll bars to be hidden when not needed.

Definition at line 601 of file CPScrollView.j.

- (void) setBorderType: (CPBorderType)  borderType

implementation

Sets the type of border to be drawn around the view.

Valid types are:

CPNoBorder
CPLineBorder
CPBezelBorder
CPGrooveBorder

Definition at line 446 of file CPScrollView.j.

- (void) setBottomCornerView: (CPView)  aBottomCornerView

implementation

Definition at line 616 of file CPScrollView.j.

- (void) setContentView: (CPClipView)  aContentView

implementation

Sets the content view that clips the document.

Parameters

aContentView

the content view

Definition at line 376 of file CPScrollView.j.

- (void) setDelegate: (id)  aDelegate

implementation

Sets the delegate of the scroll view. Possible delegate methods to implement are listed below.

Notifies the delegate when the scroll view is about to scroll.

- (void)scrollViewWillScroll:(CPScrollView)aScrollView

Notifies the delegate when the scroll view has finished scrolling.

- (void)scrollViewDidScroll:(CPScrollView)aScrollView

Definition at line 289 of file CPScrollView.j.

- (void) setDocumentView: (CPView)  aView

implementation

Sets the view that is scrolled for the user.

Parameters

aView

the view that will be scrolled

Definition at line 419 of file CPScrollView.j.

+ (void) setGlobalScrollerStyle: (int)  aStyle

implementation

Set the system wide scroller style.

Parameters

aStyle

the scroller style to set all scroller views to use (CPScrollerStyleLegacy or CPScrollerStyleOverlay)

Definition at line 211 of file CPScrollView.j.

- (void) setHasHorizontalScroller: (BOOL)  shouldHaveHorizontalScroller

implementation

Specifies whether the scroll view can have a horizontal scroller.

Parameters

hasHorizontalScroller

YES lets the scroll view allocate a horizontal scroller if necessary.

Definition at line 504 of file CPScrollView.j.

- (void) setHasVerticalScroller: (BOOL)  shouldHaveVerticalScroller

implementation

Specifies whether the scroll view can have a vertical scroller. It allocates it if necessary.

Parameters

hasVerticalScroller

YES allows the scroll view to display a vertical scroller

Definition at line 569 of file CPScrollView.j.

- (void) setHorizontalLineScroll: (float)  aLineScroll

implementation

Sets how much the document moves when scrolled horizontally.

Parameters

aLineScroll

the amount to move horizontally when scrolled.

Definition at line 663 of file CPScrollView.j.

- (void) setHorizontalPageScroll: (float)  aPageScroll

implementation

Sets the horizontal page scroll amount.

Parameters

aPageScroll

the new horizontal page scroll amount

Definition at line 718 of file CPScrollView.j.

- (void) setHorizontalScroller: (CPScroller)  aScroller

implementation

Sets the scroll view's horizontal scroller.

Parameters

aScroller

the horizontal scroller for the scroll view

Definition at line 471 of file CPScrollView.j.

- (void) setLineScroll: (float)  aLineScroll

implementation

Sets how much the document moves when scrolled. Sets the vertical and horizontal scroll.

Parameters

aLineScroll

the amount to move the document when scrolled

Definition at line 644 of file CPScrollView.j.

- (void) setPageScroll: (float)  aPageScroll

implementation

Sets the horizontal and vertical page scroll amount.

Parameters

aPageScroll

the new horizontal and vertical page scroll amount

Definition at line 699 of file CPScrollView.j.

- (void) setScrollerKnobStyle: (int)  newScrollerKnobStyle

implementation

Sets the style of the scroller knob, the bit which moves when scrolling.

Valid values are:

    CPScrollerKnobStyleLight
    CPScrollerKnobStyleDark
    CPScrollerKnobStyleDefault

Definition at line 353 of file CPScrollView.j.

- (void) setScrollerStyle: (int)  aStyle

implementation

Set the scroller style.

• CPScrollerStyleLegacy: Standard scrollers like Windows or Mac OS X prior to 10.7
• CPScrollerStyleOverlay: scrollers like those in Mac OS X 10.7+

Definition at line 318 of file CPScrollView.j.

- (void) setVerticalLineScroll: (float)  aLineScroll

implementation

Sets how much the document moves when scrolled vertically.

Parameters

aLineScroll

the new amount to move vertically when scrolled.

Definition at line 681 of file CPScrollView.j.

- (void) setVerticalPageScroll: (float)  aPageScroll

implementation

Sets the vertical page scroll amount.

Parameters

aPageScroll

the new vertical page scroll amount

Definition at line 736 of file CPScrollView.j.

- (void) setVerticalScroller: (CPScroller)  aScroller

implementation

Sets the scroll view's vertical scroller.

Parameters

aScroller

the vertical scroller

Definition at line 535 of file CPScrollView.j.

+ (CPDictionary) themeAttributes

implementation

Reimplemented from CPView.

Definition at line 139 of file CPScrollView.j.

- (void) tile

implementation

Lays out the scroll view's components.

Definition at line 1060 of file CPScrollView.j.

- (float) verticalLineScroll

implementation

Returns how much the document moves vertically when scrolled.

Definition at line 671 of file CPScrollView.j.

- (float) verticalPageScroll

implementation

Returns the vertical page scroll amount.

Definition at line 726 of file CPScrollView.j.

- (CPScroller) verticalScroller

implementation

Returns the scroll view's vertical scroller.

Definition at line 525 of file CPScrollView.j.

---

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

• AppKit/CPScrollView.h
• AppKit/CPScrollView.j