UI

Classes
class	AlignableSlot
class	BaseListboxWidget
class	BasicGraphWidget
class	BlurWidget
class	ButtonSlot
class	ButtonWidget
class	CanvasWidget
class	CanvasWidgetBase
class	CheckBoxWidget
class	ContentWidget
class	EditBoxWidget
class	FrameSlot
class	FrameWidget
class	GenericListboxWidget
class	GridLayoutWidget
class	GridSlot
class	HorizontalLayoutSlot
class	HorizontalLayoutWidget
class	ImageWidget
class	LayoutSlot
class	LayoutWidgetBase
class	MultilineEditBoxWidget
class	OverlaySlot
class	OverlayWidget
class	PanelSlot
class	PanelWidget
class	ProgressBarWidget
class	RenderTargetWidget
class	RichTextWidget
class	RingBufferGraphWidget
class	RTTextureSlot
class	RTTextureWidget
class	ScaleWidget
class	ScriptedWidgetComponent
class	ScriptedWidgetEventHandler
class	ScrollLayoutSlot
class	ScrollLayoutWidget
class	SimpleListboxWidget
	base class, for listboxes with items of the same height More...
class	SizeLayoutSlot
class	SizeLayoutWidget
class	SliderWidget
class	SocketWidget
class	TextListboxWidget
class	TextWidget
class	ThreeStateCheckboxWidget
class	TimeBasedGraphWidget
class	TimeBasedGraphWithAxesWidget
class	UIWidget
class	UniformGridLayoutWidget
class	UniformGridSlot
class	UniversalListboxWidget
class	UserWidget
class	VerticalLayoutSlot
class	VerticalLayoutWidget
class	VideoWidget
class	Widget
class	WidgetManager
class	WindowSlot
class	WindowWidget
class	WorkspaceSlot
class	WorkspaceWidget
class	XComboBoxWidget
class	BaseFuelNode
class	ItemPreviewWidget
class	MapWidget
class	UIInfo
	UIInfo - allows to define UI elements. More...
class	GameWidgetType
class	GameLibWidgetType
class	GameConsoleWidget
class	GraphWidget
class	SmartPanelWidget

Enumerations
enum	ControlID {   NONE , SELECT , BACK , LEFT ,   RIGHT , UP , DOWN , MENU ,   DRAG , TABLEFT , TABRIGHT , RADIALMENU ,   COUNT , NONE , SELECT , BACK ,   LEFT , RIGHT , UP , DOWN ,   MENU , DRAG , TABLEFT , TABRIGHT ,   RADIALMENU , COUNT }
enum	ControlID {   NONE , SELECT , BACK , LEFT ,   RIGHT , UP , DOWN , MENU ,   DRAG , TABLEFT , TABRIGHT , RADIALMENU ,   COUNT , NONE , SELECT , BACK ,   LEFT , RIGHT , UP , DOWN ,   MENU , DRAG , TABLEFT , TABRIGHT ,   RADIALMENU , COUNT }
enum	ImageMaskMode {   REGULAR , INVERTED , RANGE , RANGE_INVERTED ,   REGULAR , INVERTED , RANGE , RANGE_INVERTED }
enum	ImageMaskMode {   REGULAR , INVERTED , RANGE , RANGE_INVERTED ,   REGULAR , INVERTED , RANGE , RANGE_INVERTED }
enum	LayoutHorizontalAlign {   Left , Center , Right , Stretch ,   Left , Center , Right , Stretch }
enum	LayoutHorizontalAlign {   Left , Center , Right , Stretch ,   Left , Center , Right , Stretch }
enum	LayoutSizeMode { Auto , Fill , Auto , Fill }
enum	LayoutSizeMode { Auto , Fill , Auto , Fill }
enum	LayoutVerticalAlign {   Top , Center , Bottom , Stretch ,   Top , Center , Bottom , Stretch }
enum	LayoutVerticalAlign {   Top , Center , Bottom , Stretch ,   Top , Center , Bottom , Stretch }
enum	RenderTargetWidgetBlendMode {   DISABLED , ALPHA_BLEND , ADDITIVE , DISABLED ,   ALPHA_BLEND , ADDITIVE }
enum	RenderTargetWidgetBlendMode {   DISABLED , ALPHA_BLEND , ADDITIVE , DISABLED ,   ALPHA_BLEND , ADDITIVE }
enum	RenderTargetWidgetFormat {   DEFAULT , INHERIT , LDR , LDR_SRGB ,   HDR_LOW , HDR_HIGH , DEFAULT , INHERIT ,   LDR , LDR_SRGB , HDR_LOW , HDR_HIGH }
enum	RenderTargetWidgetFormat {   DEFAULT , INHERIT , LDR , LDR_SRGB ,   HDR_LOW , HDR_HIGH , DEFAULT , INHERIT ,   LDR , LDR_SRGB , HDR_LOW , HDR_HIGH }
enum	VideoCommand {   PLAY , STOP , REWIND , POSITION ,   REPEAT , ISPLAYING , PLAY , STOP ,   REWIND , POSITION , REPEAT , ISPLAYING }
enum	VideoCommand {   PLAY , STOP , REWIND , POSITION ,   REPEAT , ISPLAYING , PLAY , STOP ,   REWIND , POSITION , REPEAT , ISPLAYING }
enum	WidgetFlags {   VISIBLE , CLIPCHILDREN , INHERIT_CLIPPING , DO_NOT_CLIP_RECT ,   DIRTY , IGNORE_CURSOR , INHERIT_COLOR , DISABLED ,   NOFOCUS , NO_PIXEL_PERFECT , BLEND , ADDITIVE ,   SHADOW , NOWRAP , NOFILTER , STRETCH ,   FLIPU , FLIPV , CUSTOMUV , CENTER ,   VCENTER , RALIGN , WRAP_TEXT , NO_LOCALIZATION ,   VISIBLE , CLIPCHILDREN , INHERIT_CLIPPING , DO_NOT_CLIP_RECT ,   DIRTY , IGNORE_CURSOR , INHERIT_COLOR , DISABLED ,   NOFOCUS , NO_PIXEL_PERFECT , BLEND , ADDITIVE ,   SHADOW , NOWRAP , NOFILTER , STRETCH ,   FLIPU , FLIPV , CUSTOMUV , CENTER ,   VCENTER , RALIGN , WRAP_TEXT , NO_LOCALIZATION }
	Widget flags. See enf::Widget::SetFlags(). More...
enum	WidgetFlags {   VISIBLE , CLIPCHILDREN , INHERIT_CLIPPING , DO_NOT_CLIP_RECT ,   DIRTY , IGNORE_CURSOR , INHERIT_COLOR , DISABLED ,   NOFOCUS , NO_PIXEL_PERFECT , BLEND , ADDITIVE ,   SHADOW , NOWRAP , NOFILTER , STRETCH ,   FLIPU , FLIPV , CUSTOMUV , CENTER ,   VCENTER , RALIGN , WRAP_TEXT , NO_LOCALIZATION ,   VISIBLE , CLIPCHILDREN , INHERIT_CLIPPING , DO_NOT_CLIP_RECT ,   DIRTY , IGNORE_CURSOR , INHERIT_COLOR , DISABLED ,   NOFOCUS , NO_PIXEL_PERFECT , BLEND , ADDITIVE ,   SHADOW , NOWRAP , NOFILTER , STRETCH ,   FLIPU , FLIPV , CUSTOMUV , CENTER ,   VCENTER , RALIGN , WRAP_TEXT , NO_LOCALIZATION }
enum	WidgetNavigationRuleType {   ESCAPE , STOP , WRAP , EXPLICIT ,   ESCAPE , STOP , WRAP , EXPLICIT }
enum	WidgetNavigationRuleType {   ESCAPE , STOP , WRAP , EXPLICIT ,   ESCAPE , STOP , WRAP , EXPLICIT }

Detailed Description

Enumeration Type Documentation

ControlID [1/2]

enum ControlID

Enumerator
NONE
SELECT	select/use focused
BACK
LEFT	navigation
RIGHT
UP	call listener when button/key is released
DOWN	call listener when button/key is pressed
MENU	get to main menu
DRAG	probably needed only for consoles
TABLEFT
TABRIGHT
RADIALMENU
COUNT
NONE
SELECT	select/use focused
BACK
LEFT	navigation
RIGHT
UP	call listener when button/key is released
DOWN	call listener when button/key is pressed
MENU	get to main menu
DRAG	probably needed only for consoles
TABLEFT
TABRIGHT
RADIALMENU
COUNT

Definition at line 12 of file ControlID.c.

ControlID [2/2]

enum ControlID

Enumerator
NONE
SELECT	select/use focused
BACK
LEFT	navigation
RIGHT
UP	call listener when button/key is released
DOWN	call listener when button/key is pressed
MENU	get to main menu
DRAG	probably needed only for consoles
TABLEFT
TABRIGHT
RADIALMENU
COUNT
NONE
SELECT	select/use focused
BACK
LEFT	navigation
RIGHT
UP	call listener when button/key is released
DOWN	call listener when button/key is pressed
MENU	get to main menu
DRAG	probably needed only for consoles
TABLEFT
TABRIGHT
RADIALMENU
COUNT

Definition at line 12 of file ControlID.c.

ImageMaskMode [1/2]

enum ImageMaskMode

Enumerator
REGULAR
INVERTED
RANGE
RANGE_INVERTED
REGULAR
INVERTED
RANGE
RANGE_INVERTED

Definition at line 12 of file ImageMaskMode.c.

ImageMaskMode [2/2]

enum ImageMaskMode

Enumerator
REGULAR
INVERTED
RANGE
RANGE_INVERTED
REGULAR
INVERTED
RANGE
RANGE_INVERTED

Definition at line 12 of file ImageMaskMode.c.

LayoutHorizontalAlign [1/2]

enum LayoutHorizontalAlign

Enumerator
Left
Center
Right
Stretch
Left
Center
Right
Stretch

Definition at line 12 of file LayoutHorizontalAlign.c.

LayoutHorizontalAlign [2/2]

enum LayoutHorizontalAlign

Enumerator
Left
Center
Right
Stretch
Left
Center
Right
Stretch

Definition at line 12 of file LayoutHorizontalAlign.c.

LayoutSizeMode [1/2]

enum LayoutSizeMode

LayoutSize enum

Enumerator
Auto
Fill
Auto
Fill

Definition at line 15 of file LayoutSizeMode.c.

LayoutSizeMode [2/2]

enum LayoutSizeMode

Enumerator
Auto
Fill
Auto
Fill

Definition at line 15 of file LayoutSizeMode.c.

LayoutVerticalAlign [1/2]

enum LayoutVerticalAlign

Enumerator
Top
Center
Bottom
Stretch
Top
Center
Bottom
Stretch

Definition at line 12 of file LayoutVerticalAlign.c.

LayoutVerticalAlign [2/2]

enum LayoutVerticalAlign

Enumerator
Top
Center
Bottom
Stretch
Top
Center
Bottom
Stretch

Definition at line 12 of file LayoutVerticalAlign.c.

RenderTargetWidgetBlendMode [1/2]

enum RenderTargetWidgetBlendMode

Enumerator
DISABLED
ALPHA_BLEND
ADDITIVE
DISABLED
ALPHA_BLEND
ADDITIVE

Definition at line 12 of file RenderTargetWidgetBlendMode.c.

RenderTargetWidgetBlendMode [2/2]

enum RenderTargetWidgetBlendMode

Enumerator
DISABLED
ALPHA_BLEND
ADDITIVE
DISABLED
ALPHA_BLEND
ADDITIVE

Definition at line 12 of file RenderTargetWidgetBlendMode.c.

RenderTargetWidgetFormat [1/2]

enum RenderTargetWidgetFormat

Enumerator
DEFAULT	Use currently set main RT format (based on game options).
INHERIT	Use the render target format of currently set render target.
LDR	LDR format (R8G8B8S8).
LDR_SRGB	LDR format (R8G8B8S8_SRGB).
HDR_LOW	HDR format, lower precision (R11G11B10).
HDR_HIGH	HDR format, higher precision (R16G16B16A16).
DEFAULT	Use currently set main RT format (based on game options).
INHERIT	Use the render target format of currently set render target.
LDR	LDR format (R8G8B8S8).
LDR_SRGB	LDR format (R8G8B8S8_SRGB).
HDR_LOW	HDR format, lower precision (R11G11B10).
HDR_HIGH	HDR format, higher precision (R16G16B16A16).

Definition at line 12 of file RenderTargetWidgetFormat.c.

RenderTargetWidgetFormat [2/2]

enum RenderTargetWidgetFormat

Enumerator
DEFAULT	Use currently set main RT format (based on game options).
INHERIT	Use the render target format of currently set render target.
LDR	LDR format (R8G8B8S8).
LDR_SRGB	LDR format (R8G8B8S8_SRGB).
HDR_LOW	HDR format, lower precision (R11G11B10).
HDR_HIGH	HDR format, higher precision (R16G16B16A16).
DEFAULT	Use currently set main RT format (based on game options).
INHERIT	Use the render target format of currently set render target.
LDR	LDR format (R8G8B8S8).
LDR_SRGB	LDR format (R8G8B8S8_SRGB).
HDR_LOW	HDR format, lower precision (R11G11B10).
HDR_HIGH	HDR format, higher precision (R16G16B16A16).

Definition at line 12 of file RenderTargetWidgetFormat.c.

VideoCommand [1/2]

enum VideoCommand

Enumerator
PLAY
STOP
REWIND
POSITION
REPEAT	Bool.
ISPLAYING
PLAY
STOP
REWIND
POSITION
REPEAT	Bool.
ISPLAYING

Definition at line 12 of file VideoCommand.c.

VideoCommand [2/2]

enum VideoCommand

Enumerator
PLAY
STOP
REWIND
POSITION
REPEAT	Bool.
ISPLAYING
PLAY
STOP
REWIND
POSITION
REPEAT	Bool.
ISPLAYING

Definition at line 12 of file VideoCommand.c.

WidgetFlags [1/2]

enum WidgetFlags

Widget flags. See enf::Widget::SetFlags().

Enumerator
VISIBLE	When set, widget and his children are visible.
CLIPCHILDREN	Children will be clipped by regions of this widget.
INHERIT_CLIPPING	Inherits WF_CLIPCHILDREN setting from its parent.
DO_NOT_CLIP_RECT	Clip by rectangle given by some of the previous widgets.
DIRTY	Indicates that a widget is dirty and should be updated.
IGNORE_CURSOR	Widget will ignore query for widget which pointer is pointing to.
INHERIT_COLOR	Inherits transparency from parent Widget.
DISABLED	UI Widget is not enabled.
NOFOCUS	UI Widget will never get focus.
NO_PIXEL_PERFECT	Indicates that a widget position & size is rounded to always be a whole number.
BLEND	Widget will be alpha-blended.
ADDITIVE	Alpha-blending will be additive.
SHADOW	Rendering of image shadow, INTERNAL USE ONLY.
NOWRAP	Image will not be wrapped.
NOFILTER	Image will not be bilinear filtered. Don't filter too small objects.
STRETCH	Image will be used as big, as widget is and will be stretched accordingly. stretch the image to fill the space - does not preserve aspect ratio Float.
FLIPU	Image will be horizontally flipped. Used by enf::ImageWidget and enf::TextWidget.
FLIPV	Image will be vertically flipped. Used by enf::ImageWidget and enf::TextWidget.
CUSTOMUV	UV mapping will be externally set. Usable for special mappings as rotation etc. Used by enf::ImageWidget and enf::TextWidget.
CENTER	Text will be centered.
VCENTER	Text will be vertically centered.
RALIGN	Text will be right aligned.
WRAP_TEXT	Text will be wrapped on horizontal overflow.
NO_LOCALIZATION	Text will not be parsed for string IDs.
VISIBLE	When set, widget and his children are visible.
CLIPCHILDREN	Children will be clipped by regions of this widget.
INHERIT_CLIPPING	Inherits WF_CLIPCHILDREN setting from its parent.
DO_NOT_CLIP_RECT	Clip by rectangle given by some of the previous widgets.
DIRTY	Indicates that a widget is dirty and should be updated.
IGNORE_CURSOR	Widget will ignore query for widget which pointer is pointing to.
INHERIT_COLOR	Inherits transparency from parent Widget.
DISABLED	UI Widget is not enabled.
NOFOCUS	UI Widget will never get focus.
NO_PIXEL_PERFECT	Indicates that a widget position & size is rounded to always be a whole number.
BLEND	Widget will be alpha-blended.
ADDITIVE	Alpha-blending will be additive.
SHADOW	Rendering of image shadow, INTERNAL USE ONLY.
NOWRAP	Image will not be wrapped.
NOFILTER	Image will not be bilinear filtered. Don't filter too small objects.
STRETCH	Image will be used as big, as widget is and will be stretched accordingly. stretch the image to fill the space - does not preserve aspect ratio Float.
FLIPU	Image will be horizontally flipped. Used by enf::ImageWidget and enf::TextWidget.
FLIPV	Image will be vertically flipped. Used by enf::ImageWidget and enf::TextWidget.
CUSTOMUV	UV mapping will be externally set. Usable for special mappings as rotation etc. Used by enf::ImageWidget and enf::TextWidget.
CENTER	Text will be centered.
VCENTER	Text will be vertically centered.
RALIGN	Text will be right aligned.
WRAP_TEXT	Text will be wrapped on horizontal overflow.
NO_LOCALIZATION	Text will not be parsed for string IDs.

Definition at line 13 of file WidgetFlags.c.

WidgetFlags [2/2]

enum WidgetFlags

Enumerator
VISIBLE	When set, widget and his children are visible.
CLIPCHILDREN	Children will be clipped by regions of this widget.
INHERIT_CLIPPING	Inherits WF_CLIPCHILDREN setting from its parent.
DO_NOT_CLIP_RECT	Clip by rectangle given by some of the previous widgets.
DIRTY	Indicates that a widget is dirty and should be updated.
IGNORE_CURSOR	Widget will ignore query for widget which pointer is pointing to.
INHERIT_COLOR	Inherits transparency from parent Widget.
DISABLED	UI Widget is not enabled.
NOFOCUS	UI Widget will never get focus.
NO_PIXEL_PERFECT	Indicates that a widget position & size is rounded to always be a whole number.
BLEND	Widget will be alpha-blended.
ADDITIVE	Alpha-blending will be additive.
SHADOW	Rendering of image shadow, INTERNAL USE ONLY.
NOWRAP	Image will not be wrapped.
NOFILTER	Image will not be bilinear filtered. Don't filter too small objects.
STRETCH	Image will be used as big, as widget is and will be stretched accordingly. stretch the image to fill the space - does not preserve aspect ratio Float.
FLIPU	Image will be horizontally flipped. Used by enf::ImageWidget and enf::TextWidget.
FLIPV	Image will be vertically flipped. Used by enf::ImageWidget and enf::TextWidget.
CUSTOMUV	UV mapping will be externally set. Usable for special mappings as rotation etc. Used by enf::ImageWidget and enf::TextWidget.
CENTER	Text will be centered.
VCENTER	Text will be vertically centered.
RALIGN	Text will be right aligned.
WRAP_TEXT	Text will be wrapped on horizontal overflow.
NO_LOCALIZATION	Text will not be parsed for string IDs.
VISIBLE	When set, widget and his children are visible.
CLIPCHILDREN	Children will be clipped by regions of this widget.
INHERIT_CLIPPING	Inherits WF_CLIPCHILDREN setting from its parent.
DO_NOT_CLIP_RECT	Clip by rectangle given by some of the previous widgets.
DIRTY	Indicates that a widget is dirty and should be updated.
IGNORE_CURSOR	Widget will ignore query for widget which pointer is pointing to.
INHERIT_COLOR	Inherits transparency from parent Widget.
DISABLED	UI Widget is not enabled.
NOFOCUS	UI Widget will never get focus.
NO_PIXEL_PERFECT	Indicates that a widget position & size is rounded to always be a whole number.
BLEND	Widget will be alpha-blended.
ADDITIVE	Alpha-blending will be additive.
SHADOW	Rendering of image shadow, INTERNAL USE ONLY.
NOWRAP	Image will not be wrapped.
NOFILTER	Image will not be bilinear filtered. Don't filter too small objects.
STRETCH	Image will be used as big, as widget is and will be stretched accordingly. stretch the image to fill the space - does not preserve aspect ratio Float.
FLIPU	Image will be horizontally flipped. Used by enf::ImageWidget and enf::TextWidget.
FLIPV	Image will be vertically flipped. Used by enf::ImageWidget and enf::TextWidget.
CUSTOMUV	UV mapping will be externally set. Usable for special mappings as rotation etc. Used by enf::ImageWidget and enf::TextWidget.
CENTER	Text will be centered.
VCENTER	Text will be vertically centered.
RALIGN	Text will be right aligned.
WRAP_TEXT	Text will be wrapped on horizontal overflow.
NO_LOCALIZATION	Text will not be parsed for string IDs.

Definition at line 13 of file WidgetFlags.c.

WidgetNavigationRuleType [1/2]

enum WidgetNavigationRuleType

WidgetNavigationRuleType

Enumerator
ESCAPE
STOP
WRAP
EXPLICIT
ESCAPE
STOP
WRAP
EXPLICIT

Definition at line 15 of file WidgetNavigationRuleType.c.

WidgetNavigationRuleType [2/2]

enum WidgetNavigationRuleType

Enumerator
ESCAPE
STOP
WRAP
EXPLICIT
ESCAPE
STOP
WRAP
EXPLICIT

Definition at line 15 of file WidgetNavigationRuleType.c.