Home       Trees       Index       Help   

Aldrin API

Package aldrin :: Module config :: Class AldrinConfig
[show private | hide private]
[frames | no frames]

Type AldrinConfig

object --+        
         |        
ConfigBase --+    
             |    
        Config --+
                 |
                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 the registry.

On Linux, most settings will be saved in ~/.aldrin/settings.cfg
Method Summary
  __init__(self)
Initializer.
  add_recent_file_config(self, filename)
Adds a filename to the list of recently used files, if not already included.
str or None get_active_theme(self)
Returns the name of the currently active theme.
(str,int,int) get_audiodriver_config(self)
Retrieves current audiodriver settings.
wx.Brush get_brush(self, name)
Returns a certain theme color as brush
str get_color(self, name)
Returns a certain theme color as html hex color string.
[str,...] get_enabled_extensions(self)
Returns the current list of enabled extension uris.
str get_index_path(self)
yields a a tree of plugins, to be used in the machine view for menus.
  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
[(str,int,int),...] get_midi_controllers(self)
Returns the list of mapped midi controllers.
str get_mididriver_input(self)
Returns the current MIDI input driver name.
[str,...] get_mididriver_outputs(self)
Returns the current list of MIDI output driver names.
wx.Brush get_pen(self, name)
Returns a certain theme color as brush
preset.PresetCollection get_plugin_presets(self, pluginloader)
Returns a PresetCollection for the given pluginloader.
str list 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.
[str,...] 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, name, samplerate, buffersize)
Stores audiodriver settings.
  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_input(self, name)
Stores the current MIDI input driver name.
  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.
    Inherited from Config
  __del__(self, destroy)
__del__(self)
  __repr__(self)
    Inherited from ConfigBase
  Create(*args, **kwargs)
Create() -> ConfigBase (Static method)
  DeleteAll(*args, **kwargs)
DeleteAll(self) -> bool
  DeleteEntry(*args, **kwargs)
DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -> bool
  DeleteGroup(*args, **kwargs)
DeleteGroup(self, String key) -> bool
  DontCreateOnDemand(*args, **kwargs)
DontCreateOnDemand() (Static method)
  Exists(*args, **kwargs)
Exists(self, String name) -> bool
  ExpandEnvVars(*args, **kwargs)
ExpandEnvVars(self, String str) -> String
  Flush(*args, **kwargs)
Flush(self, bool currentOnly=False) -> bool
  Get(*args, **kwargs)
Get(bool createOnDemand=True) -> ConfigBase (Static method)
  GetAppName(*args, **kwargs)
GetAppName(self) -> String
  GetEntryType(*args, **kwargs)
GetEntryType(self, String name) -> int
  GetFirstEntry(*args, **kwargs)
GetFirstEntry() -> (more, value, index)
  GetFirstGroup(*args, **kwargs)
GetFirstGroup() -> (more, value, index)
  GetNextEntry(*args, **kwargs)
GetNextEntry(long index) -> (more, value, index)
  GetNextGroup(*args, **kwargs)
GetNextGroup(long index) -> (more, value, index)
  GetNumberOfEntries(*args, **kwargs)
GetNumberOfEntries(self, bool recursive=False) -> size_t
  GetNumberOfGroups(*args, **kwargs)
GetNumberOfGroups(self, bool recursive=False) -> size_t
  GetPath(*args, **kwargs)
GetPath(self) -> String
  GetStyle(*args, **kwargs)
GetStyle(self) -> long
  GetVendorName(*args, **kwargs)
GetVendorName(self) -> String
  HasEntry(*args, **kwargs)
HasEntry(self, String name) -> bool
  HasGroup(*args, **kwargs)
HasGroup(self, String name) -> bool
  IsExpandingEnvVars(*args, **kwargs)
IsExpandingEnvVars(self) -> bool
  IsRecordingDefaults(*args, **kwargs)
IsRecordingDefaults(self) -> bool
  Read(*args, **kwargs)
Read(self, String key, String defaultVal=EmptyString) -> String
  ReadBool(*args, **kwargs)
ReadBool(self, String key, bool defaultVal=False) -> bool
  ReadFloat(*args, **kwargs)
ReadFloat(self, String key, double defaultVal=0.0) -> double
  ReadInt(*args, **kwargs)
ReadInt(self, String key, long defaultVal=0) -> long
  RenameEntry(*args, **kwargs)
RenameEntry(self, String oldName, String newName) -> bool
  RenameGroup(*args, **kwargs)
RenameGroup(self, String oldName, String newName) -> bool
  Set(*args, **kwargs)
Set(ConfigBase config) -> ConfigBase (Static method)
  SetAppName(*args, **kwargs)
SetAppName(self, String appName)
  SetExpandEnvVars(*args, **kwargs)
SetExpandEnvVars(self, bool doIt=True)
  SetPath(*args, **kwargs)
SetPath(self, String path)
  SetRecordDefaults(*args, **kwargs)
SetRecordDefaults(self, bool doIt=True)
  SetStyle(*args, **kwargs)
SetStyle(self, long style)
  SetVendorName(*args, **kwargs)
SetVendorName(self, String vendorName)
  Write(*args, **kwargs)
Write(self, String key, String value) -> bool
  WriteBool(*args, **kwargs)
WriteBool(self, String key, bool value) -> bool
  WriteFloat(*args, **kwargs)
WriteFloat(self, String key, double value) -> bool
  WriteInt(*args, **kwargs)
WriteInt(self, String key, long value) -> bool
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
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)
(Constructor)

Initializer.
Overrides:
wx._misc.Config.__init__

add_recent_file_config(self, filename)

Adds a filename to the list of recently used files, if not already included.
Parameters:
filename - path to file.
           (type=str)

get_active_theme(self)

Returns the name of the currently active theme.
Returns:
name of theme or None, if default
           (type=str or None)

get_audiodriver_config(self)

Retrieves current audiodriver settings.
Returns:
A tuple containing driver name, samplerate and buffer size.
           (type=(str,int,int))

get_brush(self, name)

Returns a certain theme color as brush
Parameters:
name - name of color theme key.
           (type=str)
Returns:
brush
           (type=wx.Brush)

get_color(self, name)

Returns a certain theme color as html hex color string.
Parameters:
name - name of color theme key.
           (type=str)
Returns:
color of key.
           (type=str)

get_enabled_extensions(self)

Returns the current list of enabled extension uris.
Returns:
List of uris.
           (type=[str,...])

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.
Returns:
Path to the index file.
           (type=str)

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.
Returns:
List of tuples containing name, channel and controller id
           (type=[(str,int,int),...])

get_mididriver_input(self)

Returns the current MIDI input driver name.
Returns:
Driver string.
           (type=str)

get_mididriver_outputs(self)

Returns the current list of MIDI output driver names.
Returns:
List of driver names.
           (type=[str,...])

get_pen(self, name)

Returns a certain theme color as brush
Parameters:
name - name of color theme key.
           (type=str)
Returns:
brush
           (type=wx.Brush)

get_plugin_presets(self, pluginloader)

Returns a PresetCollection for the given pluginloader.
Parameters:
pluginloader - A pluginloader.
           (type=libzzub.Pluginloader)
Returns:
A preset collection.
           (type=preset.PresetCollection)

get_recent_files_config(self)

Retrieves list of recently used files.
Returns:
List of file paths.
           (type=str list)

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
Returns:
A list of color theme names.
           (type=[str,...])

get_wavetable_paths(self)

Returns the list of wavetable paths.
Returns:
List of paths to directories containing samples. @rtype:[str,...]

load_window_pos(self, windowid, window)

Retrieves a windows position from the config and applies it.
Parameters:
windowid - Name of window in config.
           (type=str)
window - The window whose properties to save.
           (type=wx.Window)

save_window_pos(self, windowid, window)

Stores a windows position to the config.
Parameters:
windowid - Name of window in config.
           (type=str)
window - The window whose properties to save.
           (type=wx.Window)

select_theme(self, name)

Selects a color theme with a specific name to be used.
Parameters:
name - name of theme as returned by get_theme_names.
           (type=str)

set_audiodriver_config(self, name, samplerate, buffersize)

Stores audiodriver settings.
Parameters:
name - The newly selected driver name.
           (type=str)
samplerate - Selected samples per seconds.
           (type=int)
buffersize - Buffer size in samples.
           (type=int)

set_enabled_extensions(self, uris)

Stores the current list of enabled extension uris.
Parameters:
uris - List of uris
           (type=[str,...])

set_keymap_language(self, lang)

Sets the current keymap language
Parameters:
lang - Language ('en', 'de')
           (type=str)

set_midi_controllers(self, ctrllist)

Sets the list of mapped midi controllers.
Parameters:
ctrllist - List of tuples containing name,channel and controller id
           (type=[(str,int,int),...])

set_mididriver_input(self, name)

Stores the current MIDI input driver name.
Parameters:
name - Driver string.
           (type=str)

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.
Parameters:
pluginloader - A pluginloader.
           (type=libzzub.Pluginloader)
presets - A preset collection
           (type=preset.PresetCollection)

set_wavetable_paths(self, pathlist)

Sets the list of wavetable paths.
Parameters:
pathlist - List of paths to directories containing samples.
           (type=[str,...])

   Home       Trees       Index       Help   

Aldrin API

Generated by Epydoc 2.1 on Fri Nov 24 13:58:33 2006 http://epydoc.sf.net