goal_gui.cpp File Reference

GUI for goals. More...

#include "stdafx.h"
#include "industry.h"
#include "town.h"
#include "window_gui.h"
#include "strings_func.h"
#include "viewport_func.h"
#include "gui.h"
#include "goal_base.h"
#include "core/geometry_func.hpp"
#include "company_func.h"
#include "company_base.h"
#include "company_gui.h"
#include "story_base.h"
#include "command_func.h"
#include "string_func.h"
#include "goal_cmd.h"
#include "widgets/goal_widget.h"
#include "table/strings.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	GoalListWindow
	Window for displaying goals. More...
struct	GoalQuestionWindow
	Ask a question about a goal. More...
struct	NestedGoalWidgets< bg_colour, btn_colour, caption >
	Widgets of the goal question window. More...

Enumerations
enum	GoalColumn : uint8_t { GC_GOAL = 0 , GC_PROGRESS }
	Goal list columns. More...

Functions
void	ShowGoalsList (CompanyID company)
	Open a goal list window.
void	ShowGoalQuestion (uint16_t id, uint8_t type, uint32_t button_mask, const EncodedString &question)
	Display a goal question.

Variables
static constexpr NWidgetPart	_nested_goals_list_widgets []
	Widgets of the GoalListWindow.
static WindowDesc	_goals_list_desc (WDP_AUTO, "list_goals", 500, 127, WC_GOALS_LIST, WC_NONE, {}, _nested_goals_list_widgets)
static constexpr auto	_nested_goal_question_widgets_question = NestedGoalWidgets<COLOUR_LIGHT_BLUE, COLOUR_LIGHT_BLUE, STR_GOAL_QUESTION_CAPTION_QUESTION>::widgetparts
static constexpr auto	_nested_goal_question_widgets_info = NestedGoalWidgets<COLOUR_LIGHT_BLUE, COLOUR_LIGHT_BLUE, STR_GOAL_QUESTION_CAPTION_INFORMATION>::widgetparts
static constexpr auto	_nested_goal_question_widgets_warning = NestedGoalWidgets<COLOUR_YELLOW, COLOUR_YELLOW, STR_GOAL_QUESTION_CAPTION_WARNING>::widgetparts
static constexpr auto	_nested_goal_question_widgets_error = NestedGoalWidgets<COLOUR_RED, COLOUR_YELLOW, STR_GOAL_QUESTION_CAPTION_ERROR>::widgetparts
static WindowDesc	_goal_question_list_desc []

Detailed Description

GUI for goals.

Definition in file goal_gui.cpp.

Enumeration Type Documentation

GoalColumn

enum GoalColumn : uint8_t

Goal list columns.

Enumerator
GC_GOAL	Goal text column.
GC_PROGRESS	Goal progress column.

Definition at line 34 of file goal_gui.cpp.

Function Documentation

ShowGoalQuestion()

void ShowGoalQuestion	(	uint16_t	id,
		uint8_t	type,
		uint32_t	button_mask,
		const EncodedString &	question
	)

Display a goal question.

Parameters

id	Window number to use.
type	Type of question.
button_mask	Buttons to display.
question	Question to ask.

Definition at line 475 of file goal_gui.cpp.

Referenced by CmdGoalQuestion().

ShowGoalsList()

void ShowGoalsList

(

CompanyID

company

)

Open a goal list window.

Parameters

company

Company to display the goals for, use CompanyID::Invalid() to display global goals.

Definition at line 311 of file goal_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::IsValidID().

Referenced by MenuClickGoal(), GoalListWindow::OnClick(), MainToolbarWindow::OnHotkey(), and StoryBookWindow::OnPageElementClick().

Variable Documentation

_goal_question_list_desc

WindowDesc _goal_question_list_desc[]

static

Initial value:

= {
  {
    WDP_CENTER, {}, 0, 0,
    WC_GOAL_QUESTION, WC_NONE,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_question,
  },
  {
    WDP_CENTER, {}, 0, 0,
    WC_GOAL_QUESTION, WC_NONE,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_info,
  },
  {
    WDP_CENTER, {}, 0, 0,
    WC_GOAL_QUESTION, WC_NONE,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_warning,
  },
  {
    WDP_CENTER, {}, 0, 0,
    WC_GOAL_QUESTION, WC_NONE,
    WindowDefaultFlag::Construction,
    _nested_goal_question_widgets_error,
  },
}

Definition at line 441 of file goal_gui.cpp.

_nested_goal_question_widgets_error

constexpr auto _nested_goal_question_widgets_error = NestedGoalWidgets<COLOUR_RED, COLOUR_YELLOW, STR_GOAL_QUESTION_CAPTION_ERROR>::widgetparts

staticconstexpr

Definition at line 439 of file goal_gui.cpp.

_nested_goal_question_widgets_info

constexpr auto _nested_goal_question_widgets_info = NestedGoalWidgets<COLOUR_LIGHT_BLUE, COLOUR_LIGHT_BLUE, STR_GOAL_QUESTION_CAPTION_INFORMATION>::widgetparts

staticconstexpr

Definition at line 437 of file goal_gui.cpp.

_nested_goal_question_widgets_question

constexpr auto _nested_goal_question_widgets_question = NestedGoalWidgets<COLOUR_LIGHT_BLUE, COLOUR_LIGHT_BLUE, STR_GOAL_QUESTION_CAPTION_QUESTION>::widgetparts

staticconstexpr

Definition at line 436 of file goal_gui.cpp.

_nested_goal_question_widgets_warning

constexpr auto _nested_goal_question_widgets_warning = NestedGoalWidgets<COLOUR_YELLOW, COLOUR_YELLOW, STR_GOAL_QUESTION_CAPTION_WARNING>::widgetparts

staticconstexpr

Definition at line 438 of file goal_gui.cpp.

_nested_goals_list_widgets

constexpr NWidgetPart _nested_goals_list_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
    NWidget(WWT_CAPTION, COLOUR_BROWN, WID_GOAL_CAPTION),
    NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GOAL_SELECT_BUTTONS),
      NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_GOAL_GLOBAL_BUTTON), SetMinimalSize(50, 0), SetStringTip(STR_GOALS_GLOBAL_BUTTON, STR_GOALS_GLOBAL_BUTTON_HELPTEXT),
      NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_GOAL_COMPANY_BUTTON), SetMinimalSize(50, 0), SetStringTip(STR_GOALS_COMPANY_BUTTON, STR_GOALS_COMPANY_BUTTON_HELPTEXT),
    EndContainer(),
    NWidget(WWT_SHADEBOX, COLOUR_BROWN),
    NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
    NWidget(WWT_STICKYBOX, COLOUR_BROWN),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_BROWN, WID_GOAL_LIST), SetToolTip(STR_GOALS_TOOLTIP_CLICK_ON_SERVICE_TO_CENTER), SetScrollbar(WID_GOAL_SCROLLBAR), SetResize(1, 1), SetMinimalTextLines(2, 0),
    EndContainer(),
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_GOAL_SCROLLBAR),
      NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
    EndContainer(),
  EndContainer(),
}

Widgets of the GoalListWindow.

Definition at line 278 of file goal_gui.cpp.