LibAceConfigAPI
This library provides a small API to build config trees for AceConfig-3.0.
API Doc
This API is a wrapper around the AceConfig-3.0 Options Tables and most of the parameter names are equal to thier name in the config table. I decided not to document/explain every argument for every method. Most of the argument names equal thier counterpart in an Options Table entry, therefore those should already be known or for those new to AceConfig-3.0 i suggest to read thier docs first regardles of this API.
NOTE Not all Features (Item Types and/or Parameters) of AceConfig-3.0 Options Tables may yet be supported.
Common Parameters
There are a lot of common parameters, thier meaning is documented here
createGroup(name, desc, childGroups, disabled, hidden)
see Groups
createHeader(name, hidden)
see Header
createDescription(name, hidden)
see Description
createInput(name, desc, arg, width, disabled, hidden)
see Input
createRange(name, desc, arg, mms, width, disabled, hidden)
- mms
- an array containing min, max and step. eg {0, 5000, 5} for min = 0, max = 5000 and step = 5 see Range
createSharedMediaFontSelect(name, desc, arg, values, width, disabled, hidden)
see AceGUI-3.0-SharedMediaWidgets
createSharedMediaSoundSelect(name, desc, arg, values, width, disabled, hidden)
see AceGUI-3.0-SharedMediaWidgets
createSharedMediaStatusbarSelect(name, desc, arg, values, width, disabled, hidden)
see AceGUI-3.0-SharedMediaWidgets
createSharedMediaBackgroundSelect(name, desc, arg, values, width, disabled, hidden)
see AceGUI-3.0-SharedMediaWidgets
createSharedMediaBorderSelect(name, desc, arg, values, width, disabled, hidden)
see AceGUI-3.0-SharedMediaWidgets
createSharedMediaSelect(type, name, desc, arg, values, width, disabled, hidden)
NOTE you should use the related createSharedMedia*Select instead of this method
- type
- this type does NOT match the type for Options Table entries but goes into dialogConrtroll (see Custom Controls see AceGUI-3.0-SharedMediaWidgets
createSelect(name, desc, arg, values, width, disabled, hidden)
see Select
createToggle(name, desc, arg, width, disabled, hidden)
see Toggle
createExecute(name, desc, arg, func, confirm, width, disabled, hidden)
see Execute
createColor(name, desc, arg, alpha, width, disabled, hidden)
see Color
injectSetGet(obj, set, get)
Inject getter and setter methods into an option or group. setter/getter set on groups where inherited as described here
buildGetter(db, ...)
Builds a default getter.
- db
- AceDB instance, do not pass db.profile or a child. this value is used as *db.profile*
- ...
- a list of keys for the profile e.g. 'core', 'font' becomes `db.profile.core.font' and if the getter arg is *size* this method reads the value of 'db.profile.core.font.size'
buildSetter(callback, db, ...)
Builds a default setter.
- callback
- a method to call after value has been set. the first parameter of the call will be the *arg*
- db
- AceDB instance, do not pass db.profile or a child. this value is used as *db.profile*
- ...
- a list of keys for the profile e.g. 'core', 'font' becomes `db.profile.core.font' and if the setter arg is *size* this method sets the value of 'db.profile.core.font.size'
buildSetGet(callback, obj, db, ...)
Builds and injects default setter/getter to *obj*.
Here and there you might want to use a spell check for their (instead of thier)