class TextSetting

Defined in: C4Configuration.h

The TextSetting class is used for a text setting represented by an editable text box.

Definition

class TextSetting : public Setting

Member Functions

TextSetting::GetText Returns the text stored in the setting.

Constructor

TextSetting(Type identifier, const char *text, const char *title, long maxLen,

EditableTextWidget::FilterProc *filterProc = nullptr);

Parameters

`identifier`	The setting's unique identifier.
`text`	The initial text for the setting.
`title`	The title of the setting.
`maxLen`	The maximum number of characters that can be entered into the text box.
`filterProc`	A character filter function. If this is `nullptr`, then all characters are allowed.

Description

The TextSetting class represents a setting that displays a text box and has a string value. The maximum length of the string is specified by the maxLen parameter, and the characters allowed in the string can be controlled by specifying a filter with the filterProc parameter. If no filter is specified, then all characters are allowed.

Base Classes

Setting A TextSetting is a specific type of Setting.