signs_gui.cpp File Reference

The GUI for signs. More...

#include "stdafx.h"
#include "company_gui.h"
#include "company_func.h"
#include "signs_base.h"
#include "signs_func.h"
#include "debug.h"
#include "command_func.h"
#include "strings_func.h"
#include "window_func.h"
#include "map_func.h"
#include "viewport_func.h"
#include "querystring_gui.h"
#include "sortlist_type.h"
#include "stringfilter_type.h"
#include "string_func.h"
#include "core/geometry_func.hpp"
#include "hotkeys.h"
#include "transparency.h"
#include "gui.h"
#include "signs_cmd.h"
#include "timer/timer.h"
#include "timer/timer_window.h"
#include "widgets/sign_widget.h"
#include "table/strings.h"
#include "table/sprites.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	SignList
struct	SignListWindow
struct	SignWindow

Functions
Window *	ShowSignList ()
	Open the sign list window.
static bool	RenameSign (SignID index, std::string_view text)
	Actually rename the sign.
void	HandleClickOnSign (const Sign *si)
	Handle clicking on a sign.
void	ShowRenameSignWindow (const Sign *si)
	Show the window to change the text of a sign.
void	DeleteRenameSignWindow (SignID sign)
	Close the sign window associated with the given sign.

Variables
static constexpr std::initializer_list< NWidgetPart >	_nested_sign_list_widgets
static WindowDesc	_sign_list_desc (WDP_AUTO, "list_signs", 358, 138, WC_SIGN_LIST, WC_NONE, {}, _nested_sign_list_widgets, &SignListWindow::hotkeys)
static constexpr std::initializer_list< NWidgetPart >	_nested_query_sign_edit_widgets
static WindowDesc	_query_sign_edit_desc (WDP_CENTER, {}, 0, 0, WC_QUERY_STRING, WC_NONE, WindowDefaultFlag::Construction, _nested_query_sign_edit_widgets)

Detailed Description

The GUI for signs.

Definition in file signs_gui.cpp.

Function Documentation

DeleteRenameSignWindow()

void DeleteRenameSignWindow

(

SignID

sign

)

Close the sign window associated with the given sign.

Parameters

sign	The sign to close the window for.

Definition at line 566 of file signs_gui.cpp.

References Window::Close(), FindWindowById(), WC_QUERY_STRING, and WN_QUERY_STRING_SIGN.

Referenced by Sign::~Sign().

HandleClickOnSign()

void HandleClickOnSign

(

const Sign *

si

)

Handle clicking on a sign.

Parameters

si	The sign that was clicked on.

Definition at line 537 of file signs_gui.cpp.

References _ctrl_pressed, _local_company, CompanyCanRenameSign(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, OWNER_DEITY, RenameSign(), and ShowRenameSignWindow().

RenameSign()

static bool RenameSign ( SignID  index, std::string_view  text  )

static

Actually rename the sign.

Parameters

index	the sign to rename.
text	the new name.

Returns

true if the window will already be removed after returning.

Definition at line 383 of file signs_gui.cpp.

Referenced by HandleClickOnSign(), and SignWindow::OnClick().

ShowRenameSignWindow()

void ShowRenameSignWindow

(

const Sign *

si

)

Show the window to change the text of a sign.

Parameters

si	The sign to show the window for.

Definition at line 554 of file signs_gui.cpp.

References CloseWindowByClass(), and WC_QUERY_STRING.

Referenced by CcPlaceSign(), and HandleClickOnSign().

ShowSignList()

Window * ShowSignList

(

)

Open the sign list window.

Returns

newly opened sign list window, or nullptr if the window could not be opened.

Definition at line 372 of file signs_gui.cpp.

Referenced by MenuClickMap(), MainToolbarWindow::OnHotkey(), and SignListWindow::SignListGlobalHotkeys().

Variable Documentation

_nested_query_sign_edit_widgets

constexpr std::initializer_list<NWidgetPart> _nested_query_sign_edit_widgets

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY, WID_QES_CAPTION), SetTextStyle(TC_WHITE),
    NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_QES_LOCATION), SetAspect(WidgetDimensions::ASPECT_LOCATION), SetSpriteTip(SPR_GOTO_LOCATION, STR_EDIT_SIGN_LOCATION_TOOLTIP),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY),
    NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QES_TEXT), SetMinimalSize(256, 0), SetStringTip(STR_EDIT_SIGN_SIGN_OSKTITLE), SetPadding(2, 2, 2, 2),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_OK), SetMinimalSize(61, 12), SetStringTip(STR_BUTTON_OK),
    NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_CANCEL), SetMinimalSize(60, 12), SetStringTip(STR_BUTTON_CANCEL),
    NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_QES_DELETE), SetMinimalSize(60, 12), SetStringTip(STR_TOWN_VIEW_DELETE_BUTTON),
    NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), EndContainer(),
    NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_PREVIOUS), SetMinimalSize(11, 12), SetArrowWidgetTypeTip(AWV_DECREASE, STR_EDIT_SIGN_PREVIOUS_SIGN_TOOLTIP),
    NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_QES_NEXT), SetMinimalSize(11, 12), SetArrowWidgetTypeTip(AWV_INCREASE, STR_EDIT_SIGN_NEXT_SIGN_TOOLTIP),
  EndContainer(),
}

Definition at line 507 of file signs_gui.cpp.

_nested_sign_list_widgets

constexpr std::initializer_list<NWidgetPart> _nested_sign_list_widgets

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
    NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SIL_CAPTION),
    NWidget(WWT_SHADEBOX, COLOUR_BROWN),
    NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
    NWidget(WWT_STICKYBOX, COLOUR_BROWN),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_VERTICAL),
      NWidget(WWT_PANEL, COLOUR_BROWN, WID_SIL_LIST), SetMinimalSize(WidgetDimensions::unscaled.frametext.Horizontal() + 16 + 255, 0),
                SetResize(1, 1), SetFill(1, 0), SetScrollbar(WID_SIL_SCROLLBAR), EndContainer(),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 1),
          NWidget(WWT_EDITBOX, COLOUR_BROWN, WID_SIL_FILTER_TEXT), SetMinimalSize(80, 0), SetResize(1, 0), SetFill(1, 0), SetPadding(2, 2, 2, 2),
              SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
        EndContainer(),
        NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_SIL_FILTER_MATCH_CASE_BTN), SetStringTip(STR_SIGN_LIST_MATCH_CASE, STR_SIGN_LIST_MATCH_CASE_TOOLTIP),
      EndContainer(),
    EndContainer(),
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_SIL_SCROLLBAR),
      NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
    EndContainer(),
  EndContainer(),
}

Definition at line 332 of file signs_gui.cpp.