story_gui.cpp File Reference

GUI for stories. More...

#include "stdafx.h"
#include "window_gui.h"
#include "strings_func.h"
#include "gui.h"
#include "story_base.h"
#include "core/geometry_func.hpp"
#include "company_func.h"
#include "command_func.h"
#include "dropdown_type.h"
#include "dropdown_func.h"
#include "sortlist_type.h"
#include "goal_base.h"
#include "viewport_func.h"
#include "window_func.h"
#include "company_base.h"
#include "tilehighlight_func.h"
#include "vehicle_base.h"
#include "story_cmd.h"
#include "widgets/story_widget.h"
#include "table/strings.h"
#include "table/sprites.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	StoryBookWindow
struct	StoryBookWindow::LayoutCacheElement

Typedefs
typedef GUIList< const StoryPage * >	GUIStoryPageList
typedef GUIList< const StoryPageElement * >	GUIStoryPageElementList

Functions
static CursorID	TranslateStoryPageButtonCursor (StoryPageButtonCursor cursor)
void	ShowStoryBook (CompanyID company, StoryPageID page_id, bool centered)
	Raise or create the story book window for company, at page page_id.

Variables
static constexpr std::initializer_list< NWidgetPart >	_nested_story_book_widgets
static WindowDesc	_story_book_desc (WDP_AUTO, "view_story", 400, 300, WC_STORY_BOOK, WC_NONE, {}, _nested_story_book_widgets)
static WindowDesc	_story_book_gs_desc (WDP_CENTER, "view_story_gs", 400, 300, WC_STORY_BOOK, WC_NONE, {}, _nested_story_book_widgets)

Detailed Description

GUI for stories.

Definition in file story_gui.cpp.

Typedef Documentation

GUIStoryPageElementList

typedef GUIList<const StoryPageElement*> GUIStoryPageElementList

Definition at line 39 of file story_gui.cpp.

GUIStoryPageList

typedef GUIList<const StoryPage*> GUIStoryPageList

Definition at line 38 of file story_gui.cpp.

Function Documentation

ShowStoryBook()

void ShowStoryBook	(	CompanyID	company,
		StoryPageID	page_id,
		bool	centered
	)

Raise or create the story book window for company, at page page_id.

Parameters

company	'Owner' of the story book, may be CompanyID::Invalid().
page_id	Page to open, may be StoryPageID::Invalid().
centered	Whether to open the window centered.

Definition at line 1043 of file story_gui.cpp.

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

Referenced by CmdShowStoryPage(), GoalListWindow::HandleClick(), MenuClickStory(), and MainToolbarWindow::OnHotkey().

TranslateStoryPageButtonCursor()

static CursorID TranslateStoryPageButtonCursor ( StoryPageButtonCursor  cursor )

static

Definition at line 975 of file story_gui.cpp.

Variable Documentation

_nested_story_book_widgets

constexpr std::initializer_list<NWidgetPart> _nested_story_book_widgets

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
    NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SB_CAPTION),
    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_SB_PAGE_PANEL), SetResize(1, 1), SetScrollbar(WID_SB_SCROLLBAR), EndContainer(),
    NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_SB_SCROLLBAR),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SB_PREV_PAGE), SetMinimalSize(100, 0), SetFill(0, 0), SetStringTip(STR_STORY_BOOK_PREV_PAGE, STR_STORY_BOOK_PREV_PAGE_TOOLTIP),
    NWidget(NWID_BUTTON_DROPDOWN, COLOUR_BROWN, WID_SB_SEL_PAGE), SetMinimalSize(93, 12), SetFill(1, 0),
                        SetToolTip(STR_STORY_BOOK_SEL_PAGE_TOOLTIP), SetResize(1, 0),
    NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SB_NEXT_PAGE), SetMinimalSize(100, 0), SetFill(0, 0), SetStringTip(STR_STORY_BOOK_NEXT_PAGE, STR_STORY_BOOK_NEXT_PAGE_TOOLTIP),
    NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
  EndContainer(),
}

Definition at line 940 of file story_gui.cpp.