class IntegerSetting

Defined in: C4Configuration.h

The IntegerSetting class is used for an integer setting represented by a slider.

Definition

class IntegerSetting : public Setting

Member Functions

IntegerSetting::GetIntegerValue Returns the integer value stored in the setting.

Constructor

IntegerSetting(Type identifier, long value, const char *title, long min, long max, long step);

Parameters

`identifier`	The setting's unique identifier.
`value`	The initial value of the setting.
`title`	The title of the setting.
`min`	The minimum value allowed for the setting.
`max`	The maximum value allowed for the setting.
`step`	The smallest increment allowed between the minimum and maximum values.

Description

The IntegerSetting class represents a setting that displays a slider and has an integer value restricted to a given range. A text box is also displayed, allowing the user to enter a value directly. The value of the setting is always equal to the minimum value specified by the min parameter plus a multiple of the step parameter, but is never greater than the maaximum value specified by the max parameter. If the user enters a number in the text box, then it is rounded down to the nearest valid value.

Base Classes

Setting An IntegerSetting is a specific type of Setting.