iOS Developer Library

Developer

UIKit Framework Reference UIStepper Class Reference

Options
Deployment Target:

On This Page
Language:

UIStepper

Import Statement


Swift

import UIKit

Objective-C

@import UIKit;

Availability


Available in iOS 5.0 and later.

A stepper control provides a user interface for incrementing or decrementing a value. A stepper displays two buttons, one with a minus (“–”) symbol and one with a plus (“+”) symbol.

If you set stepper behavior to “autorepeat” (which is the default), pressing and holding one of its buttons increments or decrements the stepper’s value repeatedly. The rate of change depends on how long the user continues pressing the control.

The maximum value must be greater than or equal to the minimum value. If you set a maximum or minimum value that would make break this invariant, both values are set to the new value. For example, if the minimum value is 200 and you set a maximum value of 100, then both the minimum and maximum become 200.

For information about basic view behaviors, see View Programming Guide for iOS.

For more information about appearance and behavior configuration, see Steppers.

  • The continuous vs. noncontinuous state of the stepper.

    Declaration

    Swift

    var continuous: Bool

    Objective-C

    @property(nonatomic, getter=isContinuous) BOOL continuous

    Discussion

    If YEStrue, value change events are sent immediately when the value changes during user interaction. If NOfalse, a value change event is sent when user interaction ends.

    The default value for this property is YEStrue.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 5.0 and later.

  • The automatic vs. nonautomatic repeat state of the stepper.

    Declaration

    Swift

    var autorepeat: Bool

    Objective-C

    @property(nonatomic) BOOL autorepeat

    Discussion

    If YEStrue, the user pressing and holding on the stepper repeatedly alters value.

    The default value for this property is YEStrue.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 5.0 and later.

  • wraps wraps Property

    The wrap vs. no-wrap state of the stepper.

    Declaration

    Swift

    var wraps: Bool

    Objective-C

    @property(nonatomic) BOOL wraps

    Discussion

    If YEStrue, incrementing beyond maximumValue sets value to minimumValue; likewise, decrementing below minimumValue sets value to maximumValue. If NOfalse, the stepper does not increment beyond maximumValue nor does it decrement below minimumValue but rather holds at those values.

    The default value for this property is NOfalse.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 5.0 and later.

  • The lowest possible numeric value for the stepper.

    Declaration

    Swift

    var minimumValue: Double

    Objective-C

    @property(nonatomic) double minimumValue

    Discussion

    Must be numerically less than maximumValue. If you attempt to set a value equal to or greater than maximumValue, the system raises an NSInvalidArgumentException exception.

    The default value for this property is 0.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 5.0 and later.

  • The highest possible numeric value for the stepper.

    Declaration

    Swift

    var maximumValue: Double

    Objective-C

    @property(nonatomic) double maximumValue

    Discussion

    Must be numerically greater than minimumValue. If you attempt to set a value equal to or lower than minimumValue, the system raises an NSInvalidArgumentException exception.

    The default value of this property is 100.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 5.0 and later.

  • stepValue stepValue Property

    The step, or increment, value for the stepper.

    Declaration

    Swift

    var stepValue: Double

    Objective-C

    @property(nonatomic) double stepValue

    Discussion

    Must be numerically greater than 0. If you attempt to set this property’s value to 0 or to a negative number, the system raises an NSInvalidArgumentException exception.

    The default value for this property is 1.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 5.0 and later.

  • value value Property

    The numeric value of the stepper.

    Declaration

    Swift

    var value: Double

    Objective-C

    @property(nonatomic) double value

    Discussion

    When the value changes, the stepper sends the UIControlEventValueChanged flag to its target (see addTarget:action:forControlEvents:). Refer to the description of the continuous property for information about whether value change events are sent continuously or when user interaction ends.

    The default value for this property is 0. This property is clamped at its lower extreme to minimumValue and is clamped at its upper extreme to maximumValue.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 5.0 and later.

  • tintColor tintColor Property

    The tint color to apply to key elements in the stepper.

    Declaration

    Swift

    var tintColor: UIColor!

    Objective-C

    @property(nonatomic, retain) UIColor *tintColor

    Discussion

    In iOS v7.0, all subclasses of UIView derive their behavior for tintColor from the base class. See the discussion of tintColor at the UIView level for more information.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Returns the background image associated with the specified control state.

    Declaration

    Swift

    func backgroundImageForState(_ state: UIControlState) -> UIImage

    Objective-C

    - (UIImage *)backgroundImageForState:(UIControlState)state

    Parameters

    state

    The control state in which the image is displayed.

    Return Value

    The background image used by the control when it is in the specified state.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Sets the background image for the control when it is in the specified state.

    Declaration

    Swift

    func setBackgroundImage(_ image: UIImage?, forState state: UIControlState)

    Objective-C

    - (void)setBackgroundImage:(UIImage *)image forState:(UIControlState)state

    Parameters

    image

    The background image to use for the specified state.

    state

    The control state in which you want to display the image.

    Discussion

    For good results, image must be a stretchable image.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Returns the image used for the decrement glyph of the control.

    Declaration

    Swift

    func decrementImageForState(_ state: UIControlState) -> UIImage

    Objective-C

    - (UIImage *)decrementImageForState:(UIControlState)state

    Parameters

    state

    The control state in which the image is displayed.

    Return Value

    The image used for the decrement glyph of the control.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Sets the image to use for the decrement glyph of the control.

    Declaration

    Swift

    func setDecrementImage(_ image: UIImage?, forState state: UIControlState)

    Objective-C

    - (void)setDecrementImage:(UIImage *)image forState:(UIControlState)state

    Parameters

    image

    The image to use for the decrement glyph.

    state

    The control state in which you want to display the image.

    Discussion

    The image you specify is composited on top of the control’s background to create the final control. If you do not specify a custom image, a minus (-) glyph is used.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Returns the divider image for the given combination of left and right states.

    Declaration

    Swift

    func dividerImageForLeftSegmentState(_ leftState: UIControlState, rightSegmentState rightState: UIControlState) -> UIImage!

    Objective-C

    - (UIImage *)dividerImageForLeftSegmentState:(UIControlState)leftState rightSegmentState:(UIControlState)rightState

    Parameters

    leftState

    The state of the left side of the control.

    rightState

    The state of the right side of the control.

    Return Value

    The image used for the specified combination of left and right states.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Sets the image to use for the given combination of left and right states.

    Declaration

    Swift

    func setDividerImage(_ image: UIImage?, forLeftSegmentState leftState: UIControlState, rightSegmentState rightState: UIControlState)

    Objective-C

    - (void)setDividerImage:(UIImage *)image forLeftSegmentState:(UIControlState)leftState rightSegmentState:(UIControlState)rightState

    Parameters

    image

    The divider image to use.

    leftState

    The state of the left side of the control.

    rightState

    The state of the right side of the control.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Returns the image used for the increment glyph of the control.

    Declaration

    Swift

    func incrementImageForState(_ state: UIControlState) -> UIImage

    Objective-C

    - (UIImage *)incrementImageForState:(UIControlState)state

    Parameters

    state

    The control state in which the image is displayed.

    Return Value

    The image used for the increment glyph of the control.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.

  • Sets the image to use for the increment glyph of the control

    Declaration

    Swift

    func setIncrementImage(_ image: UIImage?, forState state: UIControlState)

    Objective-C

    - (void)setIncrementImage:(UIImage *)image forState:(UIControlState)state

    Parameters

    image

    The image to use for the increment glyph.

    state

    The control state.

    Discussion

    The image you specify is composited on top of the control’s background to create the final control. If you do not specify a custom image, a plus (+) glyph is used.

    Import Statement

    Objective-C

    @import UIKit;

    Swift

    import UIKit

    Availability

    Available in iOS 6.0 and later.