Enumerations for user interface properties and fields

In some cases in EGL, the values of a property or field are restricted to the values of a particular enumeration, which is a category of predefined values. For example, the color property accepts a value from the ColorKind enumeration; valid values of that enumeration include white, red, and so on.

The following enumerations specify options for user interfaces; however, explanations of those values are given elsewhere, in the context of the property or field in which the enumeration is meaningful:

AlignKind
The AlignKind enumeration is used with the align property and has the following values:
  • center
  • left
  • none
  • right
ColorKind
The ColorKind enumeration is used with the color property and the consoleLib.drawBoxWithColor() system function. The enumeration has the following values:
  • black
  • blue
  • cyan
  • defaultColor
  • green
  • magenta
  • red
  • white
  • yellow
HighlightKind
The HighlightKind enumeration is used with the highlight property and has the following values:
  • blink
  • defaultHighlight
  • noHighlight
  • reverse
  • underline
IntensityKind
The IntensityKind enumeration is used with the intensity property and has the following values:
  • bold
  • defaultHighlight
  • dim
  • invisible
  • normalIntensity
LineWrapKind
The LineWrapKind enumeration is reserved for future use and has the following values:
  • character
  • word
ProtectKind
The ProtectKind enumeration is used with the protect property and has the following values:
  • noProtect
  • protect
  • skipProtect
SignKind
The SignKind enumeration is reserved for future use and has the following values:
  • leading
  • none
  • parens
  • trailing

Feedback