SExpandableArea.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Layout/Visibility.h"
#include "Layout/Margin.h"
#include "Animation/CurveSequence.h"
#include "Styling/SlateColor.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/Reply.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SWidget.h"
#include "Widgets/SCompoundWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Framework/SlateDelegates.h"
 
class SBorder;
class SButton;
 
class SExpandableArea : public SCompoundWidget
{
public:
 
    SLATE_BEGIN_ARGS( SExpandableArea )
        : _Style( &FCoreStyle::Get().GetWidgetStyle<FExpandableAreaStyle>("ExpandableArea") )
        , _BorderBackgroundColor( FLinearColor::White )
        , _BorderImage( FCoreStyle::Get().GetBrush("ExpandableArea.Border") )
        , _BodyBorderBackgroundColor(FLinearColor::White)
        , _BodyBorderImage()
        , _AreaTitle( )
        , _InitiallyCollapsed( false )
        , _MinWidth( 0.0f )
        , _MaxHeight( 0.0f )
        , _AreaTitlePadding(FMargin(0.0f, 0.0f, 3.0f, 0.0f))
        , _HeaderPadding(FMargin(4.0f, 2.0f))
        , _Padding( 1.0f )
        , _AreaTitleFont( FCoreStyle::Get().GetFontStyle("ExpandableArea.TitleFont") )
        , _HeaderCursor( )
        , _AllowAnimatedTransition(true)
        {}
        
        SLATE_STYLE_ARGUMENT( FExpandableAreaStyle, Style )
        SLATE_ATTRIBUTE( FSlateColor, BorderBackgroundColor )
        SLATE_ATTRIBUTE( const FSlateBrush*, BorderImage )
        SLATE_ATTRIBUTE( FSlateColor, BodyBorderBackgroundColor )
        SLATE_ARGUMENT( const FSlateBrush*, BodyBorderImage )
        SLATE_NAMED_SLOT( FArguments, HeaderContent )
        SLATE_NAMED_SLOT( FArguments, BodyContent )
        SLATE_ATTRIBUTE( FText, AreaTitle )
        SLATE_ARGUMENT( bool, InitiallyCollapsed )
        SLATE_ARGUMENT( float, MinWidth )
        SLATE_ARGUMENT( float, MaxHeight )
        SLATE_ATTRIBUTE(FMargin, AreaTitlePadding)
        SLATE_ATTRIBUTE( FMargin, HeaderPadding )
        SLATE_ATTRIBUTE( FMargin, Padding )
        SLATE_EVENT( FOnBooleanValueChanged, OnAreaExpansionChanged )
        SLATE_ATTRIBUTE( FSlateFontInfo, AreaTitleFont )
        SLATE_ATTRIBUTE( TOptional<EMouseCursor::Type>, HeaderCursor )
        SLATE_ARGUMENT(bool, AllowAnimatedTransition)
            
    SLATE_END_ARGS()
 
 
public:
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    virtual bool IsExpanded() const { return !bAreaCollapsed; }
 
    SLATE_API virtual void SetExpanded( bool bExpanded );
 
    SLATE_API virtual void SetExpanded_Animated( bool bExpanded );
 
    SLATE_API virtual bool IsTitleHovered() const;
 
    SLATE_API void SetMaxHeight(float InMaxHeight);
 
    SLATE_API void SetBorderBackgroundColor(const FSlateColor& InBorderColor);
 
    SLATE_API void SetHeaderPadding(FMargin InHeaderPadding);
 
    SLATE_API void SetAreaPadding(FMargin InAreaPadding);
 
    SLATE_API void SetStyle(const FExpandableAreaStyle* InStyle);
 
    SLATE_API void InvalidateStyle();
 
    SLATE_API void InvalidateBorderBrush();
 
    SLATE_API void SetBorderBrush(const FSlateBrush* InBorderBrush);
 
protected:
 
    SLATE_API virtual TSharedRef<SWidget> ConstructHeaderWidget( const FArguments& InArgs, TSharedRef<SWidget> HeaderContent );
 
    SLATE_API virtual EVisibility OnGetContentVisibility() const;
 
    SLATE_API FReply OnHeaderClicked();
 
    SLATE_API virtual void OnToggleContentVisibility();
 
    SLATE_API virtual const FSlateBrush* OnGetCollapseImage() const;
 
    SLATE_API virtual FVector2D GetSectionScale() const;
 
    SLATE_API virtual FVector2D ComputeDesiredSize(float) const override;
 
protected:
 
    const FExpandableAreaStyle* WidgetStyle;
 
    TSharedPtr<SBorder> TitleBorder;
 
    TSharedPtr<SBorder> WidgetBorder;
 
    TSharedPtr<SBorder> BodyBorder;
 
    TSharedPtr<SButton> ExpandingButton;
 
    FCurveSequence RolloutCurve;
 
    FOnBooleanValueChanged OnAreaExpansionChanged;
 
    float MinWidth;
 
    float MaxHeight;
 
    bool bAreaCollapsed;
 
    const FSlateBrush* CollapsedImage;
 
    const FSlateBrush* ExpandedImage;
 
    bool bAllowAnimatedTransition;
 
};