MenuAnchor.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 "Templates/SubclassOf.h"
#include "Widgets/SWidget.h"
#include "Components/ContentWidget.h"
#include "MenuAnchor.generated.h"
 
class SMenuAnchor;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnMenuOpenChangedEvent, bool, bIsOpen);
 
UCLASS(MinimalAPI)
class UMenuAnchor : public UContentWidget
{
    GENERATED_UCLASS_BODY()
 
public:
 
    DECLARE_DYNAMIC_DELEGATE_RetVal(UUserWidget*, FGetUserWidget);
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Menu Anchor")
    TSubclassOf<class UUserWidget> MenuClass;
 
    UE_DEPRECATED(4.26, "Use OnGetUserMenuContentEvent instead, you may need to make the previous binding return an User Widget.")
    UPROPERTY(EditAnywhere, Category = "Events", meta = (DeprecationMessage = "4.26. Use OnGetUserMenuContentEvent instead, you may need to make the previous binding return an User Widget."))
    FGetWidget OnGetMenuContentEvent;
 
    UPROPERTY(EditAnywhere, Category="Events")
    FGetUserWidget OnGetUserMenuContentEvent;
    
    UE_DEPRECATED(5.2, "Direct access to Placement is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Getter, BlueprintSetter = "SetPlacement", Category = "Menu Anchor")
    TEnumAsByte<EMenuPlacement> Placement;
 
    UE_DEPRECATED(5.2, "Direct access to bFitInWindow is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter = "FitInWindow", Getter = "IsFitInWindow", BlueprintSetter = "FitInWindow", Category = "Menu Anchor", meta = (ScriptName = "ShouldFitInWindow"))
    bool bFitInWindow;
 
    UE_DEPRECATED(5.2, "Direct access to ShouldDeferPaintingAfterWindowContent is deprecated. Please use the getter.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter = "IsDeferPaintingAfterWindowContent", AdvancedDisplay, Category = "Menu Anchor")
    bool ShouldDeferPaintingAfterWindowContent;
 
    UE_DEPRECATED(5.2, "Direct access to UseApplicationMenuStack is deprecated. Please use the getter.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter = "IsUseApplicationMenuStack", AdvancedDisplay, Category = "Menu Anchor")
    bool UseApplicationMenuStack;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter = "IsShowMenuBackground", AdvancedDisplay, Category = "Menu Anchor",  meta = (EditCondition = "UseApplicationMenuStack", EditConditionHides, AllowPrivateAccess = "true", DisplayAfter = "UseApplicationMenuStack"))
    bool ShowMenuBackground;
 
public:
    UPROPERTY(BlueprintAssignable, Category="Menu Anchor|Event")
    FOnMenuOpenChangedEvent OnMenuOpenChanged;
 
public:
    //TODO UMG Add Set MenuClass
 
    UFUNCTION(BlueprintCallable, Category = "Menu Anchor")
    UMG_API void SetPlacement(EMenuPlacement InPlacement);
 
    UMG_API EMenuPlacement GetPlacement() const;
 
    UFUNCTION(BlueprintCallable, Category = "Menu Anchor")
    UMG_API void FitInWindow(bool bFit);
 
    UMG_API bool IsFitInWindow() const;
 
    UMG_API bool IsDeferPaintingAfterWindowContent() const;
 
    UMG_API bool IsUseApplicationMenuStack() const;
 
    UMG_API bool IsShowMenuBackground() const;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Menu Anchor")
    UMG_API void ToggleOpen(bool bFocusOnOpen);
 
    UFUNCTION(BlueprintCallable, Category="Menu Anchor")
    UMG_API void Open(bool bFocusMenu);
 
    UFUNCTION(BlueprintCallable, Category="Menu Anchor")
    UMG_API void Close();
 
    UFUNCTION(BlueprintCallable, Category="Menu Anchor")
    UMG_API bool IsOpen() const;
 
    UFUNCTION(BlueprintCallable, Category="Menu Anchor")
    UMG_API bool ShouldOpenDueToClick() const;
 
    UFUNCTION(BlueprintCallable, Category="Menu Anchor")
    UMG_API FVector2D GetMenuPosition() const;
 
    UFUNCTION(BlueprintCallable, Category="Menu Anchor")
    UMG_API bool HasOpenSubMenus() const;
 
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
 
#if WITH_EDITOR
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
 
protected:
 
    // UPanelWidget
    UMG_API virtual void OnSlotAdded(UPanelSlot* Slot) override;
    UMG_API virtual void OnSlotRemoved(UPanelSlot* Slot) override;
    // End UPanelWidget
 
    // UWidget interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    // End of UWidget interface
 
    // Initialize ShouldDeferPaintingAfterWindowContent in the constructor before the SWidget is constructed.
    UMG_API void InitShouldDeferPaintingAfterWindowContent(bool InShouldDeferPaintingAfterWindowContent);
 
    // Initialize UseApplicationMenuStack in the constructor before the SWidget is constructed.
    UMG_API void InitUseApplicationMenuStack(bool InUseApplicationMenuStack);
 
    // Initialize ShowMenuBackground in the constructor before the SWidget is constructed.
    UMG_API void InitShowMenuBackground(bool InShowMenuBackground);
 
protected:
    UMG_API TSharedRef<SWidget> HandleGetMenuContent();
    UMG_API void HandleMenuOpenChanged(bool bIsOpen);
 
protected:
    TSharedPtr<SMenuAnchor> MyMenuAnchor;
};