colorGetActiveScheme()

A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DaySchema" - the name of the directory. The function colorGetActiveScheme returns the active color scheme.

Synopsis

string colorGetActiveScheme();

Parameters

-

Return Value

In case of error -1. Otherwise 0.

Errors

Missing or wrong arguments.

Description

A color scheme is a collection of colorDB files located in a subdirectory of proj_path/colorDB, for example, proj_path/colorDB/DayScheme/colors. Hence, the name of the schema is "DayScheme" - the name of the directory. The function colorSetActiveScheme() sets the active color scheme. The user interface loads all colorDB files and additionally all colorDB files from the active color scheme. Hence, you can overload colors by using a color scheme. The function colorGetActiveScheme returns the active color scheme.

Note that in order to use the function, open the UI in the -extend mode. Furthermore, the function cannot be used in a second UI simultaneously since the color database is locked for writing (the error message "Read only colorDB“ is shown).

Example

Sets the active color scheme to "DayScheme" and returns it via "colorGetActiveScheme".

main()
{
  int i;
  string scheme = "DayScheme";
  string col;
  i = colorSetActiveScheme (scheme);
  col = colorGetActiveScheme();
  DebugN(col);
}

Assignment

Miscellaneous functions

Availability

UI