GRASS Programmer's Manual  6.4.2(2012)
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

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:
dictsettings dictionary to use
groupsettings group
keykey
subkeysubkey (value or list)
valuevalue

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:
groupsettings group
key(value, None)
subkey(value, list or None)
internaluse 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().

Get default user settings.

Definition at line 933 of file preferences.py.

References gui_modules.preferences.Settings.defaultSettings.

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:
groupsettings group
keykey (value, None)
subkeysubkey (value, list or None)
valuevalue
internaluse 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


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines