CPScrollView Class Reference

List of all members.

Public Member Functions

(id) - initWithFrame: [implementation]
(CGRect) - contentSize [implementation]
(id) - documentView [implementation]
(void) - setContentView: [implementation]
(CPClipView- contentView [implementation]
(void) - setDocumentView: [implementation]
(void) - reflectScrolledClipView: [implementation]
(void) - setHorizontalScroller: [implementation]
(CPScroller- horizontalScroller [implementation]
(void) - setHasHorizontalScroller: [implementation]
(BOOL) - hasHorizontalScroller [implementation]
(void) - setVerticalScroller: [implementation]
(CPScroller- verticalScroller [implementation]
(void) - setHasVerticalScroller: [implementation]
(void) - setAutohidesScrollers: [implementation]
(BOOL) - autohidesScrollers [implementation]
(void) - tile [implementation]
(void) - resizeSubviewsWithOldSize: [implementation]
(void) - setLineScroll: [implementation]
(float) - lineScroll [implementation]
(void) - setHorizontalLineScroll: [implementation]
(float) - horizontalLineScroll [implementation]
(void) - setVerticalLineScroll: [implementation]
(float) - verticalLineScroll [implementation]
(void) - setPageScroll: [implementation]
(float) - pageScroll [implementation]
(void) - setHorizontalPageScroll: [implementation]
(float) - horizontalPageScroll [implementation]
(void) - setVerticalPageScroll: [implementation]
(float) - verticalPageScroll [implementation]
(void) - scrollWheel: [implementation]
(void) - keyDown: [implementation]


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 36 of file CPScrollView.j.


Member Function Documentation

- (BOOL) autohidesScrollers   [implementation]

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

Definition at line 379 of file CPScrollView.j.

- (CGRect) contentSize   [implementation]

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

Definition at line 82 of file CPScrollView.j.

- (CPClipView) contentView   [implementation]

Returns the content view that clips the document.

Definition at line 124 of file CPScrollView.j.

- (id) documentView   [implementation]

Returns the view that is scrolled for the user.

Definition at line 90 of file CPScrollView.j.

- (BOOL) hasHorizontalScroller   [implementation]

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

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

Definition at line 292 of file CPScrollView.j.

- (float) horizontalLineScroll   [implementation]

Returns how much the document moves horizontally when scrolled.

Definition at line 499 of file CPScrollView.j.

- (float) horizontalPageScroll   [implementation]

Returns the horizontal page scroll amount.

Definition at line 551 of file CPScrollView.j.

- (CPScroller) horizontalScroller   [implementation]

Returns the scroll view's horizontal scroller

Definition at line 261 of file CPScrollView.j.

- (id) initWithFrame: (CGRect)  aFrame   [implementation]

Definition at line 55 of file CPScrollView.j.

- (void) keyDown: (CPEvent anEvent   [implementation]

Definition at line 589 of file CPScrollView.j.

- (float) lineScroll   [implementation]

Returns how much the document moves when scrolled

Definition at line 482 of file CPScrollView.j.

- (float) pageScroll   [implementation]

Returns the vertical and horizontal page scroll amount.

Definition at line 534 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

Definition at line 143 of file CPScrollView.j.

- (void) resizeSubviewsWithOldSize: (CGSize)  aSize   [implementation]

Definition at line 463 of file CPScrollView.j.

- (void) scrollWheel: (CPEvent anEvent   [implementation]

Handles a scroll wheel event from the user.

Parameters:
anEvent the scroll wheel event

Definition at line 577 of file CPScrollView.j.

- (void) setAutohidesScrollers: (BOOL)  autohidesScrollers   [implementation]

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

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

Definition at line 365 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 99 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 133 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 271 of file CPScrollView.j.

- (void) setHasVerticalScroller: (BOOL)  shouldHaveVerticalScroller   [implementation]

Specifies whether the scroll view has 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 334 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 491 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 543 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 239 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 473 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 525 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 508 of file CPScrollView.j.

- (void) setVerticalPageScroll: (float)  aPageScroll   [implementation]

Sets the vertical page scroll amount.

Parameters:
aPageScroll the new vertcal page scroll amount

Definition at line 560 of file CPScrollView.j.

- (void) setVerticalScroller: (CPScroller aScroller   [implementation]

Sets the scroll view's vertical scroller.

Parameters:
aScroller the vertical scroller

Definition at line 301 of file CPScrollView.j.

- (void) tile   [implementation]

Lays out the scroll view's components.

Definition at line 452 of file CPScrollView.j.

- (float) verticalLineScroll   [implementation]

Returns how much the document moves vertically when scrolled.

Definition at line 516 of file CPScrollView.j.

- (float) verticalPageScroll   [implementation]

Returns the vertical page scroll amount.

Definition at line 568 of file CPScrollView.j.

- (CPScroller) verticalScroller   [implementation]

Return's the scroll view's vertical scroller

Definition at line 323 of file CPScrollView.j.


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

Generated on Thu Dec 11 01:55:51 2008 for Cappuccino by  doxygen 1.5.7.1