freeciv::governor_widget Class Reference

A widget that lets the user edit governor settings. More...

#include <governor_widget.h>

Inheritance diagram for freeciv::governor_widget:

Collaboration diagram for freeciv::governor_widget:

Signals
void	parameters_changed (const cm_parameter &params)
	Signal emitted when the governor settings are changed. More...

Public Member Functions
	governor_widget (QWidget *parent=nullptr)
	Constructor. More...
virtual	~governor_widget ()=default
	Destructor. More...
cm_parameter	parameters () const
	Returns the parameters currently shown by the widget. More...
void	set_parameters (const cm_parameter &params)
	Changes the parameters displayed by this widget. More...

Private Member Functions
void	emit_params_changed ()
	Helper to fill the argument of parameters_changed. More...
void	queue_params_changed ()
	Queues an update of the parameters. More...

Private Attributes
Ui::governor_widget	ui
bool	m_dirty = false
	Whether we need to propagate a params update. More...

Detailed Description

A widget that lets the user edit governor settings.

Definition at line 11 of file governor_widget.h.

Constructor & Destructor Documentation

governor_widget()

freeciv::governor_widget::governor_widget ( QWidget *  parent = nullptr )

explicit

Constructor.

Definition at line 27 of file governor_widget.cpp.

~governor_widget()

virtual freeciv::governor_widget::~governor_widget ( )

virtualdefault

Destructor.

Member Function Documentation

emit_params_changed()

void freeciv::governor_widget::emit_params_changed ( )

private

Helper to fill the argument of parameters_changed.

Definition at line 131 of file governor_widget.cpp.

Referenced by queue_params_changed().

parameters()

cm_parameter freeciv::governor_widget::parameters

(

)

const

Returns the parameters currently shown by the widget.

Definition at line 71 of file governor_widget.cpp.

Referenced by emit_params_changed().

parameters_changed

freeciv::governor_widget::parameters_changed ( const cm_parameter &  params )

signal

Signal emitted when the governor settings are changed.

Note that this may be emitted very often.

Referenced by city_dialog::city_dialog(), and emit_params_changed().

queue_params_changed()

void freeciv::governor_widget::queue_params_changed ( )

private

Queues an update of the parameters.

This prevents emitting parameters_changed, and thus recalculating the results, too often.

Definition at line 141 of file governor_widget.cpp.

Referenced by governor_widget().

set_parameters()

void freeciv::governor_widget::set_parameters

(

const cm_parameter &

params

)

Changes the parameters displayed by this widget.

Definition at line 99 of file governor_widget.cpp.

Member Data Documentation

m_dirty

bool freeciv::governor_widget::m_dirty = false

private

Whether we need to propagate a params update.

Definition at line 29 of file governor_widget.h.

Referenced by emit_params_changed(), and queue_params_changed().

ui

Ui::governor_widget freeciv::governor_widget::ui

private

Definition at line 13 of file governor_widget.h.

Referenced by governor_widget(), parameters(), and set_parameters().