< Previous | Contents | Manuals Home | Boris FX | Next >
This list object allows read-write access to the color preferences listed on the Preferences panel.
The ColorPref object is a list with indexed or associative access, ie ColorPref[2] or ColorPref["UI Background"]. The indices of the preferences in ColorPref reflect the order of the preferences in the color dropdown only and are subject to change.
WARNING : Do not attempt to store color preferences based on their position in ColorPref (or the description!). Those values may change from one version of SynthEyes to another! Use the kind values!
To find a preference based on a kind value, instead of the index, use ColorPref.ByKind(kindvalue).
Color preference changes are not permanent until SynthEyes exits successfully, or the user opens and closes the preferences panel. To save them immediately, use Prefs.Save().
Each preference has the following read-only attributes. Only .color is writable. Note that some changes may not take effect until some user action, such as reopening the Perspective view. Important: there is no Undo for Preferences changes: they take effect immediately, and are outside the scope of the normal undo system.
.color The changable 24-bit color to be used for this kind of thing. Read/write.
.default Default 24-bit color for this kind of thing. Read only.
.description The descriptive text for this color, as shown on the preference panel's color selection drop-down.
.index The position of this color preference in ColorPref.
.kind The permanent numeric code for this color preference. Use this to be able to reliably change the same color across multiple SynthEyes versions!
©2023 Boris FX, Inc. — UNOFFICIAL — Converted from original PDF.