company_gui.h File Reference

GUI Functions related to companies. More...

#include "company_type.h"
#include "group.h"
#include "gfx_type.h"

Go to the source code of this file.

Functions
TextColour	GetDrawStringCompanyColour (CompanyID company)
	Get the colour for DrawString-subroutines which matches the colour of the company.
void	DrawCompanyIcon (CompanyID c, int x, int y)
	Draw the icon of a company.
void	ShowCompanyLiveryWindow (CompanyID company, GroupID group)
void	ShowCompanyStations (CompanyID company)
	Opens window with list of company's stations.
void	ShowCompanyFinances (CompanyID company)
	Open the finances window of a company.
void	ShowCompany (CompanyID company)
	Show the window with the overview of the company.
void	InvalidateCompanyWindows (const Company *c)
	Mark all finance windows owned by a company as needing a refresh.
void	InvalidateCompanyWindows ()
	Refresh all company finance windows previously marked dirty.
void	CloseCompanyWindows (CompanyID company)
	Close all windows of a company.
void	DirtyCompanyInfrastructureWindows (CompanyID company)
	Redraw all windows with company infrastructure counts.

Detailed Description

GUI Functions related to companies.

Definition in file company_gui.h.

Function Documentation

CloseCompanyWindows()

void CloseCompanyWindows

(

CompanyID

id

)

Close all windows of a company.

We identify windows of a company by looking at the caption colour. If it is equal to the company ID then we say the window belongs to the company and should be closed

Parameters

id	company identifier

Definition at line 1176 of file window.cpp.

References CloseWindowById(), and WC_BUY_COMPANY.

Referenced by Company::~Company().

DirtyCompanyInfrastructureWindows()

void DirtyCompanyInfrastructureWindows

(

CompanyID

company

)

Redraw all windows with company infrastructure counts.

Parameters

company

The company to redraw the windows of.

Definition at line 2504 of file company_gui.cpp.

References SetWindowDirty(), WC_COMPANY, and WC_COMPANY_INFRASTRUCTURE.

Referenced by Station::AfterStationTileSetChange(), BuildObject(), CmdBuildBridge(), CmdBuildCanal(), CmdBuildRailWaypoint(), CmdBuildRoad(), CmdBuildRoadWaypoint(), CmdBuildShipDepot(), CmdBuildSingleRail(), CmdBuildSingleSignal(), CmdBuildTrainDepot(), CmdBuildTunnel(), CmdConvertRail(), CmdLandscapeClear(), CmdRemoveSingleRail(), CmdRemoveSingleSignal(), ConvertRoadTypeOwner(), DoBuildLock(), DoClearBridge(), DoClearTunnel(), RemoveFromRailBaseStation(), RemoveLock(), RemoveRoad(), RemoveRoadStop(), RemoveRoadWaypointStop(), and UpdateCompanyRoadInfrastructure().

DrawCompanyIcon()

void DrawCompanyIcon	(	CompanyID	c,
		int	x,
		int	y
	)

Draw the icon of a company.

Parameters

c	Company that needs its icon drawn.
x	Horizontal coordinate of the icon.
y	Vertical coordinate of the icon.

Definition at line 170 of file company_cmd.cpp.

GetDrawStringCompanyColour()

TextColour GetDrawStringCompanyColour

(

CompanyID

company

)

Get the colour for DrawString-subroutines which matches the colour of the company.

Parameters

company

Company to get the colour of.

Returns

Colour of company.

Definition at line 148 of file company_cmd.cpp.

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

Referenced by CmdGiveMoney(), NetworkServerSendChat(), and ClientNetworkGameSocketHandler::Receive_SERVER_CHAT().

InvalidateCompanyWindows() [1/2]

void InvalidateCompanyWindows

(

)

Refresh all company finance windows previously marked dirty.

Definition at line 222 of file company_cmd.cpp.

References _dirty_company_finances, _local_company, FindWindowById(), Window::SetWidgetDirty(), SetWindowWidgetDirty(), WC_COMPANY, WC_FINANCES, WC_STATUS_BAR, WID_C_DESC_COMPANY_VALUE, WID_CF_BALANCE_VALUE, WID_CF_EXPS_PRICE3, WID_CF_OWN_VALUE, and WID_S_RIGHT.

Referenced by CmdDecreaseLoan(), CmdIncreaseLoan(), CmdSetCompanyMaxLoan(), StateGameLoop(), and SubtractMoneyFromAnyCompany().

InvalidateCompanyWindows() [2/2]

void InvalidateCompanyWindows

(

const Company *

company

)

Mark all finance windows owned by a company as needing a refresh.

The actual refresh is deferred until the end of the gameloop to reduce duplicated work.

Parameters

company

Company that changed, and needs its windows refreshed.

Definition at line 213 of file company_cmd.cpp.

References _dirty_company_finances, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set().

ShowCompany()

void ShowCompany

(

CompanyID

company

)

Show the window with the overview of the company.

Parameters

company

The company to show the window for.

Definition at line 2493 of file company_gui.cpp.

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

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

ShowCompanyFinances()

void ShowCompanyFinances

(

CompanyID

company

)

Open the finances window of a company.

Parameters

company

Company to show finances of.

Precondition

is company a valid company.

Definition at line 567 of file company_gui.cpp.

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

Referenced by MenuClickFinances(), StatusBarWindow::OnClick(), and MainToolbarWindow::OnHotkey().

ShowCompanyLiveryWindow()

void ShowCompanyLiveryWindow	(	CompanyID	company,
		GroupID	group
	)

Definition at line 1109 of file company_gui.cpp.

ShowCompanyStations()

void ShowCompanyStations

(

CompanyID

company

)

Opens window with list of company's stations.

Parameters

company

whose stations' list show

Definition at line 807 of file station_gui.cpp.

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

Referenced by MenuClickStations(), and MainToolbarWindow::OnHotkey().