Widget.h File Reference

#include "CoreMinimal.h"
#include "Binding/States/WidgetStateBitfield.h"
#include "UObject/ObjectMacros.h"
#include "FieldNotificationDeclaration.h"
#include "INotifyFieldValueChanged.h"
#include "Misc/Attribute.h"
#include "Templates/SubclassOf.h"
#include "UObject/ScriptMacros.h"
#include "Styling/SlateColor.h"
#include "Layout/Visibility.h"
#include "Layout/Geometry.h"
#include "Widgets/SWidget.h"
#include "Types/SlateStructs.h"
#include "Components/Visual.h"
#include "Styling/SlateBrush.h"
#include "UObject/TextProperty.h"
#include "Components/SlateWrapperTypes.h"
#include "Slate/WidgetTransform.h"
#include "UObject/UObjectThreadContext.h"
#include "GameFramework/PlayerController.h"
#include "Blueprint/WidgetNavigation.h"
#include "Widgets/WidgetPixelSnapping.h"
#include "Widget.generated.h"

Go to the source code of this file.

Classes
class	UWidget

Namespaces
namespace	UMWidget

Macros
#define	UE_HAS_WIDGET_GENERATED_BY_CLASS   (!UE_BUILD_SHIPPING || WITH_EDITOR)
#define	WIDGET_INCLUDE_RELFECTION_METADATA   (!UE_BUILD_SHIPPING || WITH_EDITOR)
#define	PROPERTY_BINDING(ReturnType, MemberName)
#define	BITFIELD_PROPERTY_BINDING(MemberName)
#define	PROPERTY_BINDING_IMPLEMENTATION(Type, MemberName)
#define	GAME_SAFE_OPTIONAL_BINDING(ReturnType, MemberName)   PROPERTY_BINDING(ReturnType, MemberName)
#define	GAME_SAFE_BINDING_IMPLEMENTATION(ReturnType, MemberName)   PROPERTY_BINDING_IMPLEMENTATION(ReturnType, MemberName)
#define	OPTIONAL_BINDING_CONVERT(ReturnType, MemberName, ConvertedType, ConversionFunction)

Enumerations
enum	{ UMWidget::EntryClass , UMWidget::EntryInterface }
enum	{   UMWidget::DesignerRebuild , UMWidget::BindWidget , UMWidget::BindWidgetOptional , UMWidget::OptionalWidget ,   UMWidget::BindWidgetAnim , UMWidget::BindWidgetAnimOptional , UMWidget::IsBindableEvent }
enum class	EWidgetDesignFlags : uint8 {   None = 0 , Designing = 1 << 0 , ShowOutline = 1 << 1 , ExecutePreConstruct = 1 << 2 ,   Previewing = 1 << 3 }

Functions
	ENUM_CLASS_FLAGS (EWidgetDesignFlags)

Macro Definition Documentation

BITFIELD_PROPERTY_BINDING

#define BITFIELD_PROPERTY_BINDING

(

MemberName

)

Value:

    ( MemberName ## Delegate.IsBound() && !IsDesignTime() )     \
    ?                                                           \
        TAttribute< bool >::Create(MemberName ## Delegate.GetUObject(), MemberName ## Delegate.GetFunctionName()) \
    :                                                           \
        TAttribute< bool >(MemberName != 0)

GAME_SAFE_BINDING_IMPLEMENTATION

#define GAME_SAFE_BINDING_IMPLEMENTATION	(		ReturnType,
			MemberName
	)		PROPERTY_BINDING_IMPLEMENTATION(ReturnType, MemberName)

GAME_SAFE_OPTIONAL_BINDING

#define GAME_SAFE_OPTIONAL_BINDING	(		ReturnType,
			MemberName
	)		PROPERTY_BINDING(ReturnType, MemberName)

OPTIONAL_BINDING_CONVERT

#define OPTIONAL_BINDING_CONVERT	(		ReturnType,
			MemberName,
			ConvertedType,
			ConversionFunction
	)

Value:

        ( MemberName ## Delegate.IsBound() && !IsDesignTime() )                             \
        ?                                                                                   \
            TAttribute< ConvertedType >::Create(TAttribute< ConvertedType >::FGetter::CreateUObject(this, &ThisClass::ConversionFunction, TAttribute< ReturnType >::Create(MemberName ## Delegate.GetUObject(), MemberName ## Delegate.GetFunctionName()))) \
        :                                                                                   \
            ConversionFunction(TAttribute< ReturnType >(MemberName))

Helper macro for binding to a delegate or using the constant value when constructing the underlying SWidget, also allows a conversion function to be provided to convert between the SWidget value and the value exposed to UMG.

PROPERTY_BINDING

#define PROPERTY_BINDING	(		ReturnType,
			MemberName
	)

Value:

    ( MemberName ## Delegate.IsBound() && !IsDesignTime() )     \
    ?                                                           \
        TAttribute< ReturnType >::Create(MemberName ## Delegate.GetUObject(), MemberName ## Delegate.GetFunctionName()) \
    :                                                           \
        TAttribute< ReturnType >(MemberName)

PROPERTY_BINDING_IMPLEMENTATION

#define PROPERTY_BINDING_IMPLEMENTATION	(		Type,
			MemberName
	)

Examples

/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

UE_HAS_WIDGET_GENERATED_BY_CLASS

#define UE_HAS_WIDGET_GENERATED_BY_CLASS   (!UE_BUILD_SHIPPING || WITH_EDITOR)

WIDGET_INCLUDE_RELFECTION_METADATA

#define WIDGET_INCLUDE_RELFECTION_METADATA   (!UE_BUILD_SHIPPING || WITH_EDITOR)

Enumeration Type Documentation

EWidgetDesignFlags

enum class EWidgetDesignFlags : uint8

strong

Flags used by the widget designer.

Enumerator
None
Designing
ShowOutline
ExecutePreConstruct
Previewing

Function Documentation

ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS

(

EWidgetDesignFlags

)