ScaleBoxComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Components/ContentWidget.h"
#include "CoreMinimal.h"
#include "Extensions/UIComponent.h"
#include "UObject/ObjectMacros.h"
#include "Widgets/Layout/SScaleBox.h"
#include "Widgets/SWidget.h"
 
#include "ScaleBoxComponent.generated.h"
 
class SScaleBox;
 
UCLASS(MinimalAPI, Experimental)
class UScaleBoxComponent : public UUIComponent
{
    GENERATED_BODY()
 
public:
    UMG_API void SetStretch(EStretch::Type InStretch);
 
    UMG_API EStretch::Type GetStretch() const;
 
    UMG_API void SetStretchDirection(EStretchDirection::Type InStretchDirection);
 
    UMG_API EStretchDirection::Type GetStretchDirection() const;
 
    UMG_API void SetUserSpecifiedScale(float InUserSpecifiedScale);
 
    UMG_API float GetUserSpecifiedScale() const;
 
    UMG_API void SetIgnoreInheritedScale(bool bInIgnoreInheritedScale);
 
    UMG_API bool IsIgnoreInheritedScale() const;
 
    // Child slot functions:
 
    UMG_API EHorizontalAlignment GetHorizontalAlignment() const;
 
    UMG_API void SetHorizontalAlignment(EHorizontalAlignment InHorizontalAlignment);
 
    UMG_API EVerticalAlignment GetVerticalAlignment() const;
 
    UMG_API void SetVerticalAlignment(EVerticalAlignment InVerticalAlignment);
 
#if WITH_EDITOR
    UMG_API virtual bool CanEditChange(const FProperty* InProperty) const override;
    // TODO vinz: Implement OnDesignerChanged to work for Components. This currently is just a virtual function for UWidgets.
    //UMG_API virtual void OnDesignerChanged(const FDesignerChangedEventArgs& EventArgs) override;
 
// UObject interface
    virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
    // End of UObject interface
#endif // WITH_EDITOR
    
    virtual TSharedRef<SWidget> RebuildWidgetWithContent(const TSharedRef<SWidget> OwnerContent) override;
 
// TODO vinz: Implement OnDesignerChanged to work for Components. This currently is just a virtual function for UWidgets.
//#if WITH_EDITOR
//  TOptional<FVector2D> DesignerSize;
//#endif
 
private:
 
    void SynchronizeProperties(TSharedRef<SScaleBox> ScaleBox);
 
    // Child slot properties
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = "Scale Box Slot", meta = (AllowPrivateAccess = true))
    TEnumAsByte<EHorizontalAlignment> HorizontalAlignment = HAlign_Center;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = "Scale Box Slot", meta = (AllowPrivateAccess = true))
    TEnumAsByte<EVerticalAlignment> VerticalAlignment = VAlign_Center;
 
    // Scale Box properties:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = "Stretching", meta = (AllowPrivateAccess = true))
    TEnumAsByte<EStretch::Type> Stretch = EStretch::ScaleToFit;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = "Stretching", meta = (AllowPrivateAccess = true))
    TEnumAsByte<EStretchDirection::Type> StretchDirection = EStretchDirection::Both;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = "Stretching", meta = (AllowPrivateAccess = true))
    float UserSpecifiedScale = 1.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter="IsIgnoreInheritedScale", Setter, Category = "Stretching", meta = (AllowPrivateAccess = true))
    bool IgnoreInheritedScale = false;
 
    TWeakPtr<SScaleBox> MyScaleBox;
};