ASS properties

Detailed Description

AUI Style Sheets property customizes view's appearance and behavior.

Classes
struct	ass::Backdrop
	Represents backdrop filter effect which applied to the pixels behind the view (i.e., blur, grayscale, etc.) More...
struct	ass::BackgroundCropping
	Controls background texture cropping by exact UV coordinates. Useful for texture atlases. More...
struct	ass::BackgroundEffect
	Represents custom-rendered background effect. More...
struct	ass::BackgroundGradient
	Represents gradient background. More...
struct	ass::BackgroundImage
	Represents textured (image) background. More...
struct	ass::BackgroundSolid
	Represents solid (single color) background. More...
struct	ass::Border
	Represents border. More...
struct	ass::BorderBottom
	Represents bottom border. More...
struct	ass::BorderLeft
	Represents left border. More...
struct	ass::BorderRadius
	Controls border radius. More...
struct	ass::BorderRight
	Represents right border. More...
struct	ass::BorderTop
	Represents top border. More...
struct	ass::BoxShadow
	Represents box shadow. More...
struct	ass::BoxShadowInner
	Represents box shadow. More...
struct	ass::Expanding
	Controls the expanding of AView. More...
struct	ass::FixedSize
	Controls the fixed size of AView. More...
struct	ass::Font
	Controls the font of AView. More...
struct	ass::FontFamily
	Controls the font family of AView. More...
struct	ass::FontSize
	Controls the font size of AView. More...
struct	ass::LayoutSpacing
	Controls the gap between elements of the container. Basically acts like a margin, but the gaps appear between views only, not around them. More...
struct	ass::LineHeight
	Controls line height multiplier of the font of the AView. More...
struct	ass::Margin
	Controls view's margins. More...
struct	ass::MaxSize
	Controls the max size of AView. More...
struct	ass::MinSize
	Controls the min size of AView. More...
struct	ass::Opacity
	Controls the opacity of AView. More...
struct	ass::Padding
	Controls the padding of AView. More...
struct	ass::ScrollbarAppearance
	Controls how do scrollbars and content appear in AScrollArea. This rule is applicable to AScrollArea only. More...
struct	ass::TextBorder
	Controls the text border of AView. More...
struct	ass::TextColor
	Controls the text color of AView. More...
struct	ass::TextShadow
	Controls the text shadow of AView. More...
struct	ass::TransformOffset
	Controls the rendering offset transform of AView. More...
struct	ass::TransformRotate
	Controls the rendering offset transform of AView. More...
struct	ass::TransformScale
	Controls the rendering scale transform of AView. More...
class	ACursor
	Represents cursor type. More...

Enumerations
enum class	ass::Sizing {   Sizing::NONE , Sizing::FIT , Sizing::CENTER , Sizing::TILE ,   Sizing::FIT_PADDING , Sizing::COVER , Sizing::CONTAIN , Sizing::CONTAIN_PADDING ,   Sizing::SPLIT_2X2 , Sizing::CROPPED }
	Determines sizing rules of a background texture (BackgroundImage). More...
enum class	AFloat { AFloat::NONE , AFloat::LEFT , AFloat::RIGHT }
	Specifies text floating in text wrapping views, i.e, ATextArea, AText. More...
enum class	AOverflow { AOverflow::VISIBLE , AOverflow::HIDDEN , AOverflow::HIDDEN_FROM_THIS }
	Controls visibility of the overflowed contents of AView with AView::drawStencilMask. More...
enum class	ATextOverflow { NONE , ELLIPSIS , CLIP }
	Controls behavior of the overflowed text. Relevant to AAbstractLabel and its derivatives only.
enum class	ATextAlign { LEFT , CENTER , RIGHT , JUSTIFY }
	Controls the text alignment inside AView.
enum class	ImageRendering { PIXELATED , SMOOTH }
	Controls the image rendering type.
enum class	TextTransform { NONE , UPPERCASE , LOWERCASE }
	Controls the text transform of AView.
enum class	VerticalAlign { DEFAULT , MIDDLE }
	Controls the text vertical alignment of AView.
enum class	FontRendering { NEAREST = 0 , ANTIALIASING = 1 , SUBPIXEL = 2 }
	Controls the expanding of AView.

Enumeration Type Documentation

AFloat

enum class AFloat

strong

Specifies text floating in text wrapping views, i.e, ATextArea, AText.

Enumerator
NONE	Entry's default position behaviour.
LEFT	Entry is placed on the row where's it appeared. Entry is snapped to the left border. Other entries are wrapped around this entry.
RIGHT	Entry is placed on the row where's it appeared. Entry is snapped to the right border. Other entries are wrapped around this entry.

Examples

/home/runner/work/aui/aui/aui.views/src/AUI/View/AView.h.

AOverflow

enum class AOverflow

strong

Controls visibility of the overflowed contents of AView with AView::drawStencilMask.

Enumerator
VISIBLE	Overflowed contents are visible.
HIDDEN	Overflowed contents are hidden. Suitable for lists with scroll. Note On GPU accelerated renderer, HIDDEN does 2 extra draw calls thus decreasing performance a little bit. Prefer VISIBLE if possible.
HIDDEN_FROM_THIS	Like HIDDEN, but view's ASS-styled background is also affected by mask.

Examples

/home/runner/work/aui/aui/aui.views/src/AUI/View/AView.h.

Sizing

enum class ass::Sizing

strong

Determines sizing rules of a background texture (BackgroundImage).

Enumerator
NONE	Image is kept in it's original size.
FIT	Resize image to view's area without keeping aspect ratio.
CENTER	Center the image.
TILE	Tile texture. Use with Repeat::X_y.
FIT_PADDING	Resize image to view's content area without keeping aspect ratio.
COVER	Resize image to view's area keeping aspect ratio and cutting of excess parts. Matches CSS background-size: cover.
CONTAIN	Resize image to view's area keeping aspect ratio and keeping space not covered by the image. Matches CSS background-size: contain.
CONTAIN_PADDING	Resize image to view's content area keeping aspect ratio and keeping space not covered by the image. Partially matches CSS background-size: contain.
SPLIT_2X2	Texture divided by 4 parts of the same size, keeping their original size. Useful for textured buttons and inputs in games. When the view is larger than the texture, the free space is covered by stretching the central row (for vertical) and the central column (for horizontal).
CROPPED	Texture is cropped by BackgroundCropping rule.

Function Documentation

AUI_ENUM_FLAG()

AUI_ENUM_FLAG

(

Visibility

)

Controls the visibility of AView.

If set, content of view is shown

If set, view interacts to the mouse

If set, view occupies space in layout

AView is visible and active

AView is invisible but still interacting to the mouse

AView is visible but not interacting to the mouse

AView is invisible, do not interacts to the mouse, but occupy some space in layout

AView is invisible and does not interact with the mouse

AUI_ENUM_VALUES()

AUI_ENUM_VALUES	(	ATextOverflow	,
		ATextOverflow::ELLIPSIS	,
		ATextOverflow::CLIP	)

Controls the behaviour of the default AView::drawStencilMask() implementation.

Controls how does the overflow mask is produced.

Analogous to the -webkit-background-clip CSS rule.

Mask is produced from the (rounded) rect of the AView. The default value.

Mask is produced from the alpha channel of the BackgroundImage.

Helps in creating custom-shaped gradients, textures and effects.

Collaboration diagram for ASS properties: