API 0.9.5
CPScroller Class Reference

#import <CPScroller.h>

Inheritance diagram for CPScroller:

List of all members.

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

Class Methods

(CPString+ defaultThemeClass
(float) + scrollerOverlay
(float) + scrollerWidth
(float) + scrollerWidthForControlSize:
(float) + scrollerWidthInStyle:
(id) + themeAttributes

Detailed Description

Definition at line 2 of file CPScroller.h.


Method Documentation

- (BOOL) allowFadingOut

Synthesized accessor method.

Definition at line 859 of file CPScroller.j.

- (void) animationDidEnd: (CPAnimation animation

Definition at line 774 of file CPScroller.j.

- (void) checkSpaceForParts

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

Definition at line 345 of file CPScroller.j.

- (CPControlSize) controlSize

Returns the scroller's control size

Definition at line 228 of file CPScroller.j.

- (CPView) createEphemeralSubviewNamed: (CPString aName

Reimplemented from CPView.

Definition at line 509 of file CPScroller.j.

- (CPView) createViewForPart: (CPScrollerPart)  aPart

Definition at line 495 of file CPScroller.j.

- (id) currentValueForThemeAttribute: (CPString anAttributeName

Reimplemented from CPView.

Definition at line 710 of file CPScroller.j.

+ (CPString) defaultThemeClass

Reimplemented from CPView.

Definition at line 96 of file CPScroller.j.

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

Draws the specified arrow and sets the highlight.

Parameters:
anArrowthe arrow to draw
shouldHighlightsets whether the arrow should be highlighted

Definition at line 477 of file CPScroller.j.

- (void) drawKnob

Draws the knob

Definition at line 484 of file CPScroller.j.

- (void) drawKnobSlot

Draws the knob's slot

Definition at line 491 of file CPScroller.j.

- (void) drawParts

Caches images for the scroll arrow and knob.

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

Definition at line 820 of file CPScroller.j.

- (void) fadeIn

Display the scroller

Definition at line 446 of file CPScroller.j.

- (void) fadeOut

Start the fade out anination

Definition at line 460 of file CPScroller.j.

- (CPScrollerPart) hitPart

Returns the part of the scroller that was hit.

Definition at line 554 of file CPScroller.j.

- (id) initWithCoder: (CPCoder aCoder

Initializes the view from an archive.

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

Reimplemented from CPControl.

Definition at line 787 of file CPScroller.j.

- (id) initWithFrame: (CGRect)  aFrame

Initializes the receiver for usage with the specified bounding rectangle

Returns:
the initialized view

Reimplemented from CPControl.

Definition at line 156 of file CPScroller.j.

- (BOOL) isVertical

Synthesized accessor method.

Definition at line 851 of file CPScroller.j.

- (float) knobProportion

Return's the knob's proportion

Definition at line 251 of file CPScroller.j.

- (void) layoutSubviews

Reimplemented from CPView.

Definition at line 518 of file CPScroller.j.

- (void) mouseDown: (CPEvent anEvent

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

Parameters:
anEventcontains information about the click

Reimplemented from CPControl.

Definition at line 720 of file CPScroller.j.

- (void) mouseEntered: (CPEvent anEvent

Reimplemented from CPControl.

Definition at line 738 of file CPScroller.j.

- (void) mouseExited: (CPEvent anEvent

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

Parameters:
anEventcontains information about the exit

Reimplemented from CPControl.

Definition at line 755 of file CPScroller.j.

- (CGRect) rectForEphemeralSubviewNamed: (CPString aName

Reimplemented from CPView.

Definition at line 504 of file CPScroller.j.

- (CGRect) rectForPart: (CPScrollerPart)  aPart

Definition at line 298 of file CPScroller.j.

+ (float) scrollerOverlay

Returns the CPScroller's overlay value.

Definition at line 138 of file CPScroller.j.

+ (float) scrollerWidth

Definition at line 118 of file CPScroller.j.

+ (float) scrollerWidthForControlSize: (CPControlSize)  aControlSize

Returns the width of a CPScroller for the specified CPControlSize.

Parameters:
aControlSizethe size of a controller to return the width for

Definition at line 147 of file CPScroller.j.

+ (float) scrollerWidthInStyle: (int)  aStyle

Returns the CPScroller's width for a CPRegularControlSize.

Definition at line 126 of file CPScroller.j.

- (void) setControlSize: (CPControlSize)  aControlSize

Sets the scroller's size.

Parameters:
aControlSizethe scroller's size

Definition at line 237 of file CPScroller.j.

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

Sets the position and proportion of the knob.

Parameters:
aValuethe knob position (ranges from 0.0 to 1.0)
aProportionthe knob's proportion (ranges from 0.0 to 1.0)

Definition at line 838 of file CPScroller.j.

- (void) setFrameSize: (CGSize)  aSize

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:
aSizethe new size for the frame

Reimplemented from CPView.

Definition at line 698 of file CPScroller.j.

- (void) setKnobProportion: (float)  aProportion

Set the knob's proportion

Parameters:
aProportionthe desired proportion

Definition at line 260 of file CPScroller.j.

- (void) setObjectValue: (id)  anObject

Sets the receiver's object value.

Reimplemented from CPControl.

Definition at line 220 of file CPScroller.j.

- (void) setStyle: (id)  aStyle

Set the scroller's control size

Parameters:
aStylethe scroller style: CPScrollerStyleLegacy or CPScrollerStyleOverlay

Definition at line 199 of file CPScroller.j.

- (void) style

Returns the scroller's style

Definition at line 190 of file CPScroller.j.

- (CPScrollerPart) testPart: (CGPoint)  aPoint

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

Parameters:
aPointthe simulated point hit
Returns:
the part of the scroller that intersects the point

Definition at line 311 of file CPScroller.j.

+ (id) themeAttributes

Reimplemented from CPControl.

Definition at line 101 of file CPScroller.j.

- (void) trackKnob: (CPEvent anEvent

Tracks the knob.

Parameters:
anEventthe input event

Definition at line 563 of file CPScroller.j.

- (void) trackScrollButtons: (CPEvent anEvent

Tracks the scroll button.

Parameters:
anEventthe input event

Definition at line 607 of file CPScroller.j.

- (CPUsableScrollerParts) usableParts

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

Definition at line 438 of file CPScroller.j.


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