gui_modules.preferences.Settings Class Reference

Generic class where to store settings. More...

Public Member Functions
def	__init__
def	ReadSettingsFile
	Reads settings file (mapset, location, gisdbase)
def	SaveToFile
	Save settings to the file.
def	Get
	Get value by key/subkey.
def	Set
	Set value of key/subkey.
def	Append
	Set value of key/subkey.
def	GetDefaultSettings
	Get default user settings.

Data Fields
	filePath
	sep
	defaultSettings
	userSettings
	internalSettings

---

Detailed Description

Generic class where to store settings.

Definition at line 60 of file preferences.py.

---

Constructor & Destructor Documentation

def gui_modules.preferences.Settings.__init__

(

self

)

Definition at line 62 of file preferences.py.

---

Member Function Documentation

def gui_modules.preferences.Settings.Append	(		self,
			dict,
			group,
			key,
			subkey,
			value
	)

Set value of key/subkey.

Create group/key/subkey if not exists

Parameters:

dict	settings dictionary to use
group	settings group
key	key
subkey	subkey (value or list)
value	value

Definition at line 900 of file preferences.py.

References gui_modules.psmap_dialogs.type.

Referenced by gui_modules.gcpmanager.GCPList.AddGCPItem(), and gui_modules.preferences.Settings.ReadSettingsFile().

def gui_modules.preferences.Settings.Get	(		self,
			group,
			key = None,
			subkey = None,
			internal = False
	)

Get value by key/subkey.

Raise KeyError if key is not found

Parameters:

group	settings group
key	(value, None)
subkey	(value, list or None)
internal	use internal settings instead

Returns:

value

Definition at line 835 of file preferences.py.

References gui_modules.preferences.Settings.internalSettings, gui_modules.psmap_dialogs.type, and gui_modules.preferences.Settings.userSettings.

Referenced by gui_modules.preferences.Settings.ReadSettingsFile().

def gui_modules.preferences.Settings.GetDefaultSettings

(

self

)

Get default user settings.

Definition at line 933 of file preferences.py.

References gui_modules.preferences.Settings.defaultSettings.

def gui_modules.preferences.Settings.ReadSettingsFile	(		self,
			settings = None
	)

Reads settings file (mapset, location, gisdbase)

Definition at line 687 of file preferences.py.

References gui_modules.preferences.Settings._parseValue(), gui_modules.preferences.Settings._readFile(), gui_modules.preferences.Settings.Append(), gui_modules.gmodeler.VariableListCtrl.Append(), gui_modules.preferences.Settings.filePath, gui_modules.preferences.Settings.Get(), gui_modules.preferences.Settings.sep, and gui_modules.preferences.Settings.userSettings.

def gui_modules.preferences.Settings.SaveToFile	(		self,
			settings = None
	)

Save settings to the file.

Definition at line 753 of file preferences.py.

References gui_modules.preferences.Settings._parseValue(), gui_modules.preferences.Settings.filePath, gui_modules.render.map, gui_modules.preferences.Settings.sep, gui_modules.psmap_dialogs.type, and gui_modules.preferences.Settings.userSettings.

def gui_modules.preferences.Settings.Set	(		self,
			group,
			value,
			key = None,
			subkey = None,
			internal = False
	)

Set value of key/subkey.

Raise KeyError if group/key is not found

Parameters:

group	settings group
key	key (value, None)
subkey	subkey (value, list or None)
value	value
internal	use internal settings instead

Definition at line 869 of file preferences.py.

References gui_modules.preferences.Settings.internalSettings, gui_modules.psmap_dialogs.type, and gui_modules.preferences.Settings.userSettings.

---

Field Documentation

gui_modules.preferences.Settings.defaultSettings

Definition at line 77 of file preferences.py.

Referenced by gui_modules.preferences.Settings.GetDefaultSettings().

gui_modules.preferences.Settings.filePath

Definition at line 64 of file preferences.py.

Referenced by gui_modules.preferences.Settings.ReadSettingsFile(), and gui_modules.preferences.Settings.SaveToFile().

gui_modules.preferences.Settings.internalSettings

Definition at line 629 of file preferences.py.

Referenced by gui_modules.preferences.Settings.Get(), and gui_modules.preferences.Settings.Set().

gui_modules.preferences.Settings.sep

Definition at line 67 of file preferences.py.

Referenced by gui_modules.preferences.Settings.ReadSettingsFile(), and gui_modules.preferences.Settings.SaveToFile().

gui_modules.preferences.Settings.userSettings

Definition at line 620 of file preferences.py.

Referenced by gui_modules.preferences.Settings.Get(), gui_modules.preferences.Settings.ReadSettingsFile(), gui_modules.preferences.Settings.SaveToFile(), and gui_modules.preferences.Settings.Set().

---

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

• preferences.py