robotide.preferences.settings._Section Class Reference

Inheritance diagram for robotide.preferences.settings._Section:

Public Member Functions
def	__getitem__ (self, name)
def	__init__ (self, section, parent=None, name='')
def	__iter__ (self)
def	__len__ (self)
def	__setitem__ (self, name, value)
def	add_section (self, name, **defaults)
	Creates section or updates existing section with defaults. More...
def	get (self, name, default)
	Returns specified setting or (automatically set) default. More...
def	get_without_default (self, name)
	Returns specified setting or None if setting is not defined. More...
def	has_setting (self, name)
def	iteritems (self)
	Returns an iterator over the (key,value) items of the section. More...
def	save (self)
def	set (self, name, value, autosave=True, override=True)
	Sets setting 'name' value to 'value'. More...
def	set_defaults (self, settings_dict=None, **settings)
	Sets defaults based on dict and kwargs, kwargs having precedence. More...
def	set_values (self, settings, autosave=True, override=True)
	Set values from settings. More...

Private Member Functions
def	_is_section (self, name)

Private Attributes
	_config_obj
	_name
	_parent

Detailed Description

Definition at line 294 of file settings.py.

Constructor & Destructor Documentation

__init__()

def robotide.preferences.settings._Section.__init__	(		self,
			section,
			parent = None,
			name = ''
	)

Definition at line 296 of file settings.py.

Member Function Documentation

__getitem__()

def robotide.preferences.settings._Section.__getitem__	(		self,
			name
	)

Definition at line 307 of file settings.py.

__iter__()

def robotide.preferences.settings._Section.__iter__

(

self

)

Definition at line 313 of file settings.py.

__len__()

def robotide.preferences.settings._Section.__len__

(

self

)

Definition at line 316 of file settings.py.

__setitem__()

def robotide.preferences.settings._Section.__setitem__	(		self,
			name,
			value
	)

Definition at line 304 of file settings.py.

_is_section()

def robotide.preferences.settings._Section._is_section (   self,   name  )

private

Definition at line 391 of file settings.py.

add_section()

def robotide.preferences.settings._Section.add_section	(		self,
			name,
		**	defaults
	)

Creates section or updates existing section with defaults.

Definition at line 383 of file settings.py.

get()

def robotide.preferences.settings._Section.get	(		self,
			name,
			default
	)

Returns specified setting or (automatically set) default.

Definition at line 327 of file settings.py.

get_without_default()

def robotide.preferences.settings._Section.get_without_default	(		self,
			name
	)

Returns specified setting or None if setting is not defined.

Definition at line 335 of file settings.py.

has_setting()

def robotide.preferences.settings._Section.has_setting	(		self,
			name
	)

Definition at line 323 of file settings.py.

iteritems()

def robotide.preferences.settings._Section.iteritems

(

self

)

Returns an iterator over the (key,value) items of the section.

Definition at line 320 of file settings.py.

save()

def robotide.preferences.settings._Section.save

(

self

)

Reimplemented in robotide.preferences.settings.Settings.

Definition at line 301 of file settings.py.

set()

def robotide.preferences.settings._Section.set	(		self,
			name,
			value,
			autosave = True,
			override = True
	)

Sets setting 'name' value to 'value'.

    'autosave' can be used to define whether to save automatically
    after values are changed. 'override' can be used to specify
    whether to override existing value or not. Setting which does
    not exist is anyway always created.

Definition at line 348 of file settings.py.

set_defaults()

def robotide.preferences.settings._Section.set_defaults	(		self,
			settings_dict = None,
		**	settings
	)

Sets defaults based on dict and kwargs, kwargs having precedence.

Definition at line 377 of file settings.py.

set_values()

def robotide.preferences.settings._Section.set_values	(		self,
			settings,
			autosave = True,
			override = True
	)

Set values from settings.

'settings' needs to be a dictionary.

    See method set for more info about 'autosave' and 'override'.

Definition at line 368 of file settings.py.

Member Data Documentation

_config_obj

robotide.preferences.settings._Section._config_obj

private

Definition at line 297 of file settings.py.

_name

robotide.preferences.settings._Section._name

private

Definition at line 299 of file settings.py.

_parent

robotide.preferences.settings._Section._parent

private

Definition at line 298 of file settings.py.

---

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

• src/robotide/preferences/settings.py