SComboButton.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Layout/Margin.h"
#include "Styling/SlateColor.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Input/Reply.h"
#include "Widgets/SWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/AppStyle.h"
#include "Widgets/SBoxPanel.h"
#include "Widgets/Input/SMenuAnchor.h"
 
DECLARE_DELEGATE(FOnComboBoxOpened)
 
class SButton;
class SImage;
 
class SComboButton : public SMenuAnchor
{
public:
 
    SLATE_BEGIN_ARGS( SComboButton )
        : _ComboButtonStyle(&FAppStyle::Get().GetWidgetStyle< FComboButtonStyle >( "ComboButton" ))
        , _ButtonStyle(nullptr)
        , _ButtonContent()
        , _MenuContent()
        , _IsFocusable(true)
        , _HasDownArrow(true)
        , _ForegroundColor(FSlateColor::UseStyle())
        , _ButtonColorAndOpacity(FLinearColor::White)
        , _MenuPlacement(MenuPlacement_ComboBox)
        , _HAlign(HAlign_Fill)
        , _VAlign(VAlign_Center)
        , _Method()
        , _CollapseMenuOnParentFocus(false)
        {}
 
        SLATE_STYLE_ARGUMENT( FComboButtonStyle, ComboButtonStyle )
 
        
        SLATE_STYLE_ARGUMENT( FButtonStyle, ButtonStyle )
        
        SLATE_NAMED_SLOT( FArguments, ButtonContent )
        
        
        SLATE_NAMED_SLOT( FArguments, MenuContent )
        
        
        SLATE_EVENT( FOnGetContent, OnGetMenuContent )
        SLATE_EVENT( FOnIsOpenChanged, OnMenuOpenChanged )
        
        SLATE_EVENT( FOnComboBoxOpened, OnComboBoxOpened )
        SLATE_ARGUMENT( bool, IsFocusable )
        SLATE_ARGUMENT( bool, HasDownArrow )
 
        SLATE_ATTRIBUTE( FSlateColor, ForegroundColor )
        SLATE_ATTRIBUTE( FSlateColor, ButtonColorAndOpacity )
        SLATE_ATTRIBUTE( FMargin, ContentPadding )
        SLATE_ATTRIBUTE( EMenuPlacement, MenuPlacement )
        SLATE_ARGUMENT( EHorizontalAlignment, HAlign )
        SLATE_ARGUMENT( EVerticalAlignment, VAlign )
 
        
        SLATE_ARGUMENT( TOptional<EPopupMethod>, Method )
 
        
        SLATE_ARGUMENT(bool, CollapseMenuOnParentFocus)
 
    SLATE_END_ARGS()
 
    // SMenuAnchor interface
    SLATE_API virtual void SetMenuContent(TSharedRef<SWidget> InContent) override;
    // End of SMenuAnchor interface
 
    SLATE_API void SetOnGetMenuContent( FOnGetContent InOnGetMenuContent );
 
    SLATE_API void Construct(const FArguments& InArgs);
 
    void SetMenuContentWidgetToFocus( TWeakPtr<SWidget> InWidgetToFocusPtr )
    {
        WidgetToFocusPtr = InWidgetToFocusPtr;
    }
 
    SLATE_API void SetButtonContentPadding(FMargin InPadding);
 
    SLATE_API void SetHasDownArrow(bool InHasArrowDown);
 
protected:
    SLATE_API virtual FReply OnButtonClicked();
    SLATE_API virtual FReply OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent) override;
 
    SLATE_API FText GetFilteredToolTipText(TAttribute<FText> ToolTipText) const;
 
protected:
    SHorizontalBox::FSlot* ButtonContentSlot;
 
    FOnComboBoxOpened OnComboBoxOpened;
 
    TWeakPtr<SWidget> WidgetToFocusPtr;
 
    const FSlateBrush* MenuBorderBrush;
 
    FMargin MenuBorderPadding;
 
    TWeakPtr<SWidget> ContentWidgetPtr;
 
    bool bIsFocusable;
 
private:
    TSharedPtr<SButton> ButtonPtr;
 
    TSharedPtr<SHorizontalBox> HBox;
 
    TSharedPtr<SImage> ShadowImage;
 
    TSharedPtr<SImage> ForegroundArrowImage;
 
    const FComboButtonStyle* Style;
};