Contents |
Introduction
All Windows have a base state, and possibly some more states. Every state has a particular prefix, and they all share the following settings.
Brushes
Every State has the following 3 brushes. || *Prefix* || *Description* || || (statePrefix) || Used to render the background. || || (statePrefix)Outline || Used to render the outline. || || (statePrefix)Font || Used to render the text. ||
Background
`CornerRadiusX`
The X radius to draw corners with.
Type: Integer
Default Value: *0*
`CornerRadiusY`
The Y radius to draw corners with.
Type: Integer
Default Value: *0*
`OutlineWidth`
The width of the outline around the window.
Type: Integer
Default Value: *0*
Text
`Font`
The font to render text with.
Default Value: *Arial*
`FontSize`
The font size.
Type: Float
Default Value: *12*
`FontStretch`
How stretched out the font is. Ultra Condensed, Extra Condensed, Condensed, Semi Condensed, Normal, Medium, Semi Expanded, Expanded, Extra Expanded, or Ultra Expanded.
Default Value: *Normal*
`FontStyle`
The font style. Normal, Oblique, or Italic.
Default Value: *Normal*
`FontWeight`
The weight of the font. Thin, Extra Light, Ultra Light, Light, Semi Light, Normal, Regular, Medium, Semi Bold, Bold, Extra Bold, Ultra Bold, Black, Heavy, Extra Black, or Ultra Black.
Default Value: *Normal*
`ReadingDirection`
Specifies the direction in which reading progresses.
Default Value: *!LeftToRight*
`TextAlign`
The horizontal alignment of the text. Left, Center, or Right.
Default Value: *Left*
`TextOffset`
Text offset from the background.
Type: Rectangle Default Value: *0 0 0 0*
`TextRotation`
Text rotation, in degrees.
Default Value: *0*
`TextTrimmingGranularity`
When text needs to be cut of due to size constraints, how much to cut of. None, Character, or Word.
Default Value: *Word*
`TextVerticalAlign`
The vertical alignment of the text. Bottom, Middle, or Top.
Default Value: *Top*
`WordWrapping`
Defines how to wrap text when necessary.
|| *Value* || *Description* || || Wrap || Indicates that words are broken across lines to avoid text overflowing the layout box. || || !NoWrap || Indicates that words are kept within the same line even when it overflows the layout box. ||
Default Value: *!NoWrap*
Bangs
Every named window supports the following bangs for every state it contains.
In order for a bang to modify a state, it needs to be able to uniquely identify that state. The unnamed based state is specified by simply giving the window name.
Sample
- nLabel LabelName
- This will set the outline width for the default state
!nSetOutlineWidth LabelName 20
- This will set the outline width for the hover state
!nSetOutlineWidth LabelName Hover 20
`!nSetCornerRadiusX`
!nSetCornerRadiusX (windowPrefix) (statePrefix) radius
Modifies the CornerRadiusX setting.
`!nSetCornerRadiusY`
!nSetCornerRadiusY (windowPrefix) (statePrefix) radius
Modifies the CornerRadiusY setting.
`!nSetFont`
!nSetFont (windowPrefix) (statePrefix) width
Modifies the Font setting.
Not implemented yet.
`!nSetFontSize`
!nSetFontSize (windowPrefix) (statePrefix) size
Modifies the FontSize setting.
Not implemented yet.
`!nSetFontStretch`
!nSetFontStretch (windowPrefix) (statePrefix) value
Modifies the FontStretch setting.
Not implemented yet.
`!nSetFontStyle`
!nSetFontStyle (windowPrefix) (statePrefix) value
Modifies the FontStyle setting.
Not implemented yet.
`!nSetFontWeight`
!nSetFontWeight (windowPrefix) (statePrefix) value
Modifies the FontWeight setting.
Not implemented yet.
`!nSetOutlineWidth`
!nSetOutlineWidth (windowPrefix) (statePrefix) width
Modifies the OutlineWidth setting.
`!nSetReadingDirection`
!nSetReadingDirection (windowPrefix) (statePrefix) value
Modifies the ReadingDirection setting.
`!nSetTextAlign`
!nSetTextAlign (windowPrefix) (statePrefix) value
Modifies the TextAlign setting.
`!nSetTextOffset`
!nSetTextOffset (windowPrefix) (statePrefix) left top right bottom
Modifies the TextOffset setting.
`!nSetTextRotation`
!nSetTextRotation (windowPrefix) (statePrefix) degrees
Modifies the TextRotation setting.
`!nSetTextTrimmingGranularity`
!nSetTextTrimmingGranularity (windowPrefix) (statePrefix) value
Modifies the TextTrimmingGranularity setting.
`!nSetTextVerticalAlign`
!nSetTextVerticalAlign (windowPrefix) (statePrefix) value
Modifies the TextVerticalAlign setting.
`!nSetWordWrapping`
!nSetWordWrapping (windowPrefix) (statePrefix) value
Modifies the WordWrapping setting.