Settings Class Reference

Class used to store and restore application settings. More...

#include <settings.h>

Collaboration diagram for Settings:

Data Structures
struct	SettStartBox
Public Types
enum	CompletionMethod { MatchNearest = 1, MatchExact = 2 }
Public Member Functions
	Settings ()
	Default constructor.
	~Settings ()
wxArrayString	GetGroupList (const wxString &base_key)
	list all entries subkeys of a parent group
wxArrayString	GetEntryList (const wxString &base_key)
	list all groups subkeys of a parent group
unsigned int	GetGroupCount (const wxString &base_key)
	counts all groups subkeys of a parent group
bool	IsPortableMode () const
void	SetPortableMode (bool mode)
void	SetDefaultServerSettings ()
	Initialize all settings to default.
void	SaveSettings ()
	Saves the settings to file.
bool	IsFirstRun ()
void	SetSettingsVersion ()
	Sets/Gets settings revision number.
int	GetSettingsVersion ()
void	SetReportStats (const bool value)
	should we sayex/pm bot?
bool	GetReportStats ()
void	SetAutoUpdate (const bool value)
bool	GetAutoUpdate ()
bool	IsSelfUpdateDisabled ()
wxString	GetLobbyWriteDir ()
wxString	GetTempStorage ()
bool	GetSmartScrollEnabled ()
void	SetSmartScrollEnabled (bool value)
bool	GetAlwaysAutoScrollOnFocusLost ()
void	SetAlwaysAutoScrollOnFocusLost (bool value)
void	ConvertOldHiglightSettings ()
void	SetUseIrcColors (bool value)
bool	GetUseIrcColors ()
wxColour	GetBattleLastColour ()
void	SetBattleLastColour (const wxColour &col)
void	SetLastAI (const wxString &ai)
wxString	GetLastAI ()
void	SetBalanceMethod (int value)
int	GetBalanceMethod ()
void	SetBalanceClans (bool value)
bool	GetBalanceClans ()
void	SetBalanceStrongClans (bool value)
bool	GetBalanceStrongClans ()
void	SetBalanceGrouping (int value)
int	GetBalanceGrouping ()
void	SetFixIDMethod (int value)
int	GetFixIDMethod ()
void	SetFixIDClans (bool value)
bool	GetFixIDClans ()
void	SetFixIDStrongClans (bool value)
bool	GetFixIDStrongClans ()
void	SetFixIDGrouping (int value)
int	GetFixIDGrouping ()
bool	GetDisableSpringVersionCheck ()
bool	IgnoreOfferfile ()
void	SetCompletionMethod (CompletionMethod method)
CompletionMethod	GetCompletionMethod () const
template<class T >
T	Get (wxString setting, const T def)
	you are absolutely forbidden to use this
template<class T >
bool	Set (wxString setting, const T val)
bool	GetBroadcastEverywhere ()
void	SetBroadcastEverywhere (bool value)
wxString	GlobalConfigPath () const
wxString	FinalConfigPath () const
Network

bool	GetNoUDP ()
void	SetNoUDP (bool value)
int	GetClientPort ()
void	SetClientPort (int value)
	use zero to pick port automatically, nonzero to override. This allows to play if you have broken router, by setting SourcePort to some forwarded port.
bool	GetShowIPAddresses ()
void	SetShowIPAddresses (bool value)
Web Browser
Web browser preferences.
bool	GetWebBrowserUseDefault ()
	Fetch the "Use Default" setting for the web browser.
void	SetWebBrowserUseDefault (bool useDefault)
	Set the "Use Default" setting for the web browser.
wxString	GetWebBrowserPath ()
	Get the path to the user-configured browser.
void	SetWebBrowserPath (const wxString &path)
	Set the path to the user-configured browser.
Cache
Information about the directory tree used to cache infomation about maps and mods.
wxString	GetCachePath ()
void	SetCacheVersion ()
	sets version number for the cache, needed to nuke it in case it becomes obsolete & incompatible with new versions
int	GetCacheVersion ()
	returns the cache versioning number, do decide whenever to delete if becomes obsolete & incompatible with new versions
void	SetMapCachingThreadProgress (unsigned int index)
unsigned int	GetMapCachingThreadProgress ()
void	SetModCachingThreadProgress (unsigned int index)
unsigned int	GetModCachingThreadProgress ()
Servers

void	ConvertOldServerSettings ()
	convert old server settings format
wxString	GetDefaultServer ()
	Get the name/alias of the default server.
void	SetDefaultServer (const wxString &server_name)
	Set the name/alias of the default server.
void	SetAutoConnect (bool do_autoconnect)
bool	GetAutoConnect ()
wxString	GetServerHost (const wxString &server_name)
	Get hostname of a server.
int	GetServerPort (const wxString &server_name)
	Get port number of a server.
wxArrayString	GetServers ()
	Get list of server aliases.
bool	ServerExists (const wxString &server_name)
	Checks if the server name/alias exists in the settings.
void	SetServer (const wxString &server_name, const wxString &url, int port)
	Set hostname of a server.
void	DeleteServer (const wxString &server_name)
	Deletes a server from the list.
bool	ShouldAddDefaultServerSettings ()
Accounts

wxString	GetServerAccountNick (const wxString &server_name)
	Get nickname of the default account for a server.
void	SetServerAccountNick (const wxString &server_name, const wxString &value)
	Set nickname of the default account for a server.
wxString	GetServerAccountPass (const wxString &server_name)
	Get password of the default account for a server.
void	SetServerAccountPass (const wxString &server_name, const wxString &value)
	Set password of the default account for a server.
bool	GetServerAccountSavePass (const wxString &server_name)
	Get if the password should be saved for a default server account.
void	SetServerAccountSavePass (const wxString &server_name, const bool value)
	Set if the password should be saved for a default server account.
Automatic channel join list
These functions are used to manipulate the list of channels that SpringLobby should join upon connecting to a server.
int	GetNumChannelsJoin ()
	Fetch the number of channels in the autojoin list.
void	AddChannelJoin (const wxString &channel, const wxString &key)
	Add a channel to the autojoin list.
void	RemoveChannelJoin (const wxString &channel)
	Remove a channel from the autojoin list.
std::vector< ChannelJoinInfo >	GetChannelsJoin ()
	Returns the list of channels to autojoin.
void	RemoveAllChannelsJoin ()
	Deletes all autojoined channels.
int	GetChannelJoinIndex (const wxString &name)
	Returns the join order of a channel.
void	ConvertOldChannelSettings ()
bool	ShouldAddDefaultChannelSettings ()
People/Group management

void	SetPeopleList (const wxArrayString &friends, const wxString &group=_T("default"))
wxArrayString	GetPeopleList (const wxString &group=_T("default")) const
wxArrayString	GetGroups ()
void	AddGroup (const wxString &group)
void	DeleteGroup (const wxString &group)
void	SetGroupHLColor (const wxColour &color, const wxString &group=_T("default"))
wxColour	GetGroupHLColor (const wxString &group=_T("default")) const
void	SetGroupActions (const wxString &group, UserActions::ActionType action)
UserActions::ActionType	GetGroupActions (const wxString &group) const
bool	ShouldAddDefaultGroupSettings ()
Spring locations

void	ConvertOldSpringDirsOptions ()
void	RefreshSpringVersionList ()
std::map< wxString, wxString >	GetSpringVersionList () const
wxString	GetCurrentUsedSpringIndex ()
	index -> version
void	SetUsedSpringIndex (const wxString &index)
void	DeleteSpringVersionbyIndex (const wxString &index)
void	SetSearchSpringOnlyInSLPath (bool value)
	when this mode is enabled in windows SL will search for spring files only in the current executable folder
bool	GetSearchSpringOnlyInSLPath ()
bool	GetBundleMode ()
	if false, lobby tries to load spring & unitsync as sep paths, otherwise, searches for a bundle containing both
bool	IsInsideSpringBundle ()
bool	GetUseSpringPathFromBundle ()
void	SetUseSpringPathFromBundle (bool value)
wxString	GetCurrentUsedUikeys ()
	convenience wrappers to get current used version paths
wxString	GetCurrentUsedDataDir ()
wxString	GetCurrentUsedUnitSync ()
wxString	GetCurrentUsedBundle ()
wxString	GetCurrentUsedSpringBinary ()
wxString	GetCurrentUsedSpringConfigFilePath ()
	returns config file path unitsync uses, returns empty if unitsync isn't loaded
wxString	GetUnitSync (const wxString &index)
wxString	GetSpringBinary (const wxString &index)
wxString	GetBundle (const wxString &index)
	meaningful only on mac
void	SetUnitSync (const wxString &index, const wxString &path)
void	SetSpringBinary (const wxString &index, const wxString &path)
void	SetBundle (const wxString &index, const wxString &path)
	meaningful only on mac
wxString	AutoFindSpringBin ()
wxString	AutoFindUnitSync (wxPathList pl=PathlistFactory::ConfigFileSearchPaths()) const
wxString	AutoFindBundle ()
wxString	AutoFindUikeys ()
wxString	GetForcedSpringConfigFilePath ()
	returns config file path spring should use, returns empty for default
void	SetForcedSpringConfigFilePath (const wxString &path)
	use in game customized mode or externally forced via cli arg
Chat

bool	GetChatLogEnable ()
void	SetChatLogEnable (const bool value)
wxString	GetChatLogLoc ()
void	SetChatLogLoc (const wxString &loc)
void	SetChatHistoryLenght (int historylines)
	sets how many lines can stay in a chat panel before the old will start getting erased, 0 to disable
int	GetChatHistoryLenght ()
void	SetChatPMSoundNotificationEnabled (bool enabled)
bool	GetChatPMSoundNotificationEnabled ()
void	ConvertOldColorSettings ()
wxColour	GetChatColorNormal ()
void	SetChatColorNormal (wxColour value)
wxColour	GetChatColorBackground ()
void	SetChatColorBackground (wxColour value)
wxColour	GetChatColorHighlight ()
void	SetChatColorHighlight (wxColour value)
wxColour	GetChatColorMine ()
void	SetChatColorMine (wxColour value)
wxColour	GetChatColorNotification ()
void	SetChatColorNotification (wxColour value)
wxColour	GetChatColorAction ()
void	SetChatColorAction (wxColour value)
wxColour	GetChatColorServer ()
void	SetChatColorServer (wxColour value)
wxColour	GetChatColorClient ()
void	SetChatColorClient (wxColour value)
wxColour	GetChatColorJoinPart ()
void	SetChatColorJoinPart (wxColour value)
wxColour	GetChatColorError ()
void	SetChatColorError (wxColour value)
wxColour	GetChatColorTime ()
void	SetChatColorTime (wxColour value)
wxFont	GetChatFont ()
void	SetChatFont (wxFont value)
void	SetDisplayJoinLeave (bool display, const wxString &channel)
bool	GetDisplayJoinLeave (const wxString &channel)
void	SetHighlightedWords (const wxArrayString &words)
wxArrayString	GetHighlightedWords ()
void	SetRequestAttOnHighlight (const bool req)
	controls if user attention is requested when highlighting a line
bool	GetRequestAttOnHighlight ()
Hosting
Settings to use when hosting games. Includes "sticky" settings from the last time a game was hosted.
wxString	GetLastHostDescription ()
wxString	GetLastHostMod ()
wxString	GetLastHostPassword ()
int	GetLastHostPort ()
int	GetLastHostPlayerNum ()
int	GetLastHostNATSetting ()
wxString	GetLastHostMap ()
int	GetLastRankLimit ()
bool	GetTestHostPort ()
bool	GetLastAutolockStatus ()
bool	GetLastHostRelayedMode ()
void	SetLastHostDescription (const wxString &value)
void	SetLastHostMod (const wxString &value)
void	SetLastHostPassword (const wxString &value)
void	SetLastHostPort (int value)
void	SetLastHostPlayerNum (int value)
void	SetLastHostNATSetting (int value)
void	SetLastHostMap (const wxString &value)
void	SetLastRankLimit (int rank)
void	SetTestHostPort (bool value)
void	SetLastAutolockStatus (bool value)
void	SetLastHostRelayedMode (bool value)
void	SetHostingPreset (const wxString &name, int optiontype, std::map< wxString, wxString > options)
std::map< wxString, wxString >	GetHostingPreset (const wxString &name, int optiontype)
wxArrayString	GetPresetList ()
void	DeletePreset (const wxString &name)
wxString	GetModDefaultPresetName (const wxString &modname)
void	SetModDefaultPresetName (const wxString &modname, const wxString &presetname)
Battle filters

BattleListFilterValues	GetBattleFilterValues (const wxString &profile_name=(_T("default")))
void	SetBattleFilterValues (const BattleListFilterValues &blfValues, const wxString &profile_name=_T("default"))
wxString	GetLastBattleFilterProfileName ()
void	SetBattleFilterActivState (const bool state)
bool	GetBattleFilterActivState () const
bool	GetBattleLastAutoStartState ()
void	SetBattleLastAutoStartState (bool value)
bool	GetBattleLastAutoControlState ()
void	SetBattleLastAutoControlState (bool value)
int	GetBattleLastAutoSpectTime ()
void	SetBattleLastAutoSpectTime (int value)
bool	GetBattleLastAutoAnnounceDescription ()
void	SetBattleLastAutoAnnounceDescription (bool value)
void	SetBattleLastSideSel (const wxString &modname, int sidenum)
int	GetBattleLastSideSel (const wxString &modname)
void	SetMapLastStartPosType (const wxString &mapname, const wxString &startpostype)
void	SetMapLastRectPreset (const wxString &mapname, std::vector< Settings::SettStartBox > rects)
wxString	GetMapLastStartPosType (const wxString &mapname)
std::vector < Settings::SettStartBox >	GetMapLastRectPreset (const wxString &mapname)
Replay filters

PlaybackListFilterValues	GetReplayFilterValues (const wxString &profile_name=(_T("default")))
void	SetReplayFilterValues (const PlaybackListFilterValues &blfValues, const wxString &profile_name=_T("default"))
wxString	GetLastReplayFilterProfileName ()
void	SetReplayFilterActivState (const bool state)
bool	GetReplayFilterActivState () const
Torrent System

unsigned int	GetTorrentPort ()
void	SetTorrentPort (unsigned int port)
int	GetTorrentUploadRate ()
void	SetTorrentUploadRate (int speed)
int	GetTorrentDownloadRate ()
void	SetTorrentDownloadRate (int speed)
int	GetTorrentSystemSuspendMode ()
void	SetTorrentSystemSuspendMode (int mode)
int	GetTorrentThrottledUploadRate ()
void	SetTorrentThrottledUploadRate (int speed)
int	GetTorrentThrottledDownloadRate ()
void	SetTorrentThrottledDownloadRate (int speed)
void	SetTorrentMaxConnections (int connections)
int	GetTorrentMaxConnections ()
void	SetTorrentListToResume (const std::vector< wxString > &list)
std::vector< wxString >	GetTorrentListToResume ()
void	ClearTorrentListToResume ()
wxFileName	GetTorrentDir ()
	Get the path to the directory where *.torrent files are stored.
wxFileName	GetTorrentDataDir ()
	Get the path to the directory where partially-downloaded torrented files are stored.
Aui
Functions used to store and retrieve the current SpringLobby interface layout.
void	SaveLayout (wxString &layout_name, wxString &layout_string)
wxString	GetLayout (wxString &layout_name)
void	SavePerspective (const wxString &notebook_name, const wxString &perspective_name, const wxString &layout_string)
wxString	LoadPerspective (const wxString &notebook_name, const wxString &perspective_name)
wxString	GetLastPerspectiveName ()
void	SetLastPerspectiveName (const wxString &name)
void	SetAutosavePerspective (bool autosave)
bool	GetAutosavePerspective ()
wxArrayString	GetPerspectives ()
bool	PerspectiveExists (const wxString &perspective_name)
bool	DoResetPerspectives ()
void	SetDoResetPerspectives (bool do_it)
void	RemoveLayouts ()
bool	GetUseTabIcons ()
	icons for mainwindow tabs??
void	SetUseTabIcons (bool use)
SpringSettings

long	getMode ()
	SpringSettings ///.
void	setMode (long)
bool	getDisableWarning ()
void	setDisableWarning (bool)
wxString	getSimpleRes ()
void	setSimpleRes (wxString)
wxString	getSimpleQuality ()
void	setSimpleQuality (wxString)
wxString	getSimpleDetail ()
void	setSimpleDetail (wxString)
Map selection dialog

unsigned int	GetVerticalSortkeyIndex ()
void	SetVerticalSortkeyIndex (const unsigned int idx)
unsigned int	GetHorizontalSortkeyIndex ()
void	SetHorizontalSortkeyIndex (const unsigned int idx)
bool	GetHorizontalSortorder ()
void	SetHorizontalSortorder (const bool order)
bool	GetVerticalSortorder ()
void	SetVerticalSortorder (const bool order)
void	SetMapSelectorFollowsMouse (bool value)
bool	GetMapSelectorFollowsMouse ()
unsigned int	GetMapSelectorFilterRadio ()
void	SetMapSelectorFilterRadio (const unsigned int val)
Relay Hosts

wxString	GetLastRelayedHost (void)
void	SetLastRelayedHost (wxString relhost)
Hotkeys

void	SetHotkeyMeta (const wxString &profileName, const wxString &keyStr)
wxString	GetHotkeyMeta (const wxString &profileName)
void	SetHotkeyKeySymSet (const wxString &profileName, const wxString &symName, const wxString &keyStr)
wxString	GetHotkeyKeySymSet (const wxString &profileName, const wxString &symName)
wxArrayString	GetHotkeyKeySymSetNames (const wxString &profileName)
void	SetHotkeyKeySym (const wxString &profileName, const wxString &symName, const wxString &keyStr)
wxString	GetHotkeyKeySym (const wxString &profileName, const wxString &symName)
wxArrayString	GetHotkeyKeySymNames (const wxString &profileName)
void	SetHotkey (const wxString &profileName, const wxString &command, const wxString &key, int orderIdx)
wxString	GetHotkey (const wxString &profileName, const wxString &orderIdx, const wxString &key)
wxArrayString	GetHotkeyProfiles ()
wxArrayString	GetHotkeyProfileOrderIndices (const wxString &profileName)
wxArrayString	GetHotkeyProfileCommandKeys (const wxString &profileName, const wxString &orderIdx)
void	DeleteHotkeyProfiles ()
wxString	GetUikeys (const wxString &index)
Static Public Attributes
static bool	m_user_defined_config = false
	used for passing config file at command line
static wxString	m_user_defined_config_path = wxEmptyString
Protected Member Functions
bool	IsSpringBin (const wxString &path)
Protected Attributes
slConfig *	m_config
	wxConfig object to store and restore all settings in.
wxString	m_chosen_path
wxString	m_forced_springconfig_path
bool	m_portable_mode
std::map< wxString, wxString >	m_spring_versions
wxString	m_final_config_path
UI

static const int	columnWidthUnset = -3
	used to signal unset column width in Get...
static const int	columnWidthMinimum = 5
void	SetStartTab (const int idx)
unsigned int	GetStartTab ()
void	SaveCustomColors (const wxColourData &cdata, const wxString &paletteName=_T("Default"))
wxColourData	GetCustomColors (const wxString &paletteName=_T("Default"))
int	GetWindowWidth (const wxString &window)
	Get width of MainWindow.
void	SetWindowWidth (const wxString &window, const int value)
	Set width position of MainWindow.
int	GetWindowHeight (const wxString &window)
	Get height of MainWindow.
void	SetWindowHeight (const wxString &window, const int value)
	Set height position of MainWindow.
int	GetWindowTop (const wxString &window)
	Get top position of MainWindow.
void	SetWindowTop (const wxString &window, const int value)
	Set top position of MainWindow.
int	GetWindowLeft (const wxString &window)
	Get left position of MainWindow.
void	SetWindowLeft (const wxString &window, const int value)
	Set left position of MainWindow.
wxSize	GetWindowSize (const wxString &window, const wxSize &def)
void	SetWindowSize (const wxString &window, const wxSize &size)
wxPoint	GetWindowPos (const wxString &window, const wxPoint &def)
void	SetWindowPos (const wxString &window, const wxPoint &pos)
bool	GetWindowMaximized (const wxString &window)
void	GetWindowMaximized (const wxString &window, bool maximized)
bool	UseOldSpringLaunchMethod ()
void	SetOldSpringLaunchMethod (bool value)
void	SetShowTooltips (bool show)
bool	GetShowTooltips ()
ColumnMap	GetColumnMap (const wxString &name)
void	GetColumnMap (const wxString &name, const ColumnMap &map)
SortOrder	GetSortOrder (const wxString &list_name)
void	SetSortOrder (const wxString &list_name, const SortOrder &order)
void	SetColumnWidth (const wxString &list_name, const int column_ind, const int column_width)
int	GetColumnWidth (const wxString &list_name, const int column)
void	NukeColumnWidths ()
void	SetLanguageID (const long id)
long	GetLanguageID ()
int	GetSashPosition (const wxString &window_name)
void	SetSashPosition (const wxString &window_name, const int pos)
bool	GetSplitBRoomHorizontally ()
void	SetSplitBRoomHorizontally (const bool vertical)
bool	GetShowXallTabs ()
void	SetShowXallTabs (bool show)
void	TranslateSavedColumWidths ()
	simply move saved col size +1 to account for dummy col, force dummy col width to 0
wxString	GetEditorPath ()
void	SetEditorPath (const wxString &path)
void	SetAutoloadedChatlogLinesCount (const int count)
int	GetAutoloadedChatlogLinesCount ()
void	SetUseNotificationPopups (const bool use)
bool	GetUseNotificationPopups ()
void	SetNotificationPopupPosition (const size_t index)
size_t	GetNotificationPopupPosition ()
void	SetNotificationPopupDisplayTime (const unsigned int seconds)
unsigned int	GetNotificationPopupDisplayTime ()

Detailed Description

Class used to store and restore application settings.

Definition at line 78 of file settings.h.

Member Enumeration Documentation

enum Settings::CompletionMethod

Enumerator:

MatchNearest
MatchExact

Definition at line 696 of file settings.h.

Constructor & Destructor Documentation

Settings::Settings ( )

Default constructor.

Definition at line 70 of file settings.cpp.

Settings::~Settings ( )

Definition at line 128 of file settings.cpp.

Member Function Documentation

void Settings::AddChannelJoin	(	const wxString &	channel,
		const wxString &	key
	)

Add a channel to the autojoin list.

Definition at line 549 of file settings.cpp.

void Settings::AddGroup ( const wxString & group )

Definition at line 1941 of file settings.cpp.

wxString Settings::AutoFindBundle ( )

Definition at line 751 of file settings.cpp.

wxString Settings::AutoFindSpringBin ( )

Definition at line 731 of file settings.cpp.

wxString Settings::AutoFindUikeys ( )

Definition at line 757 of file settings.cpp.

wxString Settings::AutoFindUnitSync ( wxPathList pl = PathlistFactory::ConfigFileSearchPaths() ) const

Definition at line 743 of file settings.cpp.

void Settings::ClearTorrentListToResume ( )

Definition at line 1830 of file settings.cpp.

void Settings::ConvertOldChannelSettings ( )

Definition at line 602 of file settings.cpp.

void Settings::ConvertOldColorSettings ( )

Definition at line 1322 of file settings.cpp.

void Settings::ConvertOldHiglightSettings ( )

Definition at line 1509 of file settings.cpp.

void Settings::ConvertOldServerSettings ( )

convert old server settings format

Definition at line 366 of file settings.cpp.

void Settings::ConvertOldSpringDirsOptions ( )

Definition at line 764 of file settings.cpp.

void Settings::DeleteGroup ( const wxString & group )

Definition at line 1952 of file settings.cpp.

void Settings::DeleteHotkeyProfiles ( )

Definition at line 2583 of file settings.cpp.

void Settings::DeletePreset ( const wxString & name )

Definition at line 1167 of file settings.cpp.

void Settings::DeleteServer ( const wxString & server_name )

Deletes a server from the list.

Parameters:

server_name

the server name/alias

Definition at line 462 of file settings.cpp.

void Settings::DeleteSpringVersionbyIndex ( const wxString & index )

Definition at line 826 of file settings.cpp.

bool Settings::DoResetPerspectives ( )

Definition at line 2496 of file settings.cpp.

wxString Settings::FinalConfigPath ( ) const [inline]

Definition at line 798 of file settings.h.

template<class T >

T Settings::Get	(	wxString	setting,
		const T	def
	)			`[inline]`

you are absolutely forbidden to use this

Definition at line 783 of file settings.h.

bool Settings::GetAlwaysAutoScrollOnFocusLost ( )

Definition at line 1499 of file settings.cpp.

bool Settings::GetAutoConnect ( )

Definition at line 422 of file settings.cpp.

int Settings::GetAutoloadedChatlogLinesCount ( )

Definition at line 2451 of file settings.cpp.

bool Settings::GetAutosavePerspective ( )

Definition at line 2415 of file settings.cpp.

bool Settings::GetAutoUpdate ( )

Definition at line 2060 of file settings.cpp.

bool Settings::GetBalanceClans ( )

Definition at line 1207 of file settings.cpp.

int Settings::GetBalanceGrouping ( )

Definition at line 1227 of file settings.cpp.

int Settings::GetBalanceMethod ( )

Definition at line 1198 of file settings.cpp.

bool Settings::GetBalanceStrongClans ( )

Definition at line 1217 of file settings.cpp.

bool Settings::GetBattleFilterActivState ( ) const

Definition at line 1602 of file settings.cpp.

BattleListFilterValues Settings::GetBattleFilterValues ( const wxString & profile_name = (_T("default")) )

Definition at line 1551 of file settings.cpp.

bool Settings::GetBattleLastAutoAnnounceDescription ( )

Definition at line 1642 of file settings.cpp.

bool Settings::GetBattleLastAutoControlState ( )

Definition at line 1622 of file settings.cpp.

int Settings::GetBattleLastAutoSpectTime ( )

Definition at line 1632 of file settings.cpp.

bool Settings::GetBattleLastAutoStartState ( )

Definition at line 1612 of file settings.cpp.

wxColour Settings::GetBattleLastColour ( )

Definition at line 1056 of file settings.cpp.

int Settings::GetBattleLastSideSel ( const wxString & modname )

Definition at line 1657 of file settings.cpp.

bool Settings::GetBroadcastEverywhere ( )

Definition at line 2506 of file settings.cpp.

wxString Settings::GetBundle ( const wxString & index )

meaningful only on mac

Definition at line 936 of file settings.cpp.

bool Settings::GetBundleMode ( )

if false, lobby tries to load spring & unitsync as sep paths, otherwise, searches for a bundle containing both

Definition at line 838 of file settings.cpp.

wxString Settings::GetCachePath ( )

Definition at line 296 of file settings.cpp.

int Settings::GetCacheVersion ( )

returns the cache versioning number, do decide whenever to delete if becomes obsolete & incompatible with new versions

Definition at line 320 of file settings.cpp.

int Settings::GetChannelJoinIndex ( const wxString & name )

Returns the join order of a channel.

Returns:: the order of the channel during autojoin or -1 if not found

Definition at line 573 of file settings.cpp.

std::vector< ChannelJoinInfo > Settings::GetChannelsJoin ( )

Returns the list of channels to autojoin.

Returns:: std::vector of ChannelJoinInfo struct, don't break ordering index!

Definition at line 584 of file settings.cpp.

wxColour Settings::GetChatColorAction ( )

Definition at line 1410 of file settings.cpp.

wxColour Settings::GetChatColorBackground ( )

Definition at line 1370 of file settings.cpp.

wxColour Settings::GetChatColorClient ( )

Definition at line 1430 of file settings.cpp.

wxColour Settings::GetChatColorError ( )

Definition at line 1450 of file settings.cpp.

wxColour Settings::GetChatColorHighlight ( )

Definition at line 1380 of file settings.cpp.

wxColour Settings::GetChatColorJoinPart ( )

Definition at line 1440 of file settings.cpp.

wxColour Settings::GetChatColorMine ( )

Definition at line 1390 of file settings.cpp.

wxColour Settings::GetChatColorNormal ( )

Definition at line 1359 of file settings.cpp.

wxColour Settings::GetChatColorNotification ( )

Definition at line 1400 of file settings.cpp.

wxColour Settings::GetChatColorServer ( )

Definition at line 1420 of file settings.cpp.

wxColour Settings::GetChatColorTime ( )

Definition at line 1460 of file settings.cpp.

wxFont Settings::GetChatFont ( )

Definition at line 1470 of file settings.cpp.

int Settings::GetChatHistoryLenght ( )

Definition at line 1294 of file settings.cpp.

bool Settings::GetChatLogEnable ( )

Definition at line 971 of file settings.cpp.

wxString Settings::GetChatLogLoc ( )

Definition at line 984 of file settings.cpp.

bool Settings::GetChatPMSoundNotificationEnabled ( )

Definition at line 1306 of file settings.cpp.

int Settings::GetClientPort ( )

Definition at line 245 of file settings.cpp.

void Settings::GetColumnMap	(	const wxString &	name,
		const ColumnMap &	map
	)

ColumnMap Settings::GetColumnMap ( const wxString & name )

int Settings::GetColumnWidth	(	const wxString &	list_name,
		const int	column
	)

Definition at line 1889 of file settings.cpp.

Settings::CompletionMethod Settings::GetCompletionMethod ( ) const

Definition at line 2123 of file settings.cpp.

wxString Settings::GetCurrentUsedBundle ( )

Definition at line 900 of file settings.cpp.

wxString Settings::GetCurrentUsedDataDir ( )

Definition at line 861 of file settings.cpp.

wxString Settings::GetCurrentUsedSpringBinary ( )

Definition at line 884 of file settings.cpp.

wxString Settings::GetCurrentUsedSpringConfigFilePath ( )

returns config file path unitsync uses, returns empty if unitsync isn't loaded

Definition at line 912 of file settings.cpp.

wxString Settings::GetCurrentUsedSpringIndex ( )

index -> version

Definition at line 802 of file settings.cpp.

wxString Settings::GetCurrentUsedUikeys ( )

convenience wrappers to get current used version paths

Definition at line 905 of file settings.cpp.

wxString Settings::GetCurrentUsedUnitSync ( )

Definition at line 892 of file settings.cpp.

wxColourData Settings::GetCustomColors ( const wxString & paletteName = _T("Default") )

Definition at line 2028 of file settings.cpp.

wxString Settings::GetDefaultServer ( )

Get the name/alias of the default server.

Note:: Normally this will be the previously selected server. But at first run it will be a server that is set as the default.

Definition at line 411 of file settings.cpp.

bool Settings::GetDisableSpringVersionCheck ( )

Definition at line 1707 of file settings.cpp.

bool Settings::getDisableWarning ( )

Definition at line 2204 of file settings.cpp.

bool Settings::GetDisplayJoinLeave ( const wxString & channel )

Definition at line 1282 of file settings.cpp.

wxString Settings::GetEditorPath ( )

Definition at line 2361 of file settings.cpp.

wxArrayString Settings::GetEntryList ( const wxString & base_key )

list all groups subkeys of a parent group

Definition at line 164 of file settings.cpp.

bool Settings::GetFixIDClans ( )

Definition at line 1246 of file settings.cpp.

int Settings::GetFixIDGrouping ( )

Definition at line 1266 of file settings.cpp.

int Settings::GetFixIDMethod ( )

Definition at line 1237 of file settings.cpp.

bool Settings::GetFixIDStrongClans ( )

Definition at line 1256 of file settings.cpp.

wxString Settings::GetForcedSpringConfigFilePath ( )

returns config file path spring should use, returns empty for default

Definition at line 961 of file settings.cpp.

UserActions::ActionType Settings::GetGroupActions ( const wxString & group ) const

Definition at line 1976 of file settings.cpp.

unsigned int Settings::GetGroupCount ( const wxString & base_key )

counts all groups subkeys of a parent group

Definition at line 179 of file settings.cpp.

wxColour Settings::GetGroupHLColor ( const wxString & group = _T("default") ) const

Definition at line 1931 of file settings.cpp.

wxArrayString Settings::GetGroupList ( const wxString & base_key )

list all entries subkeys of a parent group

Definition at line 149 of file settings.cpp.

wxArrayString Settings::GetGroups ( )

Definition at line 1936 of file settings.cpp.

wxArrayString Settings::GetHighlightedWords ( )

Definition at line 1536 of file settings.cpp.

unsigned int Settings::GetHorizontalSortkeyIndex ( )

Definition at line 2129 of file settings.cpp.

bool Settings::GetHorizontalSortorder ( )

Returns:: true for "<" false for ">"

Definition at line 2149 of file settings.cpp.

std::map< wxString, wxString > Settings::GetHostingPreset	(	const wxString &	name,
		int	optiontype
	)

Definition at line 1142 of file settings.cpp.

wxString Settings::GetHotkey	(	const wxString &	profileName,
		const wxString &	orderIdx,
		const wxString &	key
	)

Definition at line 2563 of file settings.cpp.

wxString Settings::GetHotkeyKeySym	(	const wxString &	profileName,
		const wxString &	symName
	)

Definition at line 2547 of file settings.cpp.

wxArrayString Settings::GetHotkeyKeySymNames ( const wxString & profileName )

Definition at line 2552 of file settings.cpp.

wxString Settings::GetHotkeyKeySymSet	(	const wxString &	profileName,
		const wxString &	symName
	)

Definition at line 2532 of file settings.cpp.

wxArrayString Settings::GetHotkeyKeySymSetNames ( const wxString & profileName )

Definition at line 2537 of file settings.cpp.

wxString Settings::GetHotkeyMeta ( const wxString & profileName )

Definition at line 2522 of file settings.cpp.

wxArrayString Settings::GetHotkeyProfileCommandKeys	(	const wxString &	profileName,
		const wxString &	orderIdx
	)

Definition at line 2578 of file settings.cpp.

wxArrayString Settings::GetHotkeyProfileOrderIndices ( const wxString & profileName )

Definition at line 2573 of file settings.cpp.

wxArrayString Settings::GetHotkeyProfiles ( )

Definition at line 2568 of file settings.cpp.

long Settings::GetLanguageID ( )

Definition at line 2262 of file settings.cpp.

wxString Settings::GetLastAI ( )

Definition at line 1272 of file settings.cpp.

bool Settings::GetLastAutolockStatus ( )

Definition at line 1046 of file settings.cpp.

wxString Settings::GetLastBattleFilterProfileName ( )

Definition at line 1714 of file settings.cpp.

wxString Settings::GetLastHostDescription ( )

Definition at line 995 of file settings.cpp.

wxString Settings::GetLastHostMap ( )

Definition at line 1031 of file settings.cpp.

wxString Settings::GetLastHostMod ( )

Definition at line 1001 of file settings.cpp.

int Settings::GetLastHostNATSetting ( )

Definition at line 1025 of file settings.cpp.

wxString Settings::GetLastHostPassword ( )

Definition at line 1007 of file settings.cpp.

int Settings::GetLastHostPlayerNum ( )

Definition at line 1019 of file settings.cpp.

int Settings::GetLastHostPort ( )

Definition at line 1013 of file settings.cpp.

bool Settings::GetLastHostRelayedMode ( )

Definition at line 1051 of file settings.cpp.

wxString Settings::GetLastPerspectiveName ( )

Definition at line 2400 of file settings.cpp.

int Settings::GetLastRankLimit ( )

Definition at line 1036 of file settings.cpp.

wxString Settings::GetLastRelayedHost ( void )

Definition at line 2111 of file settings.cpp.

wxString Settings::GetLastReplayFilterProfileName ( )

Definition at line 2107 of file settings.cpp.

wxString Settings::GetLayout ( wxString & layout_name )

wxString Settings::GetLobbyWriteDir ( )

Definition at line 214 of file settings.cpp.

unsigned int Settings::GetMapCachingThreadProgress ( )

Definition at line 332 of file settings.cpp.

std::vector< Settings::SettStartBox > Settings::GetMapLastRectPreset ( const wxString & mapname )

Definition at line 1688 of file settings.cpp.

wxString Settings::GetMapLastStartPosType ( const wxString & mapname )

Definition at line 1683 of file settings.cpp.

unsigned int Settings::GetMapSelectorFilterRadio ( )

Returns:: m_filter_all_sett = 0; (default) m_filter_recent_sett = 1; m_filter_popular_sett = 2;

Definition at line 2179 of file settings.cpp.

bool Settings::GetMapSelectorFollowsMouse ( )

Definition at line 2174 of file settings.cpp.

unsigned int Settings::GetModCachingThreadProgress ( )

Definition at line 344 of file settings.cpp.

wxString Settings::GetModDefaultPresetName ( const wxString & modname )

Definition at line 1182 of file settings.cpp.

long Settings::getMode ( )

SpringSettings ///.

Definition at line 2194 of file settings.cpp.

unsigned int Settings::GetNotificationPopupDisplayTime ( )

Definition at line 2491 of file settings.cpp.

size_t Settings::GetNotificationPopupPosition ( )

Definition at line 2471 of file settings.cpp.

bool Settings::GetNoUDP ( )

Definition at line 235 of file settings.cpp.

int Settings::GetNumChannelsJoin ( )

Fetch the number of channels in the autojoin list.

Definition at line 544 of file settings.cpp.

wxArrayString Settings::GetPeopleList ( const wxString & group = _T("default") ) const

Definition at line 1913 of file settings.cpp.

wxArrayString Settings::GetPerspectives ( )

Definition at line 2420 of file settings.cpp.

wxArrayString Settings::GetPresetList ( )

Definition at line 1161 of file settings.cpp.

bool Settings::GetReplayFilterActivState ( ) const

Definition at line 2097 of file settings.cpp.

PlaybackListFilterValues Settings::GetReplayFilterValues ( const wxString & profile_name = (_T("default")) )

Definition at line 2065 of file settings.cpp.

bool Settings::GetReportStats ( )

Definition at line 2042 of file settings.cpp.

bool Settings::GetRequestAttOnHighlight ( )

Definition at line 1546 of file settings.cpp.

int Settings::GetSashPosition ( const wxString & window_name )

Definition at line 2301 of file settings.cpp.

bool Settings::GetSearchSpringOnlyInSLPath ( )

Definition at line 813 of file settings.cpp.

wxString Settings::GetServerAccountNick ( const wxString & server_name )

Get nickname of the default account for a server.

Parameters:

server_name

the server name/alias

Definition at line 486 of file settings.cpp.

wxString Settings::GetServerAccountPass ( const wxString & server_name )

Get password of the default account for a server.

Parameters:

server_name

the server name/alias

Todo:: Implement

Definition at line 506 of file settings.cpp.

bool Settings::GetServerAccountSavePass ( const wxString & server_name )

Get if the password should be saved for a default server account.

Parameters:

server_name

the server name/alias

Todo:: Implement

Definition at line 527 of file settings.cpp.

wxString Settings::GetServerHost ( const wxString & server_name )

Get hostname of a server.

Parameters:

server_name

the server name/alias

Definition at line 441 of file settings.cpp.

int Settings::GetServerPort ( const wxString & server_name )

Get port number of a server.

Parameters:

server_name

the server name/alias

Definition at line 471 of file settings.cpp.

wxArrayString Settings::GetServers ( )

Get list of server aliases.

Definition at line 477 of file settings.cpp.

int Settings::GetSettingsVersion ( )

Definition at line 208 of file settings.cpp.

bool Settings::GetShowIPAddresses ( )

Definition at line 255 of file settings.cpp.

bool Settings::GetShowTooltips ( )

Definition at line 1872 of file settings.cpp.

bool Settings::GetShowXallTabs ( )

Definition at line 2378 of file settings.cpp.

wxString Settings::getSimpleDetail ( )

Definition at line 2238 of file settings.cpp.

wxString Settings::getSimpleQuality ( )

Definition at line 2226 of file settings.cpp.

wxString Settings::getSimpleRes ( )

Definition at line 2215 of file settings.cpp.

bool Settings::GetSmartScrollEnabled ( )

Definition at line 1490 of file settings.cpp.

SortOrder Settings::GetSortOrder ( const wxString & list_name )

Definition at line 2267 of file settings.cpp.

bool Settings::GetSplitBRoomHorizontally ( )

Definition at line 2311 of file settings.cpp.

wxString Settings::GetSpringBinary ( const wxString & index )

Definition at line 930 of file settings.cpp.

std::map< wxString, wxString > Settings::GetSpringVersionList ( ) const

Definition at line 778 of file settings.cpp.

unsigned int Settings::GetStartTab ( )

Definition at line 2326 of file settings.cpp.

wxString Settings::GetTempStorage ( )

Definition at line 1861 of file settings.cpp.

bool Settings::GetTestHostPort ( )

Definition at line 1041 of file settings.cpp.

wxFileName Settings::GetTorrentDataDir ( )

Get the path to the directory where partially-downloaded torrented files are stored.

See also:: GetTorrentsFolder

Definition at line 1848 of file settings.cpp.

wxFileName Settings::GetTorrentDir ( )

Get the path to the directory where *.torrent files are stored.

Definition at line 1835 of file settings.cpp.

int Settings::GetTorrentDownloadRate ( )

Definition at line 1744 of file settings.cpp.

std::vector< wxString > Settings::GetTorrentListToResume ( )

Definition at line 1816 of file settings.cpp.

int Settings::GetTorrentMaxConnections ( )

Definition at line 1800 of file settings.cpp.

unsigned int Settings::GetTorrentPort ( )

Definition at line 1720 of file settings.cpp.

int Settings::GetTorrentSystemSuspendMode ( )

Definition at line 1757 of file settings.cpp.

int Settings::GetTorrentThrottledDownloadRate ( )

Definition at line 1782 of file settings.cpp.

int Settings::GetTorrentThrottledUploadRate ( )

Definition at line 1770 of file settings.cpp.

int Settings::GetTorrentUploadRate ( )

Definition at line 1732 of file settings.cpp.

wxString Settings::GetUikeys ( const wxString & index )

Definition at line 2589 of file settings.cpp.

wxString Settings::GetUnitSync ( const wxString & index )

Definition at line 923 of file settings.cpp.

bool Settings::GetUseIrcColors ( )

Definition at line 1519 of file settings.cpp.

bool Settings::GetUseNotificationPopups ( )

Definition at line 2461 of file settings.cpp.

bool Settings::GetUseSpringPathFromBundle ( )

Definition at line 847 of file settings.cpp.

bool Settings::GetUseTabIcons ( )

icons for mainwindow tabs??

Definition at line 2291 of file settings.cpp.

unsigned int Settings::GetVerticalSortkeyIndex ( )

Definition at line 2139 of file settings.cpp.

bool Settings::GetVerticalSortorder ( )

Returns:: true for "ᴧ", false for "ᴠ"

Definition at line 2159 of file settings.cpp.

wxString Settings::GetWebBrowserPath ( )

Get the path to the user-configured browser.

Returns:: The user-defined browser path, if set, otherwise an empty string (wxEmptyString).

Definition at line 284 of file settings.cpp.

bool Settings::GetWebBrowserUseDefault ( )

Fetch the "Use Default" setting for the web browser.

Returns:: the current setting.

Definition at line 271 of file settings.cpp.

int Settings::GetWindowHeight ( const wxString & window )

Get height of MainWindow.

Definition at line 642 of file settings.cpp.

int Settings::GetWindowLeft ( const wxString & window )

Get left position of MainWindow.

Definition at line 682 of file settings.cpp.

void Settings::GetWindowMaximized	(	const wxString &	window,
		bool	maximized
	)

Definition at line 2481 of file settings.cpp.

bool Settings::GetWindowMaximized ( const wxString & window )

Definition at line 2476 of file settings.cpp.

wxPoint Settings::GetWindowPos	(	const wxString &	window,
		const wxPoint &	def
	)

Definition at line 715 of file settings.cpp.

wxSize Settings::GetWindowSize	(	const wxString &	window,
		const wxSize &	def
	)

Definition at line 700 of file settings.cpp.

int Settings::GetWindowTop ( const wxString & window )

Get top position of MainWindow.

Definition at line 662 of file settings.cpp.

int Settings::GetWindowWidth ( const wxString & window )

Get width of MainWindow.

Definition at line 622 of file settings.cpp.

wxString Settings::GlobalConfigPath ( ) const [inline]

Definition at line 797 of file settings.h.

bool Settings::IgnoreOfferfile ( )

Definition at line 2596 of file settings.cpp.

bool Settings::IsFirstRun ( )

Definition at line 196 of file settings.cpp.

bool Settings::IsInsideSpringBundle ( )

Definition at line 833 of file settings.cpp.

bool Settings::IsPortableMode ( ) const

Definition at line 185 of file settings.cpp.

bool Settings::IsSelfUpdateDisabled ( )

Definition at line 2601 of file settings.cpp.

bool Settings::IsSpringBin ( const wxString & path ) [protected]

Definition at line 2250 of file settings.cpp.

wxString Settings::LoadPerspective	(	const wxString &	notebook_name,
		const wxString &	perspective_name
	)

Definition at line 2394 of file settings.cpp.

void Settings::NukeColumnWidths ( )

Definition at line 1898 of file settings.cpp.

bool Settings::PerspectiveExists ( const wxString & perspective_name )

Definition at line 2436 of file settings.cpp.

void Settings::RefreshSpringVersionList ( )

Definition at line 783 of file settings.cpp.

void Settings::RemoveAllChannelsJoin ( )

Deletes all autojoined channels.

Definition at line 567 of file settings.cpp.

void Settings::RemoveChannelJoin ( const wxString & channel )

Remove a channel from the autojoin list.

Parameters:

channel

The name of the channel to remove

Definition at line 558 of file settings.cpp.

void Settings::RemoveLayouts ( )

Definition at line 1877 of file settings.cpp.

void Settings::SaveCustomColors	(	const wxColourData &	cdata,
		const wxString &	paletteName = `_T("Default")`
	)

Definition at line 2015 of file settings.cpp.

void Settings::SaveLayout	(	wxString &	layout_name,
		wxString &	layout_string
	)

void Settings::SavePerspective	(	const wxString &	notebook_name,
		const wxString &	perspective_name,
		const wxString &	layout_string
	)

Definition at line 2388 of file settings.cpp.

void Settings::SaveSettings ( )

Saves the settings to file.

Definition at line 133 of file settings.cpp.

bool Settings::ServerExists ( const wxString & server_name )

Checks if the server name/alias exists in the settings.

Definition at line 402 of file settings.cpp.

template<class T >

bool Settings::Set	(	wxString	setting,
		const T	val
	)			`[inline]`

Definition at line 788 of file settings.h.

void Settings::SetAlwaysAutoScrollOnFocusLost ( bool value )

Definition at line 1504 of file settings.cpp.

void Settings::SetAutoConnect ( bool do_autoconnect )

Definition at line 417 of file settings.cpp.

void Settings::SetAutoloadedChatlogLinesCount ( const int count )

Definition at line 2446 of file settings.cpp.

void Settings::SetAutosavePerspective ( bool autosave )

Definition at line 2410 of file settings.cpp.

void Settings::SetAutoUpdate ( const bool value )

Definition at line 2054 of file settings.cpp.

void Settings::SetBalanceClans ( bool value )

Definition at line 1203 of file settings.cpp.

void Settings::SetBalanceGrouping ( int value )

Definition at line 1222 of file settings.cpp.

void Settings::SetBalanceMethod ( int value )

Definition at line 1194 of file settings.cpp.

void Settings::SetBalanceStrongClans ( bool value )

Definition at line 1212 of file settings.cpp.

void Settings::SetBattleFilterActivState ( const bool state )

Definition at line 1607 of file settings.cpp.

void Settings::SetBattleFilterValues	(	const BattleListFilterValues &	blfValues,
		const wxString &	profile_name = `_T("default")`
	)

Definition at line 1577 of file settings.cpp.

void Settings::SetBattleLastAutoAnnounceDescription ( bool value )

Definition at line 1647 of file settings.cpp.

void Settings::SetBattleLastAutoControlState ( bool value )

Definition at line 1627 of file settings.cpp.

void Settings::SetBattleLastAutoSpectTime ( int value )

Definition at line 1637 of file settings.cpp.

void Settings::SetBattleLastAutoStartState ( bool value )

Definition at line 1617 of file settings.cpp.

void Settings::SetBattleLastColour ( const wxColour & col )

Definition at line 1062 of file settings.cpp.

void Settings::SetBattleLastSideSel	(	const wxString &	modname,
		int	sidenum
	)

Definition at line 1652 of file settings.cpp.

void Settings::SetBroadcastEverywhere ( bool value )

Definition at line 2511 of file settings.cpp.

void Settings::SetBundle	(	const wxString &	index,
		const wxString &	path
	)

meaningful only on mac

Definition at line 951 of file settings.cpp.

void Settings::SetCacheVersion ( )

sets version number for the cache, needed to nuke it in case it becomes obsolete & incompatible with new versions

Definition at line 313 of file settings.cpp.

void Settings::SetChatColorAction ( wxColour value )

Definition at line 1415 of file settings.cpp.

void Settings::SetChatColorBackground ( wxColour value )

Definition at line 1375 of file settings.cpp.

void Settings::SetChatColorClient ( wxColour value )

Definition at line 1435 of file settings.cpp.

void Settings::SetChatColorError ( wxColour value )

Definition at line 1455 of file settings.cpp.

void Settings::SetChatColorHighlight ( wxColour value )

Definition at line 1385 of file settings.cpp.

void Settings::SetChatColorJoinPart ( wxColour value )

Definition at line 1445 of file settings.cpp.

void Settings::SetChatColorMine ( wxColour value )

Definition at line 1395 of file settings.cpp.

void Settings::SetChatColorNormal ( wxColour value )

Definition at line 1364 of file settings.cpp.

void Settings::SetChatColorNotification ( wxColour value )

Definition at line 1405 of file settings.cpp.

void Settings::SetChatColorServer ( wxColour value )

Definition at line 1425 of file settings.cpp.

void Settings::SetChatColorTime ( wxColour value )

Definition at line 1465 of file settings.cpp.

void Settings::SetChatFont ( wxFont value )

Definition at line 1484 of file settings.cpp.

void Settings::SetChatHistoryLenght ( int historylines )

sets how many lines can stay in a chat panel before the old will start getting erased, 0 to disable

Definition at line 1288 of file settings.cpp.

void Settings::SetChatLogEnable ( const bool value )

Definition at line 978 of file settings.cpp.

void Settings::SetChatLogLoc ( const wxString & loc )

void Settings::SetChatPMSoundNotificationEnabled ( bool enabled )

Definition at line 1300 of file settings.cpp.

void Settings::SetClientPort ( int value )

use zero to pick port automatically, nonzero to override. This allows to play if you have broken router, by setting SourcePort to some forwarded port.

Definition at line 250 of file settings.cpp.

void Settings::SetColumnWidth	(	const wxString &	list_name,
		const int	column_ind,
		const int	column_width
	)

Definition at line 1884 of file settings.cpp.

void Settings::SetCompletionMethod ( CompletionMethod method )

Definition at line 2119 of file settings.cpp.

void Settings::SetDefaultServer ( const wxString & server_name )

Set the name/alias of the default server.

Parameters:

server_name

the server name/alias

See also:: GetDefaultServer()

Definition at line 432 of file settings.cpp.

void Settings::SetDefaultServerSettings ( )

Initialize all settings to default.

Restores default settings.

Definition at line 355 of file settings.cpp.

void Settings::setDisableWarning ( bool disable )

Definition at line 2209 of file settings.cpp.

void Settings::SetDisplayJoinLeave	(	bool	display,
		const wxString &	channel
	)

Definition at line 1277 of file settings.cpp.

void Settings::SetDoResetPerspectives ( bool do_it )

Definition at line 2501 of file settings.cpp.

void Settings::SetEditorPath ( const wxString & path )

Definition at line 2373 of file settings.cpp.

void Settings::SetFixIDClans ( bool value )

Definition at line 1242 of file settings.cpp.

void Settings::SetFixIDGrouping ( int value )

Definition at line 1261 of file settings.cpp.

void Settings::SetFixIDMethod ( int value )

Definition at line 1233 of file settings.cpp.

void Settings::SetFixIDStrongClans ( bool value )

Definition at line 1251 of file settings.cpp.

void Settings::SetForcedSpringConfigFilePath ( const wxString & path )

use in game customized mode or externally forced via cli arg

Definition at line 956 of file settings.cpp.

void Settings::SetGroupActions	(	const wxString &	group,
		UserActions::ActionType	action
	)

Definition at line 1960 of file settings.cpp.

void Settings::SetGroupHLColor	(	const wxColour &	color,
		const wxString &	group = `_T("default")`
	)

Definition at line 1926 of file settings.cpp.

void Settings::SetHighlightedWords ( const wxArrayString & words )

Definition at line 1525 of file settings.cpp.

void Settings::SetHorizontalSortkeyIndex ( const unsigned int idx )

Definition at line 2134 of file settings.cpp.

void Settings::SetHorizontalSortorder ( const bool order )

Definition at line 2154 of file settings.cpp.

void Settings::SetHostingPreset	(	const wxString &	name,
		int	optiontype,
		std::map< wxString, wxString >	options
	)

Definition at line 1133 of file settings.cpp.

void Settings::SetHotkey	(	const wxString &	profileName,
		const wxString &	command,
		const wxString &	key,
		int	orderIdx
	)

Definition at line 2558 of file settings.cpp.

void Settings::SetHotkeyKeySym	(	const wxString &	profileName,
		const wxString &	symName,
		const wxString &	keyStr
	)

Definition at line 2542 of file settings.cpp.

void Settings::SetHotkeyKeySymSet	(	const wxString &	profileName,
		const wxString &	symName,
		const wxString &	keyStr
	)

Definition at line 2527 of file settings.cpp.

void Settings::SetHotkeyMeta	(	const wxString &	profileName,
		const wxString &	keyStr
	)

Definition at line 2517 of file settings.cpp.

void Settings::SetLanguageID ( const long id )

Definition at line 2257 of file settings.cpp.

void Settings::SetLastAI ( const wxString & ai )

Definition at line 1113 of file settings.cpp.

void Settings::SetLastAutolockStatus ( bool value )

Definition at line 1123 of file settings.cpp.

void Settings::SetLastHostDescription ( const wxString & value )

Definition at line 1067 of file settings.cpp.

void Settings::SetLastHostMap ( const wxString & value )

Definition at line 1103 of file settings.cpp.

void Settings::SetLastHostMod ( const wxString & value )

Definition at line 1073 of file settings.cpp.

void Settings::SetLastHostNATSetting ( int value )

Definition at line 1097 of file settings.cpp.

void Settings::SetLastHostPassword ( const wxString & value )

Definition at line 1079 of file settings.cpp.

void Settings::SetLastHostPlayerNum ( int value )

Definition at line 1091 of file settings.cpp.

void Settings::SetLastHostPort ( int value )

Definition at line 1085 of file settings.cpp.

void Settings::SetLastHostRelayedMode ( bool value )

Definition at line 1128 of file settings.cpp.

void Settings::SetLastPerspectiveName ( const wxString & name )

Definition at line 2405 of file settings.cpp.

void Settings::SetLastRankLimit ( int rank )

Definition at line 1108 of file settings.cpp.

void Settings::SetLastRelayedHost ( wxString relhost )

Definition at line 2115 of file settings.cpp.

void Settings::SetMapCachingThreadProgress ( unsigned int index )

Definition at line 326 of file settings.cpp.

void Settings::SetMapLastRectPreset	(	const wxString &	mapname,
		std::vector< Settings::SettStartBox >	rects
	)

Definition at line 1667 of file settings.cpp.

void Settings::SetMapLastStartPosType	(	const wxString &	mapname,
		const wxString &	startpostype
	)

Definition at line 1662 of file settings.cpp.

void Settings::SetMapSelectorFilterRadio ( const unsigned int val )

Definition at line 2184 of file settings.cpp.

void Settings::SetMapSelectorFollowsMouse ( bool value )

Definition at line 2169 of file settings.cpp.

void Settings::SetModCachingThreadProgress ( unsigned int index )

Definition at line 338 of file settings.cpp.

void Settings::SetModDefaultPresetName	(	const wxString &	modname,
		const wxString &	presetname
	)

Definition at line 1188 of file settings.cpp.

void Settings::setMode ( long mode )

Definition at line 2199 of file settings.cpp.

void Settings::SetNotificationPopupDisplayTime ( const unsigned int seconds )

Definition at line 2486 of file settings.cpp.

void Settings::SetNotificationPopupPosition ( const size_t index )

Definition at line 2466 of file settings.cpp.

void Settings::SetNoUDP ( bool value )

Definition at line 240 of file settings.cpp.

void Settings::SetOldSpringLaunchMethod ( bool value )

Definition at line 265 of file settings.cpp.

void Settings::SetPeopleList	(	const wxArrayString &	friends,
		const wxString &	group = `_T("default")`
	)

Definition at line 1903 of file settings.cpp.

void Settings::SetPortableMode ( bool mode )

Definition at line 190 of file settings.cpp.

void Settings::SetReplayFilterActivState ( const bool state )

Definition at line 2102 of file settings.cpp.

void Settings::SetReplayFilterValues	(	const PlaybackListFilterValues &	blfValues,
		const wxString &	profile_name = `_T("default")`
	)

Definition at line 2082 of file settings.cpp.

void Settings::SetReportStats ( const bool value )

should we sayex/pm bot?

Definition at line 2048 of file settings.cpp.

void Settings::SetRequestAttOnHighlight ( const bool req )

controls if user attention is requested when highlighting a line

Definition at line 1541 of file settings.cpp.

void Settings::SetSashPosition	(	const wxString &	window_name,
		const int	pos
	)

Definition at line 2306 of file settings.cpp.

void Settings::SetSearchSpringOnlyInSLPath ( bool value )

when this mode is enabled in windows SL will search for spring files only in the current executable folder

Definition at line 821 of file settings.cpp.

void Settings::SetServer	(	const wxString &	server_name,
		const wxString &	url,
		int	port
	)

Set hostname of a server.

Parameters:

	server_name	the server name/alias
	the	host url address
	the	port where the service is run

Definition at line 453 of file settings.cpp.

void Settings::SetServerAccountNick	(	const wxString &	server_name,
		const wxString &	value
	)

Set nickname of the default account for a server.

Parameters:

	server_name	the server name/alias
	value	the vaule to be set

Definition at line 496 of file settings.cpp.

void Settings::SetServerAccountPass	(	const wxString &	server_name,
		const wxString &	value
	)

Set password of the default account for a server.

Parameters:

	server_name	the server name/alias
	value	the vaule to be set

Todo:: Implement

Definition at line 517 of file settings.cpp.

void Settings::SetServerAccountSavePass	(	const wxString &	server_name,
		const bool	value
	)

Set if the password should be saved for a default server account.

Parameters:

	server_name	the server name/alias
	value	the vaule to be set

Todo:: Implement

Definition at line 538 of file settings.cpp.

void Settings::SetSettingsVersion ( )

Sets/Gets settings revision number.

Definition at line 202 of file settings.cpp.

void Settings::SetShowIPAddresses ( bool value )

Definition at line 260 of file settings.cpp.

void Settings::SetShowTooltips ( bool show )

Definition at line 1867 of file settings.cpp.

void Settings::SetShowXallTabs ( bool show )

Definition at line 2383 of file settings.cpp.

void Settings::setSimpleDetail ( wxString det )

Definition at line 2245 of file settings.cpp.

void Settings::setSimpleQuality ( wxString qual )

Definition at line 2233 of file settings.cpp.

void Settings::setSimpleRes ( wxString res )

Definition at line 2221 of file settings.cpp.

void Settings::SetSmartScrollEnabled ( bool value )

Definition at line 1495 of file settings.cpp.

void Settings::SetSortOrder	(	const wxString &	list_name,
		const SortOrder &	order
	)

Definition at line 2282 of file settings.cpp.

void Settings::SetSplitBRoomHorizontally ( const bool vertical )

Definition at line 2316 of file settings.cpp.

void Settings::SetSpringBinary	(	const wxString &	index,
		const wxString &	path
	)

Definition at line 946 of file settings.cpp.

void Settings::SetStartTab ( const int idx )

Definition at line 2321 of file settings.cpp.

void Settings::SetTestHostPort ( bool value )

Definition at line 1118 of file settings.cpp.

void Settings::SetTorrentDownloadRate ( int speed )

Definition at line 1751 of file settings.cpp.

void Settings::SetTorrentListToResume ( const std::vector< wxString > & list )

Definition at line 1805 of file settings.cpp.

void Settings::SetTorrentMaxConnections ( int connections )

Definition at line 1794 of file settings.cpp.

void Settings::SetTorrentPort ( unsigned int port )

Definition at line 1726 of file settings.cpp.

void Settings::SetTorrentSystemSuspendMode ( int mode )

Definition at line 1764 of file settings.cpp.

void Settings::SetTorrentThrottledDownloadRate ( int speed )

Definition at line 1788 of file settings.cpp.

void Settings::SetTorrentThrottledUploadRate ( int speed )

Definition at line 1776 of file settings.cpp.

void Settings::SetTorrentUploadRate ( int speed )

Definition at line 1738 of file settings.cpp.

void Settings::SetUnitSync	(	const wxString &	index,
		const wxString &	path
	)

Definition at line 941 of file settings.cpp.

void Settings::SetUsedSpringIndex ( const wxString & index )

Definition at line 807 of file settings.cpp.

void Settings::SetUseIrcColors ( bool value )

Definition at line 1514 of file settings.cpp.

void Settings::SetUseNotificationPopups ( const bool use )

Definition at line 2456 of file settings.cpp.

void Settings::SetUseSpringPathFromBundle ( bool value )

Definition at line 856 of file settings.cpp.

void Settings::SetUseTabIcons ( bool use )

Definition at line 2296 of file settings.cpp.

void Settings::SetVerticalSortkeyIndex ( const unsigned int idx )

Definition at line 2144 of file settings.cpp.

void Settings::SetVerticalSortorder ( const bool order )

Definition at line 2164 of file settings.cpp.

void Settings::SetWebBrowserPath ( const wxString & path )

Set the path to the user-configured browser.

Parameters:

path

A path to a web browser

Definition at line 290 of file settings.cpp.

void Settings::SetWebBrowserUseDefault ( bool useDefault )

Set the "Use Default" setting for the web browser.

If true, we use wxLaunchDefaultBrowser when we want to open a web browser.

Parameters:

useDefault

Whether or not to use the system-default browser.

See also:: Ui::OpenWebBrowser

Definition at line 279 of file settings.cpp.

void Settings::SetWindowHeight	(	const wxString &	window,
		const int	value
	)

Set height position of MainWindow.

Definition at line 649 of file settings.cpp.

void Settings::SetWindowLeft	(	const wxString &	window,
		const int	value
	)

Set left position of MainWindow.

Definition at line 688 of file settings.cpp.

void Settings::SetWindowPos	(	const wxString &	window,
		const wxPoint &	pos
	)

Definition at line 723 of file settings.cpp.

void Settings::SetWindowSize	(	const wxString &	window,
		const wxSize &	size
	)

Definition at line 708 of file settings.cpp.

void Settings::SetWindowTop	(	const wxString &	window,
		const int	value
	)

Set top position of MainWindow.

Definition at line 669 of file settings.cpp.

void Settings::SetWindowWidth	(	const wxString &	window,
		const int	value
	)

Set width position of MainWindow.

Definition at line 629 of file settings.cpp.

bool Settings::ShouldAddDefaultChannelSettings ( )

Definition at line 615 of file settings.cpp.

bool Settings::ShouldAddDefaultGroupSettings ( )

Definition at line 2010 of file settings.cpp.

bool Settings::ShouldAddDefaultServerSettings ( )

Definition at line 349 of file settings.cpp.

void Settings::TranslateSavedColumWidths ( )

simply move saved col size +1 to account for dummy col, force dummy col width to 0

Definition at line 2332 of file settings.cpp.

bool Settings::UseOldSpringLaunchMethod ( )

Definition at line 230 of file settings.cpp.

Field Documentation

const int Settings::columnWidthMinimum = 5 [static]

Definition at line 330 of file settings.h.

const int Settings::columnWidthUnset = -3 [static]

used to signal unset column width in Get...

Definition at line 329 of file settings.h.

wxString Settings::m_chosen_path [protected]

Definition at line 805 of file settings.h.

slConfig* Settings::m_config [protected]

wxConfig object to store and restore all settings in.

Definition at line 803 of file settings.h.

wxString Settings::m_final_config_path [protected]

Definition at line 811 of file settings.h.

wxString Settings::m_forced_springconfig_path [protected]

Definition at line 806 of file settings.h.

bool Settings::m_portable_mode [protected]

Definition at line 807 of file settings.h.

std::map<wxString, wxString> Settings::m_spring_versions [protected]

Definition at line 809 of file settings.h.

bool Settings::m_user_defined_config = false [static]

used for passing config file at command line

Definition at line 88 of file settings.h.

wxString Settings::m_user_defined_config_path = wxEmptyString [static]

Definition at line 89 of file settings.h.

The documentation for this class was generated from the following files:

/home/buildbot/slaves/docs/docs/build/src/settings.h
/home/buildbot/slaves/docs/docs/build/src/settings.cpp

Settings Class Reference

Data Structures

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

UI

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation