API  0.9.7
 All Classes Files Functions Variables Macros Groups Pages
CPScroller Class Reference

#import <CPScroller.h>

+ Inheritance diagram for CPScroller:

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
 
- Instance Methods inherited from CPControl
(BOOL) - acceptsFirstMouse:
 
(SEL) - action
 
(CPTextAlignment) - alignment
 
(BOOL) - continueTracking:at:
 
(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) - setContinuous:
 
(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:
 
(CPTextVerticalAlignment) - verticalAlignment
 

Class Methods

(CPString+ defaultThemeClass
 
(float) + scrollerOverlay
 
(float) + scrollerWidth
 
(float) + scrollerWidthForControlSize:
 
(float) + scrollerWidthInStyle:
 
(CPDictionary+ themeAttributes
 
- Class Methods inherited from CPControl
(void) + initialize
 

Detailed Description

Definition at line 2 of file CPScroller.h.

Method Documentation

- (BOOL) allowFadingOut
implementation

Synthesized accessor method.

Provided by category CPScroller(CPSynthesizedAccessors).

Definition at line 886 of file CPScroller.j.

- (void) animationDidEnd: (CPAnimation animation
implementation

Definition at line 794 of file CPScroller.j.

- (void) checkSpaceForParts
implementation

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

Definition at line 365 of file CPScroller.j.

- (CPControlSize) controlSize
implementation

Returns the scroller's control size

Definition at line 245 of file CPScroller.j.

- (CPView) createEphemeralSubviewNamed: (CPString aName
implementation

Definition at line 529 of file CPScroller.j.

- (CPView) createViewForPart: (CPScrollerPart)  aPart
implementation

Definition at line 515 of file CPScroller.j.

- (id) currentValueForThemeAttribute: (CPString anAttributeName
implementation

Definition at line 727 of file CPScroller.j.

+ (CPString) defaultThemeClass
implementation

Definition at line 102 of file CPScroller.j.

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

Draws the specified arrow and sets the highlight.

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

Definition at line 497 of file CPScroller.j.

- (void) drawKnob
implementation

Draws the knob

Definition at line 504 of file CPScroller.j.

- (void) drawKnobSlot
implementation

Draws the knob's slot

Definition at line 511 of file CPScroller.j.

- (void) drawParts
implementation

Caches images for the scroll arrow and knob.

Definition at line 564 of file CPScroller.j.

- (void) encodeWithCoder: (CPCoder aCoder
implementation

Reimplemented from CPControl.

Provided by category CPScroller(CPCoding).

Definition at line 846 of file CPScroller.j.

- (void) fadeIn
implementation

Display the scroller

Definition at line 466 of file CPScroller.j.

- (void) fadeOut
implementation

Start the fade out anination

Definition at line 480 of file CPScroller.j.

- (CPScrollerPart) hitPart
implementation

Returns the part of the scroller that was hit.

Definition at line 576 of file CPScroller.j.

- (id) initWithCoder: (CPCoder aCoder
implementation

Reimplemented from CPControl.

Provided by category CPScroller(CPCoding).

Definition at line 808 of file CPScroller.j.

- (id) initWithFrame: (CGRect)  aFrame
implementation

Reimplemented from CPControl.

Definition at line 167 of file CPScroller.j.

- (BOOL) isVertical
implementation

Synthesized accessor method.

Provided by category CPScroller(CPSynthesizedAccessors).

Definition at line 878 of file CPScroller.j.

- (float) knobProportion
implementation

Return's the knob's proportion

Definition at line 268 of file CPScroller.j.

- (void) layoutSubviews
implementation

Definition at line 538 of file CPScroller.j.

- (void) mouseDown: (CPEvent anEvent
implementation

Reimplemented from CPControl.

Definition at line 737 of file CPScroller.j.

- (void) mouseEntered: (CPEvent anEvent
implementation

Reimplemented from CPControl.

Definition at line 757 of file CPScroller.j.

- (void) mouseExited: (CPEvent anEvent
implementation

Reimplemented from CPControl.

Definition at line 774 of file CPScroller.j.

- (CGRect) rectForEphemeralSubviewNamed: (CPString aName
implementation

Definition at line 524 of file CPScroller.j.

- (CGRect) rectForPart: (CPScrollerPart)  aPart
implementation

Definition at line 318 of file CPScroller.j.

+ (float) scrollerOverlay
implementation

Returns the CPScroller's overlay value.

Definition at line 146 of file CPScroller.j.

+ (float) scrollerWidth
implementation

Definition at line 124 of file CPScroller.j.

+ (float) scrollerWidthForControlSize: (CPControlSize)  aControlSize
implementation

Returns the width of a CPScroller for the specified CPControlSize.

Parameters
aControlSizethe size of a controller to return the width for

Definition at line 158 of file CPScroller.j.

+ (float) scrollerWidthInStyle: (int)  aStyle
implementation

Returns the CPScroller's width for a CPRegularControlSize.

Definition at line 132 of file CPScroller.j.

- (void) setControlSize: (CPControlSize)  aControlSize
implementation

Sets the scroller's size.

Parameters
aControlSizethe scroller's size

Definition at line 254 of file CPScroller.j.

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

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)

Provided by category CPScroller(Deprecated).

Definition at line 865 of file CPScroller.j.

- (void) setFrameSize: (CGSize)  aSize
implementation

Definition at line 715 of file CPScroller.j.

- (void) setKnobProportion: (float)  aProportion
implementation

Set the knob's proportion

Parameters
aProportionthe desired proportion

Definition at line 277 of file CPScroller.j.

- (void) setObjectValue: (id)  anObject
implementation

Sets the receiver's object value.

Reimplemented from CPControl.

Definition at line 237 of file CPScroller.j.

- (void) setStyle: (id)  aStyle
implementation

Set the scroller's control size

Parameters
aStylethe scroller style: CPScrollerStyleLegacy or CPScrollerStyleOverlay

Definition at line 216 of file CPScroller.j.

- (void) style
implementation

Returns the scroller's style

Definition at line 207 of file CPScroller.j.

- (CPScrollerPart) testPart: (CGPoint)  aPoint
implementation

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

+ (CPDictionary) themeAttributes
implementation

Reimplemented from CPControl.

Definition at line 107 of file CPScroller.j.

- (void) trackKnob: (CPEvent anEvent
implementation

Tracks the knob.

Parameters
anEventthe input event

Definition at line 585 of file CPScroller.j.

- (void) trackScrollButtons: (CPEvent anEvent
implementation

Tracks the scroll button.

Parameters
anEventthe input event

Definition at line 629 of file CPScroller.j.

- (CPUsableScrollerParts) usableParts
implementation

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

Definition at line 458 of file CPScroller.j.


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