Enumerations
Global GUI Enumerations
Global Enumerations

Enumerations

enum  GUI::TextFormatting {
  GUI::LeftAligned,
  GUI::RightAligned,
  GUI::Centred,
  GUI::Justified,
  GUI::WordWrapLeftAligned,
  GUI::WordWrapRightAligned,
  GUI::WordWrapCentred,
  GUI::WordWrapJustified
}
 Enumerated type that contains valid formatting types that can be specified when rendering text into a Rect area (the formatting Rect). More...

Detailed Description


Enumeration Type Documentation

Enumerated type that contains valid formatting types that can be specified when rendering text into a Rect area (the formatting Rect).

Enumerator:
LeftAligned 

All text is printed on a single line. The left-most character is aligned with the left edge of the formatting Rect.

RightAligned 

All text is printed on a single line. The right-most character is aligned with the right edge of the formatting Rect.

Centred 

All text is printed on a single line. The text is centred horizontally in the formatting Rect.

Justified 

All text is printed on a single line. The left-most and right-most characters are aligned with the edges of the formatting Rect.

WordWrapLeftAligned 

Text is broken into multiple lines no wider than the formatting Rect. The left-most character of each line is aligned with the left edge of the formatting Rect.

WordWrapRightAligned 

Text is broken into multiple lines no wider than the formatting Rect. The right-most character of each line is aligned with the right edge of the formatting Rect.

WordWrapCentred 

Text is broken into multiple lines no wider than the formatting Rect. Each line is centred horizontally in the formatting Rect.

WordWrapJustified 

Text is broken into multiple lines no wider than the formatting Rect. The left-most and right-most characters of each line are aligned with the edges of the formatting Rect.