Standard setting. More...

Inheritance diagram for SettingEntry:

Public Member Functions
	SettingEntry (const char *name)
	Constructor for a single setting in the 'advanced settings' window. More...

void	Init (uint8_t level=0) override
	Initialization of a setting entry. More...

void	ResetAll () override

uint	Length () const override
	Return number of rows needed to display the (filtered) entry.

uint	GetMaxHelpHeight (int maxw) override
	Get the biggest height of the help text(s), if the width is at least maxw. More...

bool	UpdateFilterState (SettingFilter &filter, bool force_visible) override
	Update the filter state. More...

void	SetButtons (uint8_t new_val)
	Set the button-depressed flags (SEF_LEFT_DEPRESSED and SEF_RIGHT_DEPRESSED) to a specified value. More...

Public Member Functions inherited from BaseSettingEntry
virtual void	FoldAll ()

virtual void	UnFoldAll ()

void	SetLastField (bool last_field)
	Set whether this is the last visible entry of the parent node. More...

virtual void	GetFoldingState ([[maybe_unused]] bool &all_folded, [[maybe_unused]] bool &all_unfolded) const

virtual bool	IsVisible (const BaseSettingEntry *item) const
	Check whether an entry is visible and not folded or filtered away. More...

virtual BaseSettingEntry *	FindEntry (uint row, uint *cur_row)
	Find setting entry at row row_num. More...

virtual uint	GetMaxHelpHeight ([[maybe_unused]] int maxw)

bool	IsFiltered () const
	Check whether an entry is hidden due to filters. More...

virtual uint	Draw (GameSettings settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry selected, uint cur_row=0, uint parent_last=0) const
	Draw a row in the settings panel. More...

Data Fields
const char *	name
	Name of the setting.

const IntSettingDesc *	setting
	Setting description of the setting.

Data Fields inherited from BaseSettingEntry
uint8_t	flags
	Flags of the setting entry. More...

uint8_t	level
	Nesting level of this setting entry.

Protected Member Functions
void	DrawSetting (GameSettings *settings_ptr, int left, int right, int y, bool highlight) const override
	Function to draw setting value (button + text + current value) More...

Private Member Functions
bool	IsVisibleByRestrictionMode (RestrictionMode mode) const
	Checks whether an entry shall be made visible based on the restriction mode. More...

Detailed Description

Standard setting.

Definition at line 1280 of file settings_gui.cpp.

Constructor & Destructor Documentation

◆ SettingEntry()

SettingEntry::SettingEntry ( const char * name )

Constructor for a single setting in the 'advanced settings' window.

Parameters

name	Name of the setting in the setting table

Definition at line 1461 of file settings_gui.cpp.

References name, and setting.

Member Function Documentation

◆ DrawSetting()

void SettingEntry::DrawSetting	(	GameSettings *	settings_ptr,
		int	left,
		int	right,
		int	y,
		bool	highlight
	)		const

overrideprotectedvirtual

Function to draw setting value (button + text + current value)

Parameters

settings_ptr	Pointer to current values of all settings
left	Left-most position in window/panel to start drawing
right	Right-most position in window/panel to draw
y	Upper-most position in window/panel to start drawing
highlight	Highlight entry.