WidgetBlueprintLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "InputCoreTypes.h"
#include "Templates/SubclassOf.h"
#include "Engine/EngineBaseTypes.h"
#include "UObject/Interface.h"
#include "Input/Events.h"
#include "Styling/SlateBrush.h"
#include "Components/SlateWrapperTypes.h"
#include "Blueprint/DragDropOperation.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "WidgetBlueprintLibrary.generated.h"
 
class UFont;
class UMaterialInstanceDynamic;
class UMaterialInterface;
class USlateBrushAsset;
class UTexture2D;
class UUserWidget;
 
UCLASS(meta=(ScriptName="WidgetLibrary"), MinimalAPI)
class UWidgetBlueprintLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, meta=( WorldContext="WorldContextObject", DisplayName="Create Widget", BlueprintInternalUseOnly="true" ), Category="Widget")
    static UMG_API class UUserWidget* Create(UObject* WorldContextObject, TSubclassOf<class UUserWidget> WidgetType, APlayerController* OwningPlayer);
 
    UFUNCTION(BlueprintCallable, Category="Widget|Drag and Drop", meta=( BlueprintInternalUseOnly="true" ))
    static UMG_API UDragDropOperation* CreateDragDropOperation(TSubclassOf<UDragDropOperation> OperationClass);
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Input", meta=(DisplayName="Set Input Mode UI Only"))
    static UMG_API void SetInputMode_UIOnlyEx(APlayerController* PlayerController, UWidget* InWidgetToFocus = nullptr, EMouseLockMode InMouseLockMode = EMouseLockMode::DoNotLock, const bool bFlushInput = false);
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Input", meta = (DisplayName = "Set Input Mode Game And UI"))
    static UMG_API void SetInputMode_GameAndUIEx(APlayerController* PlayerController, UWidget* InWidgetToFocus = nullptr, EMouseLockMode InMouseLockMode = EMouseLockMode::DoNotLock, bool bHideCursorDuringCapture = true, const bool bFlushInput = false);
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Input")
    static UMG_API void SetInputMode_GameOnly(APlayerController* PlayerController, const bool bFlushInput = false);
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Focus")
    static UMG_API void SetFocusToGameViewport();
 
    UFUNCTION(BlueprintCallable, Category="Painting")
    static UMG_API void DrawBox(UPARAM(ref) FPaintContext& Context, FVector2D Position, FVector2D Size, USlateBrushAsset* Brush, FLinearColor Tint = FLinearColor::White);
 
    UFUNCTION(BlueprintCallable, meta = (AdvancedDisplay = "6"), Category = "Painting")
    static UMG_API void DrawSpline(UPARAM(ref) FPaintContext& Context, FVector2D Start, FVector2D StartDir, FVector2D End, FVector2D EndDir, FLinearColor Tint = FLinearColor::White, float Thickness = 1.0f);
 
    UFUNCTION(BlueprintCallable, meta = (AdvancedDisplay = "4"), Category = "Painting")
    static UMG_API void DrawLine(UPARAM(ref) FPaintContext& Context, FVector2D PositionA, FVector2D PositionB, FLinearColor Tint = FLinearColor::White, bool bAntiAlias = true, float Thickness = 1.0f);
 
    UFUNCTION(BlueprintCallable, meta = (AdvancedDisplay = "3"), Category = "Painting")
    static UMG_API void DrawLines(UPARAM(ref) FPaintContext& Context, const TArray<FVector2D>& Points, FLinearColor Tint = FLinearColor::White, bool bAntiAlias = true, float Thickness = 1.0f);
 
    UFUNCTION(BlueprintCallable, Category="Painting", meta=( DeprecatedFunction, DeprecationMessage = "Use Draw Text instead", DisplayName="Draw String"))
    static UMG_API void DrawText(UPARAM(ref) FPaintContext& Context, const FString& InString, FVector2D Position, FLinearColor Tint = FLinearColor::White);
 
    UFUNCTION(BlueprintCallable, Category="Painting", meta=(DisplayName="Draw Text"))
    static UMG_API void DrawTextFormatted(UPARAM(ref) FPaintContext& Context, const FText& Text, FVector2D Position, UFont* Font, float FontSize = 16.0f, FName FontTypeFace = FName(TEXT("Regular")), FLinearColor Tint = FLinearColor::White);
 
    UFUNCTION(BlueprintPure, Category="Widget|Event Reply")
    static UMG_API FEventReply Handled();
 
    UFUNCTION(BlueprintPure, Category="Widget|Event Reply")
    static UMG_API FEventReply Unhandled();
 
    UFUNCTION(BlueprintPure, meta=( DefaultToSelf="CapturingWidget" ), Category="Widget|Event Reply")
    static UMG_API FEventReply CaptureMouse(UPARAM(ref) FEventReply& Reply, UWidget* CapturingWidget);
 
    UFUNCTION(BlueprintPure, Category="Widget|Event Reply")
    static UMG_API FEventReply ReleaseMouseCapture(UPARAM(ref) FEventReply& Reply);
 
    UFUNCTION( BlueprintPure, Category = "Widget|Event Reply", meta = ( HidePin = "CapturingWidget", DefaultToSelf = "CapturingWidget" ) )
    static UMG_API FEventReply LockMouse( UPARAM( ref ) FEventReply& Reply, UWidget* CapturingWidget );
 
    UFUNCTION( BlueprintPure, Category = "Widget|Event Reply" )
    static UMG_API FEventReply UnlockMouse( UPARAM( ref ) FEventReply& Reply );
 
    UFUNCTION(BlueprintPure, meta= (HidePin="CapturingWidget", DefaultToSelf="CapturingWidget"), Category="Widget|Event Reply")
    static UMG_API FEventReply SetUserFocus(UPARAM(ref) FEventReply& Reply, UWidget* FocusWidget, bool bInAllUsers = false);
 
    UFUNCTION(BlueprintPure, meta = (DeprecatedFunction, DeprecationMessage = "Use SetUserFocus() instead"), Category = "Widget|Event Reply")
    static UMG_API FEventReply CaptureJoystick(UPARAM(ref) FEventReply& Reply, UWidget* CapturingWidget, bool bInAllJoysticks = false);
 
    UFUNCTION(BlueprintPure, meta = (HidePin = "CapturingWidget", DefaultToSelf = "CapturingWidget"), Category = "Widget|Event Reply")
    static UMG_API FEventReply ClearUserFocus(UPARAM(ref) FEventReply& Reply, bool bInAllUsers = false);
 
    UFUNCTION(BlueprintPure, meta = (DeprecatedFunction, DeprecationMessage = "Use ClearUserFocus() instead"), Category = "Widget|Event Reply")
    static UMG_API FEventReply ReleaseJoystickCapture(UPARAM(ref) FEventReply& Reply, bool bInAllJoysticks = false);
 
    UFUNCTION(BlueprintPure, Category="Widget|Event Reply")
    static UMG_API FEventReply SetMousePosition(UPARAM(ref) FEventReply& Reply, FVector2D NewMousePosition);
 
    UFUNCTION(BlueprintPure, meta=( HidePin="WidgetDetectingDrag", DefaultToSelf="WidgetDetectingDrag" ), Category="Widget|Drag and Drop|Event Reply")
    static UMG_API FEventReply DetectDrag(UPARAM(ref) FEventReply& Reply, UWidget* WidgetDetectingDrag, FKey DragKey);
 
    UFUNCTION(BlueprintCallable, meta=( HidePin="WidgetDetectingDrag", DefaultToSelf="WidgetDetectingDrag" ), Category="Widget|Drag and Drop|Event Reply")
    static UMG_API FEventReply DetectDragIfPressed(const FPointerEvent& PointerEvent, UWidget* WidgetDetectingDrag, FKey DragKey);
 
    UFUNCTION(BlueprintPure, Category="Widget|Drag and Drop|Event Reply")
    static UMG_API FEventReply EndDragDrop(UPARAM(ref) FEventReply& Reply);
 
    UFUNCTION(BlueprintPure, BlueprintCosmetic, Category="Widget|Drag and Drop")
    static UMG_API bool IsDragDropping();
 
    UFUNCTION(BlueprintPure, BlueprintCosmetic, Category="Widget|Drag and Drop")
    static UMG_API UDragDropOperation* GetDragDroppingContent();
 
    UFUNCTION(BlueprintCallable, Category="Widget|Drag and Drop")
    static UMG_API void CancelDragDrop();
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API FSlateBrush MakeBrushFromAsset(USlateBrushAsset* BrushAsset);
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API FSlateBrush MakeBrushFromTexture(UTexture2D* Texture, int32 Width = 0, int32 Height = 0);
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API FSlateBrush MakeBrushFromMaterial(UMaterialInterface* Material, int32 Width = 32, int32 Height = 32);
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API UObject* GetBrushResource(const FSlateBrush& Brush);
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API UTexture2D* GetBrushResourceAsTexture2D(const FSlateBrush& Brush);
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API UMaterialInterface* GetBrushResourceAsMaterial(const FSlateBrush& Brush);
 
    UFUNCTION(BlueprintCallable, Category="Widget|Brush")
    static UMG_API void SetBrushResourceToTexture(UPARAM(ref) FSlateBrush& Brush, UTexture2D* Texture);
 
    UFUNCTION(BlueprintCallable, Category="Widget|Brush")
    static UMG_API void SetBrushResourceToMaterial(UPARAM(ref) FSlateBrush& Brush, UMaterialInterface* Material);
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API FSlateBrush NoResourceBrush();
 
    UFUNCTION(BlueprintPure, Category="Widget|Brush")
    static UMG_API UMaterialInstanceDynamic* GetDynamicMaterial(UPARAM(ref) FSlateBrush& Brush);
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Widget|Menu")
    static UMG_API void DismissAllMenus();
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Widget", meta=( WorldContext="WorldContextObject", DeterminesOutputType = "WidgetClass", DynamicOutputParam = "FoundWidgets" ))
    static UMG_API void GetAllWidgetsOfClass(const UObject* WorldContextObject, TArray<UUserWidget*>& FoundWidgets, TSubclassOf<UUserWidget> WidgetClass, bool TopLevelOnly = true);
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Widget", meta = (WorldContext = "WorldContextObject", DeterminesOutputType = "WidgetClass", DynamicOutputParam = "FoundWidgets"))
    static UMG_API void GetAllWidgetsWithInterface(const UObject* WorldContextObject, TArray<UUserWidget*>& FoundWidgets, TSubclassOf<UInterface> Interface, bool TopLevelOnly);
 
    UFUNCTION(BlueprintPure, Category="Widget", meta = (CompactNodeTitle = "->", BlueprintAutocast))
    static UMG_API FInputEvent GetInputEventFromKeyEvent(const FKeyEvent& Event);
 
    UFUNCTION(BlueprintPure, Category="Widget", meta = (CompactNodeTitle = "->", BlueprintAutocast))
    static UMG_API FKeyEvent GetKeyEventFromAnalogInputEvent(const FAnalogInputEvent& Event);
 
    UFUNCTION(BlueprintPure, Category="Widget", meta = ( CompactNodeTitle = "->", BlueprintAutocast ))
    static UMG_API FInputEvent GetInputEventFromCharacterEvent(const FCharacterEvent& Event);
 
    UFUNCTION(BlueprintPure, Category="Widget", meta = ( CompactNodeTitle = "->", BlueprintAutocast ))
    static UMG_API FInputEvent GetInputEventFromPointerEvent(const FPointerEvent& Event);
 
    UFUNCTION(BlueprintPure, Category="Widget", meta = ( CompactNodeTitle = "->", BlueprintAutocast ))
    static UMG_API FInputEvent GetInputEventFromNavigationEvent(const FNavigationEvent& Event);
 
    UFUNCTION(BlueprintCallable, Category="Widget|Safe Zone", meta=( WorldContext="WorldContextObject" ))
    static UMG_API void GetSafeZonePadding(const UObject* WorldContextObject, FVector4& SafePadding, FVector2D& SafePaddingScale, FVector4& SpillOverPadding);
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category = "Widget|Accessibility", meta = (AdvancedDisplay = "3"))
    static UMG_API void SetColorVisionDeficiencyType(EColorVisionDeficiency Type, float Severity, bool CorrectDeficiency, bool ShowCorrectionWithDeficiency);
 
    UFUNCTION(BlueprintCallable, Category="Widget|Hardware Cursor", meta=( WorldContext="WorldContextObject" ))
    static UMG_API bool SetHardwareCursor(const UObject* WorldContextObject, EMouseCursor::Type CursorShape, FName CursorName, FVector2D HotSpot);
 
    UFUNCTION(BlueprintCallable, Category = "Widget|Window Title Bar")
    static UMG_API void SetWindowTitleBarState(UWidget* TitleBarContent, EWindowTitleBarMode Mode, bool bTitleBarDragEnabled, bool bWindowButtonsVisible, bool bTitleBarVisible);
 
    UFUNCTION(BlueprintCallable, Category = "Widget|Window Title Bar")
    static UMG_API void RestorePreviousWindowTitleBarState();
 
    DECLARE_DYNAMIC_DELEGATE(FOnGameWindowCloseButtonClickedDelegate);
 
    UFUNCTION(BlueprintCallable, Category = "Widget|Window Title Bar")
    static UMG_API void SetWindowTitleBarOnCloseClickedDelegate(FOnGameWindowCloseButtonClickedDelegate Delegate);
 
    UFUNCTION(BlueprintCallable, Category = "Widget|Window Title Bar")
    static UMG_API void SetWindowTitleBarCloseButtonActive(bool bActive);
};