MiscSliderCell.rtf

This is MiscSliderCell.rtf in view mode; [Download] [Up]

MiscSliderCell

Inherits From: TextFieldCell : ActionCell : Cell : Object

Declared In: MiscSliderCell.h

Class Description

A subclass of TextFieldCell that adds a SliderCell to the mix. This cell functions the same way as a TextField/Slider combination connected together in Interface Builder. The main differences are that it allows you to now send an action method to an outside object when the value changes, it is much easier to get a consistent layout, there are fewer connections to be made, and it can be put in a Matrix easily (the same as any other cell). A MiscStringArray or a StringList (found as a MiniExample) can be attached to provide text strings that get shown instead of numbers.

A valid string list object responds to:
-(char *) stringAt:(int)item;
-(unsigned int) count;
The value sent to stringAt: will be in the range 0 - count. When the stringList instance variable is set, the ranges as set in IB (or wherever) are ignored and the string list defines the range of its values. Of course, stringAt: can create its return value any way it likes.

It also implements expandable boundaries. This allows you to set up the slider to have a reasonable range when it first appears, but also allows the user to type in values out of the range. The slider will then adjust to the new range automatically.

The cell can be configured to either send a single action message to it's target when the slider is released, or it can still send continuous messages. This allows you to easily skip dealing with the intermediate values, but still respond quickly to any change.

Instance Variables

id idSlider;
id stringList;
int layout;
float split;
double actualValue;
double limitMinValue;
double limitMaxValue;
double limitMinBound;
double limitMaxBound;
BOOL fExpandLow;
BOOL fExpandHigh;
BOOL fInt;
BOOL fLoop;
BOOL fFeedback;
BOOL fValidRect;
NXRect rectFrame;

idSlider The SliderCell.

stringList An object to provide strings in place of values.

layout The relative positioning of the sub-cells.

split The size of the Text Cell relative to the size of the MiscSliderCell.

actualValue The numeric value since the display may be a string.

limitMinValue The absolute lower limit of allowable values.

limitMaxValue The absolute upper limit of allowable values.

limitMinBound The adjustable lower limit for stopping the value when using the slider.

limitMaxBound The adjustable upper limit for stopping the value when using the slider.

fExpandLow Declares that limitMinBound is actually being used.

fExpandHigh Declares that limitMaxBound is actually being used.

fInt YES means the value it truncated to integral values.

fLoop Used to keep things sane in the setXXXValue: methods. (Stops endless looping).

fFeedback Used when the slider is being moved to keep from looping.

fValidRect Used by the drawing methods to keep track of the width adjustment.

rectFrame Used by the drawing methods to keep track of the width adjustment.

Method Types

Initializing � initTextCell:
� copyFromZone:

Changing a MiscSliderCell � setEditable:

Manipulating a MiscSliderCell � setMinValue:
� setMaxValue:
� setMinBoundary:
� setMaxBoundary:
� setExpandMin:
� setExpandMax:
� setPosition:
� setSplit:
� setStringList:
� setIntegerOnly:

Querying values � minValue
� maxValue
� minBoundary
� maxBoundary
� expandMin
� expandMax
� position
� split
� stringList
� integerOnly

Archiving � read:
� write:
� awake
� awakeFromNib

Instance Methods

awake
� awake

Sends a message so the value will be properly displayed. Returns self.

See also: � integerOnly

setMaxBoundary
� setMaxBoundary:(double)value

Sets the highest value the field will allow when using the arrow buttons to adjust the value. This value can be exceeded and altered by typing a value greater than this limit. This value will be adjusted to match the entered amount with an additional limitation that it will stop at maxValue. Returns self.

See also: � expandMax, � expandMin, � maxBoundary, � maxValue, � minBoundary, � minValue, ��setExpandMax, � setExpandMin, � setMaxValue, � setMinBoundary, � setMinValue

setMaxValue
� setMaxValue:(double)value

Sets the highest value the field will allow. There is no way to exceed this limit from the interface. maxBoundary will stop expanding when it gets to this value. Returns self.

See also: � expandMax, � expandMin, � maxBoundary, � maxValue, � minBoundary, � minValue, ��setExpandMax, � setExpandMin, � setMaxBoundary, � setMinBoundary, � setMinValue

setMinBoundary
� setMinBoundary:(double)value

Sets the lowest value the field will allow when using the arrow buttons to adjust the value. This value can be exceeded and altered by typing a value lower than this limit. This value will be adjusted to match the entered amount with an additional limitation that it will stop at minValue. Returns self.

See also: � expandMax, � expandMin, � maxBoundary, � maxValue, � minBoundary, � minValue, ��setExpandMax, � setExpandMin, � setMaxBoundary, � setMaxValue, � setMinValue

setMinValue
� setMinValue:(double)value

Sets the lowest value the field will allow. There is no way to exceed this limit from the interface. minBoundary will stop expanding when it gets to this value. Returns self.

See also: � expandMax, � expandMin, � maxBoundary, � maxValue, � minBoundary, � minValue, ��setExpandMax, � setExpandMin, � setMaxBoundary, � setMaxValue, � setMinBoundary

setPosition
� setPosition:(int)where

Sets the position of the TextFieldCell relative to the SliderCell. Constants are defined in MiscSliderCell.h and can be selected from MSC_ABOVELEFT, MSC_ABOVECENTER, MSC_ABOVERIGHT, MSC_LEFT, MSC_RIGHT, MSC_BELOWLEFT, MSC_BELOWCENTER and MSC_BELOWRIGHT. See setSplit: for further control of the display. Returns self.

See also: � position, � setSplit:, � split

setSplit
� setSplit:(int)percent

Sets the width of the TextFieldCell as a percentage of the width of the entire MiscSliderCell. When the position is set to MSC_LEFT or MSC_RIGHT the SliderCell is adjusted to take up the remaining horizontal space. In all the other position settings the SliderCell takes the full width of the MiscSliderCell and the TextFieldCell is still sized as a percentage of the total length and positioned appropriately. Valid values are 0-100 but the minimum size of both the TextFieldCell and the SliderCell are set. Returns self.

See also: � position, � setPosition:, � split

setStringList:
� setStringList:anObject

Sets the object to be asked for display strings. anObject should respond to stringAt: and count messages. When a string list is set the range limits are all ignored and the field is set to non-editable. The value of the field will only fit within a range defined by anObject's count method. Returns self.

anObject's stringAt: method should take an int as its argument and return a char * with the correct string to be displayed for the given value. The value of the argument will range from 0 to count - 1. This arrangement has been created to allow the MiscValueField to be connected to a StringList (found in the MiniExamples) object in Interface Builder so lists may be created, displayed and dealt with with no additional code.