API 0.9.5
Instance Methods | Class Methods
CPScrollView Class Reference

#import <CPScrollView.h>

Inheritance diagram for CPScrollView:

List of all members.

Instance Methods

(BOOL) - autohidesScrollers 
(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 

Class Methods

(CGSize) + contentSizeForFrameSize:hasHorizontalScroller:hasVerticalScroller:borderType: 
(CPString) + defaultThemeClass 
(CGSize) + frameSizeForContentSize:hasHorizontalScroller:hasVerticalScroller:borderType: 
(int) + globalScrollerStyle 
(void) + initialize 
(int) + setGlobalScrollerStyle: 
(CPDictionary) + themeAttributes 

Detailed Description

Definition at line 2 of file CPScrollView.h.

Method Documentation

- (BOOL) autohidesScrollers  

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

Definition at line 573 of file CPScrollView.j.

- (CPBorderType) borderType  

Returns the border type drawn around the view.

Definition at line 414 of file CPScrollView.j.

- (CPView) bottomCornerView  

Definition at line 594 of file CPScrollView.j.

- (CGSize) contentSize  

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

Definition at line 384 of file CPScrollView.j.

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

Definition at line 142 of file CPScrollView.j.

- (CPClipView) contentView  

Returns the content view that clips the document.

Definition at line 349 of file CPScrollView.j.

+ (CPString) defaultThemeClass  

Reimplemented from CPView.

Definition at line 129 of file CPScrollView.j.

- (id) delegate  

The delegate of the scroll view

Definition at line 264 of file CPScrollView.j.

- (id) documentView  

Returns the view that is scrolled for the user.

Definition at line 392 of file CPScrollView.j.

- (void) drawRect: (CPRect)  aRect  

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

Parameters:
aRectthe area that should be drawn into

Reimplemented from CPView.

Definition at line 1212 of file CPScrollView.j.

- (void) encodeWithCoder: (CPCoder)  aCoder  

Archives the view to a coder.

Parameters:
aCoderthe object into which the view's data will be archived.

Reimplemented from CPView.

Definition at line 1483 of file CPScrollView.j.

- (void) flashScrollers  

Momentarily display the scrollers if the scroller style is CPScrollerStyleOverlay.

Definition at line 1180 of file CPScrollView.j.

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

Definition at line 156 of file CPScrollView.j.

+ (int) globalScrollerStyle  

Get the system wide scroller style.

Definition at line 196 of file CPScrollView.j.

- (BOOL) hasHorizontalScroller  

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

Definition at line 476 of file CPScrollView.j.

- (BOOL) hasVerticalScroller  

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

Definition at line 540 of file CPScrollView.j.

- (float) horizontalLineScroll  

Returns how much the document moves horizontally when scrolled.

Definition at line 636 of file CPScrollView.j.

- (float) horizontalPageScroll  

Returns the horizontal page scroll amount.

Definition at line 691 of file CPScrollView.j.

- (CPScroller) horizontalScroller  

Returns the scroll view's horizontal scroller.

Definition at line 444 of file CPScrollView.j.

+ (void) initialize  

Reimplemented from CPView.

Definition at line 119 of file CPScrollView.j.

- (id) initWithCoder: (CPCoder)  aCoder  

Initializes the view from an archive.

Parameters:
aCoderthe coder from which to initialize
Returns:
the initialized view

Reimplemented from CPView.

Definition at line 1433 of file CPScrollView.j.

- (id) initWithFrame: (CGRect)  aFrame  

Initializes the receiver for usage with the specified bounding rectangle

Returns:
the initialized view

Reimplemented from CPView.

Definition at line 216 of file CPScrollView.j.

- (float) lineScroll  

Returns how much the document moves when scrolled.

Definition at line 617 of file CPScrollView.j.

- (void) moveByOffset: (CGSize)  aSize  

Definition at line 1399 of file CPScrollView.j.

- (void) moveDown: (id)  sender  

Definition at line 1394 of file CPScrollView.j.

- (void) moveLeft: (id)  sender  

Definition at line 1379 of file CPScrollView.j.

- (void) moveRight: (id)  sender  

Definition at line 1384 of file CPScrollView.j.

- (void) moveUp: (id)  sender  

Definition at line 1389 of file CPScrollView.j.

- (float) pageScroll  

Returns the vertical and horizontal page scroll amount.

Definition at line 672 of file CPScrollView.j.

- (void) reflectScrolledClipView: (CPClipView)  aClipView  

Resizes the scroll view to contain the specified clip view.

Parameters:
aClipViewthe clip view to resize to

Reimplemented from CPView.

Definition at line 1041 of file CPScrollView.j.

- (void) resizeSubviewsWithOldSize: (CGSize)  aSize  

Initiates -superviewSizeChanged: messages to subviews.

Parameters:
aSizethe size for the subviews

Reimplemented from CPView.

Definition at line 1203 of file CPScrollView.j.

- (int) scrollerKnobStyle  

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

- (int) scrollerStyle  

Definition at line 290 of file CPScrollView.j.

- (void) scrollPageDown: (id)  sender  

Definition at line 1357 of file CPScrollView.j.

- (void) scrollPageUp: (id)  sender  

Definition at line 1351 of file CPScrollView.j.

- (void) scrollToBeginningOfDocument: (id)  sender  

Definition at line 1363 of file CPScrollView.j.

- (void) scrollToEndOfDocument: (id)  sender  

Definition at line 1369 of file CPScrollView.j.

- (void) scrollWheel: (CPEvent)  anEvent  

Handles a scroll wheel event from the user.

Parameters:
anEventthe scroll wheel event

Reimplemented from CPResponder.

Definition at line 1337 of file CPScrollView.j.

- (void) setAutohidesScrollers: (BOOL)  autohidesScrollers  

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

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

Definition at line 584 of file CPScrollView.j.

- (void) setBorderType: (CPBorderType)  borderType  

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

Valid types are: 

    CPNoBorder
    CPLineBorder
    CPBezelBorder
    CPGrooveBorder

Definition at line 429 of file CPScrollView.j.

- (void) setBottomCornerView: (CPView)  aBottomCornerView  

Definition at line 599 of file CPScrollView.j.

- (void) setContentView: (CPClipView)  aContentView  

Sets the content view that clips the document.

Parameters:
aContentViewthe content view

Definition at line 359 of file CPScrollView.j.

- (void) setDelegate: (id)  aDelegate  

Set the delegate of the scroll view

Definition at line 272 of file CPScrollView.j.

- (void) setDocumentView: (CPView)  aView  

Sets the view that is scrolled for the user.

Parameters:
aViewthe view that will be scrolled

Definition at line 402 of file CPScrollView.j.

+ (int) setGlobalScrollerStyle: (int)  aStyle  

Set the system wide scroller style.

Parameters:
aStylethe scroller style to set all scroller views to use (CPScrollerStyleLegacy or CPScrollerStyleOverlay)

Definition at line 206 of file CPScrollView.j.

- (void) setHasHorizontalScroller: (BOOL)  shouldHaveHorizontalScroller  

Specifies whether the scroll view can have a horizontal scroller.

Parameters:
hasHorizontalScrollerYES lets the scroll view allocate a horizontal scroller if necessary.

Definition at line 487 of file CPScrollView.j.

- (void) setHasVerticalScroller: (BOOL)  shouldHaveVerticalScroller  

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

Parameters:
hasVerticalScrollerYES allows the scroll view to display a vertical scroller

Definition at line 552 of file CPScrollView.j.

- (void) setHorizontalLineScroll: (float)  aLineScroll  

Sets how much the document moves when scrolled horizontally.

Parameters:
aLineScrollthe amount to move horizontally when scrolled.

Definition at line 646 of file CPScrollView.j.

- (void) setHorizontalPageScroll: (float)  aPageScroll  

Sets the horizontal page scroll amount.

Parameters:
aPageScrollthe new horizontal page scroll amount

Definition at line 701 of file CPScrollView.j.

- (void) setHorizontalScroller: (CPScroller)  aScroller  

Sets the scroll view's horizontal scroller.

Parameters:
aScrollerthe horizontal scroller for the scroll view

Definition at line 454 of file CPScrollView.j.

- (void) setLineScroll: (float)  aLineScroll  

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

Parameters:
aLineScrollthe amount to move the document when scrolled

Definition at line 627 of file CPScrollView.j.

- (void) setPageScroll: (float)  aPageScroll  

Sets the horizontal and vertical page scroll amount.

Parameters:
aPageScrollthe new horizontal and vertical page scroll amount

Definition at line 682 of file CPScrollView.j.

- (void) setScrollerKnobStyle: (int)  newScrollerKnobStyle  

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

Valid values are: 

        CPScrollerKnobStyleLight
        CPScrollerKnobStyleDark
        CPScrollerKnobStyleDefault

Definition at line 336 of file CPScrollView.j.

- (void) setScrollerStyle: (int)  aStyle  

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

- (void) setVerticalLineScroll: (float)  aLineScroll  

Sets how much the document moves when scrolled vertically.

Parameters:
aLineScrollthe new amount to move vertically when scrolled.

Definition at line 664 of file CPScrollView.j.

- (void) setVerticalPageScroll: (float)  aPageScroll  

Sets the vertical page scroll amount.

Parameters:
aPageScrollthe new vertical page scroll amount

Definition at line 719 of file CPScrollView.j.

- (void) setVerticalScroller: (CPScroller)  aScroller  

Sets the scroll view's vertical scroller.

Parameters:
aScrollerthe vertical scroller

Definition at line 518 of file CPScrollView.j.

+ (CPDictionary) themeAttributes  

Reimplemented from CPView.

Definition at line 134 of file CPScrollView.j.

- (void) tile  

Lays out the scroll view's components.

Definition at line 1028 of file CPScrollView.j.

- (float) verticalLineScroll  

Returns how much the document moves vertically when scrolled.

Definition at line 654 of file CPScrollView.j.

- (float) verticalPageScroll  

Returns the vertical page scroll amount.

Definition at line 709 of file CPScrollView.j.

- (CPScroller) verticalScroller  

Returns the scroll view's vertical scroller.

Definition at line 508 of file CPScrollView.j.

The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines