Home | Trees | Index | Help |
|
---|
Package aldrin :: Module config :: Class AldrinConfig |
|
object
--+ |ConfigBase
--+ |FileConfig
--+ | AldrinConfig
Streamlines access to the applications configuration. You should set all applications to and retrieve them from the config object.
Do not instantiate this class, use {get_config} instead.
On Windows, most settings will be saved in ~/aldrin/settings.cfg
On Linux, most settings will be saved in ~/.aldrin/settings.cfgMethod Summary | |
---|---|
Initializer. | |
Adds a filename to the list of recently used files, if not already included. | |
str or None |
Returns the name of the currently active theme. |
(str,str,int,int) |
Retrieves current audiodriver settings. |
wx.Brush |
Returns a certain theme color as brush |
str |
Returns a certain theme color as html hex color string. |
returns the credentials required for a service (username/password). | |
Returns the default value for a UI setting. | |
[str,...] |
Returns the current list of enabled extension uris. |
Returns a certain theme color as float tuples | |
Returns the samples folder designated for samples downloaded from freesound. | |
str |
yields a a tree of plugins, to be used in the machine view for menus. |
returns a keymap for the pattern editor, to be used for note input. | |
Returns the current keymap language | |
[(str,int,int),...] |
Returns the list of mapped midi controllers. |
[str,...] |
Returns the current list of MIDI input driver names. |
[str,...] |
Returns the current list of MIDI output driver names. |
wx.Brush |
Returns a certain theme color as brush |
preset.PresetCollection |
Returns a PresetCollection for the given pluginloader. |
str list |
Retrieves list of recently used files. |
Returns the volume with which samples shall be previewed. | |
Returns the users settings folder. | |
[str,...] |
Returns a list of color theme names |
Returns the list of wavetable paths. | |
Retrieves a windows position from the config and applies it. | |
Stores a windows position to the config. | |
Selects a color theme with a specific name to be used. | |
Stores audiodriver settings. | |
stores the credentials required for a service (username/password). | |
Stores a default value for an UI setting. | |
Stores the current list of enabled extension uris. | |
Sets the current keymap language | |
Sets the list of mapped midi controllers. | |
Stores the current list of used MIDI input driver names. | |
Stores the current list of used MIDI output driver names. | |
Stores a preset collection for the given pluginloader. | |
Sets the list of wavetable paths. | |
Inherited from FileConfig | |
__del__(self) | |
| |
Inherited from ConfigBase | |
Create() -> ConfigBase (Static method) | |
DeleteAll(self) -> bool | |
DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -> bool | |
DeleteGroup(self, String key) -> bool | |
DontCreateOnDemand() (Static method) | |
Exists(self, String name) -> bool | |
ExpandEnvVars(self, String str) -> String | |
Flush(self, bool currentOnly=False) -> bool | |
Get(bool createOnDemand=True) -> ConfigBase (Static method) | |
GetAppName(self) -> String | |
GetEntryType(self, String name) -> int | |
GetFirstEntry() -> (more, value, index) | |
GetFirstGroup() -> (more, value, index) | |
GetNextEntry(long index) -> (more, value, index) | |
GetNextGroup(long index) -> (more, value, index) | |
GetNumberOfEntries(self, bool recursive=False) -> size_t | |
GetNumberOfGroups(self, bool recursive=False) -> size_t | |
GetPath(self) -> String | |
GetStyle(self) -> long | |
GetVendorName(self) -> String | |
HasEntry(self, String name) -> bool | |
HasGroup(self, String name) -> bool | |
IsExpandingEnvVars(self) -> bool | |
IsRecordingDefaults(self) -> bool | |
Read(self, String key, String defaultVal=EmptyString) -> String | |
ReadBool(self, String key, bool defaultVal=False) -> bool | |
ReadFloat(self, String key, double defaultVal=0.0) -> double | |
ReadInt(self, String key, long defaultVal=0) -> long | |
RenameEntry(self, String oldName, String newName) -> bool | |
RenameGroup(self, String oldName, String newName) -> bool | |
Set(ConfigBase config) -> ConfigBase (Static method) | |
SetAppName(self, String appName) | |
SetExpandEnvVars(self, bool doIt=True) | |
SetPath(self, String path) | |
SetRecordDefaults(self, bool doIt=True) | |
SetStyle(self, long style) | |
SetVendorName(self, String vendorName) | |
Write(self, String key, String value) -> bool | |
WriteBool(self, String key, bool value) -> bool | |
WriteFloat(self, String key, double value) -> bool | |
WriteInt(self, String key, long value) -> bool | |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__setattr__('name', value) <==> x.name = value | |
x.__str__() <==> str(x) |
Class Variable Summary | |
---|---|
Inherited from ConfigBase | |
int |
Type_Boolean = 2 |
int |
Type_Float = 4 |
int |
Type_Integer = 3 |
int |
Type_String = 1 |
int |
Type_Unknown = 0 |
Instance Method Details |
---|
__init__(self)
Initializer.
|
add_recent_file_config(self, filename)Adds a filename to the list of recently used files, if not already included.
|
get_active_theme(self)Returns the name of the currently active theme.
|
get_audiodriver_config(self)Retrieves current audiodriver settings.
|
get_brush(self, name)Returns a certain theme color as brush
|
get_color(self, name)Returns a certain theme color as html hex color string.
|
get_credentials(self, service)returns the credentials required for a service (username/password). |
get_default_int(self, key, defval=0)Returns the default value for a UI setting. |
get_enabled_extensions(self)Returns the current list of enabled extension uris.
|
get_float_color(self, name)Returns a certain theme color as float tuples |
get_freesound_samples_folder(self)Returns the samples folder designated for samples downloaded from freesound. |
get_index_path(self)yields a a tree of plugins, to be used in the machine view for menus. On Posix platforms, ~/.aldrin/index.txt overrides ${PREFIX}/share/aldrin/index.txt. On Windows, <user folder>/aldrin/index.txt overrides <app folder>/share/aldrin/index.txt.
|
get_keymap(self)returns a keymap for the pattern editor, to be used for note input. |
get_keymap_language(self)Returns the current keymap language |
get_midi_controllers(self)Returns the list of mapped midi controllers.
|
get_mididriver_inputs(self)Returns the current list of MIDI input driver names.
|
get_mididriver_outputs(self)Returns the current list of MIDI output driver names.
|
get_pen(self, name)Returns a certain theme color as brush
|
get_plugin_presets(self, pluginloader)Returns a PresetCollection for the given pluginloader.
|
get_recent_files_config(self)Retrieves list of recently used files.
|
get_sample_preview_volume(self)Returns the volume with which samples shall be previewed. |
get_settings_folder(self)Returns the users settings folder. |
get_theme_names(self)Returns a list of color theme names
|
get_wavetable_paths(self)Returns the list of wavetable paths.
|
load_window_pos(self, windowid, window)Retrieves a windows position from the config and applies it.
|
save_window_pos(self, windowid, window)Stores a windows position to the config.
|
select_theme(self, name)Selects a color theme with a specific name to be used.
|
set_audiodriver_config(self, inputname, outputname, samplerate, buffersize)Stores audiodriver settings.
|
set_credentials(self, service, username, password)stores the credentials required for a service (username/password). |
set_default_int(self, key, val)Stores a default value for an UI setting. |
set_enabled_extensions(self, uris)Stores the current list of enabled extension uris.
|
set_keymap_language(self, lang)Sets the current keymap language
|
set_midi_controllers(self, ctrllist)Sets the list of mapped midi controllers.
|
set_mididriver_inputs(self, inputlist)Stores the current list of used MIDI input driver names. |
set_mididriver_outputs(self, outputlist)Stores the current list of used MIDI output driver names. |
set_plugin_presets(self, pluginloader, presets)Stores a preset collection for the given pluginloader.
|
set_wavetable_paths(self, pathlist)Sets the list of wavetable paths.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Sun Feb 4 18:01:14 2007 | http://epydoc.sf.net |