NSStepper Class Reference

Inherits from
NSControl : NSView : NSResponder : NSObject
Conforms to
NSAnimatablePropertyContainer (NSView)
NSUserInterfaceItemIdentification (NSView)
NSDraggingDestination (NSView)
NSCoding (NSResponder)
NSObject (NSObject)
Framework
/System/Library/Frameworks/AppKit.framework
Availability
Available in OS X v10.0 and later.
Companion guide
Stepper Programming Topics
Declared in
NSStepper.h
Related sample code

Overview

A stepper consists of two small arrows that can increment and decrement a value that appears beside it, such as a date or time. The illustration below shows a stepper to the right of a text field, which would show the stepper’s value.

image: Art/stepper.gif

The NSStepper class uses the NSStepperCell class to implement its user interface.

Tasks

Specifying Value Range

Specifying How the Stepper Responds

Instance Methods

autorepeat

Returns a Boolean value indicating how the receiver responds to mouse events.

- (BOOL)autorepeat
Return Value

YES if the first mouse down does one increment (or decrement) and, after a delay of 0.5 seconds, increments (or decrements) at a rate of ten times per second. NO if the receiver does one increment (decrement) on a mouse up. The default is YES.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

increment

Returns the amount by which the receiver will change per increment (decrement).

- (double)increment
Return Value

The amount by which the receiver changes with each increment or decrement. The default is 1.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

maxValue

Returns the maximum value for the receiver.

- (double)maxValue
Return Value

The maximum value. The default is 59.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

minValue

Returns the minimum value for the receiver.

- (double)minValue
Return Value

The minimum value. The default is 0.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

setAutorepeat:

Sets how the receiver responds to mouse events.

- (void)setAutorepeat:(BOOL)autorepeat
Parameters
autorepeat

If YES, the first mouse down does one increment (decrement) and, after a delay of 0.5 seconds, increments (decrements) at a rate of ten times per second. If autorepeat is NO, the receiver does one increment (decrement) on a mouse up.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

setIncrement:

Sets the amount by which the receiver will change per increment (decrement).

- (void)setIncrement:(double)increment
Parameters
increment

The amount by which the receiver changes with each decrement or increment.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

setMaxValue:

Sets the maximum value for the receiver

- (void)setMaxValue:(double)maxValue
Parameters
maxValue

The new maximum value.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

setMinValue:

Sets the minimum value for the receiver

- (void)setMinValue:(double)minValue
Parameters
minValue

The new minimum value.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

setValueWraps:

Sets whether the receiver wraps around the minimum and maximum values.

- (void)setValueWraps:(BOOL)valueWraps
Parameters
valueWraps

If YES, then when incrementing or decrementing, the value wraps around to the minimum or maximum. If valueWraps is NO, the value stays pinned at the minimum or maximum.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h

valueWraps

Returns a Boolean value indicating whether the receiver wraps around the minimum and maximum values.

- (BOOL)valueWraps
Return Value

YES if, when incrementing or decrementing, the value wraps around to the minimum or maximum. NO if the value stays pinned at the minimum or maximum. The default is YES.

Availability
  • Available in OS X v10.0 and later.
See Also
Declared In
NSStepper.h


© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)

Did this document help you? Yes It's good, but... Not helpful...