UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SMenuEntryBlock Class Reference

#include <SMenuEntryBlock.h>

+ Inheritance diagram for SMenuEntryBlock:

Classes

struct  FMenuEntryBuildParams
 

Public Member Functions

 SLATE_BEGIN_ARGS (SMenuEntryBlock)
 
virtual SLATE_API void BuildMultiBlockWidget (const ISlateStyle *StyleSet, const FName &StyleName) override
 
SLATE_API void Construct (const FArguments &InArgs)
 
SLATE_API TSharedRef< SWidgetMakeNewMenuWidget () const
 
- Public Member Functions inherited from SMultiBlockBaseWidget
TSharedPtr< const FMultiBlockGetBlock () const
 
virtual SLATE_API TSharedRef< SWidgetAsWidget () override
 
virtual SLATE_API TSharedRef< const SWidgetAsWidget () const override
 
virtual SLATE_API void SetOwnerMultiBoxWidget (TSharedRef< SMultiBoxWidget > InOwnerMultiBoxWidget) override
 
virtual SLATE_API void SetMultiBlock (TSharedRef< const FMultiBlock > InMultiBlock) override
 
virtual SLATE_API void SetOptionsBlockWidget (TSharedPtr< SWidget > InOptionsBlock) override
 
virtual SLATE_API void SetMultiBlockLocation (EMultiBlockLocation::Type InLocation, bool bInSectionContainsIcons) override
 
virtual SLATE_API EMultiBlockLocation::Type GetMultiBlockLocation () override
 
virtual SLATE_API EMultiBlockLocation::Type GetMultiBlockLocation () const override
 
virtual SLATE_API bool IsInEditMode () const override
 
virtual SLATE_API void OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override
 
virtual SLATE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override
 
virtual SLATE_API FReply OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override
 
- Public Member Functions inherited from SCompoundWidget
const FVector2D GetContentScale () const
 
void SetContentScale (TAttribute< FVector2D > InContentScale)
 
FLinearColor GetColorAndOpacity () const
 
void SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)
 
void SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)
 
virtual SLATECORE_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
virtual SLATECORE_API FChildrenGetChildren () override
 
virtual SLATECORE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const override
 
virtual SLATECORE_API void SetVisibility (TAttribute< EVisibility > InVisibility) override final
 
- Public Member Functions inherited from SWidget
SLATECORE_API int32 Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
virtual SLATECORE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
 
virtual SLATECORE_API FReply OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusLost (const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual SLATECORE_API FReply OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual SLATECORE_API FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const
 
virtual SLATECORE_API TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply) const
 
virtual SLATECORE_API FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual SLATECORE_API bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayerOnVisualizePopup (const TSharedRef< SWidget > &PopupContent)
 
virtual SLATECORE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnDragLeave (const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual SLATECORE_API TOptional< boolOnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual SLATECORE_API TOptional< FVirtualPointerPositionTranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const
 
virtual SLATECORE_API void OnFinishedPointerInput ()
 
virtual SLATECORE_API void OnFinishedKeyInput ()
 
virtual SLATECORE_API FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
virtual SLATECORE_API EWindowZone::Type GetWindowZoneOverride () const
 
bool NeedsPrepass () const
 
SLATECORE_API void SlatePrepass ()
 
SLATECORE_API void SlatePrepass (float InLayoutScaleMultiplier)
 
void SetCanTick (bool bInCanTick)
 
bool GetCanTick () const
 
bool HasRegisteredSlateAttribute () const
 
bool IsAttributesUpdatesEnabled () const
 
const FSlateWidgetPersistentStateGetPersistentState () const
 
const FWidgetProxyHandle GetProxyHandle () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSize () const
 
SLATECORE_API void AssignParentWidget (TSharedPtr< SWidget > InParent)
 
SLATECORE_API bool ConditionallyDetatchParentWidget (SWidget *InExpectedParent)
 
virtual bool ValidatePathToChild (SWidget *InChild)
 
bool IsParentValid () const
 
TSharedPtr< SWidgetGetParentWidget () const
 
TSharedPtr< SWidgetAdvanced_GetPaintParentWidget () const
 
SLATECORE_API FSlateRect CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const
 
bool HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
virtual SLATECORE_API float GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const
 
SLATECORE_API void ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const
 
virtual FChildrenGetAllChildren ()
 
virtual SLATECORE_API bool SupportsKeyboardFocus () const
 
virtual SLATECORE_API bool HasKeyboardFocus () const
 
SLATECORE_API TOptional< EFocusCauseHasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCauseHasAnyUserFocus () const
 
SLATECORE_API bool HasUserFocusedDescendants (int32 UserIndex) const
 
SLATECORE_API bool HasFocusedDescendants () const
 
SLATECORE_API bool HasAnyUserFocusOrFocusedDescendants () const
 
SLATECORE_API bool HasMouseCapture () const
 
SLATECORE_API bool HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual bool IsInteractable () const
 
virtual SLATECORE_API TSharedPtr< IToolTipGetToolTip ()
 
virtual SLATECORE_API void OnToolTipClosing ()
 
SLATECORE_API void EnableToolTipForceField (const bool bEnableForceField)
 
bool HasToolTipForceField () const
 
bool IsHovered () const
 
SLATECORE_API bool IsDirectlyHovered () const
 
EVisibility GetVisibility () const
 
bool IsVolatile () const
 
bool IsVolatileIndirectly () const
 
void ForceVolatile (bool bForce)
 
bool ShouldInvalidatePrepassDueToVolatility ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
void CacheVolatility ()
 
void MarkPrepassAsDirty ()
 
float GetRenderOpacity () const
 
void SetRenderOpacity (float InRenderOpacity)
 
void SetTag (FName InTag)
 
const TOptional< FSlateRenderTransform > & GetRenderTransform () const
 
TOptional< FSlateRenderTransformGetRenderTransformWithRespectToFlowDirection () const
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivotWithRespectToFlowDirection () const
 
void SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivot () const
 
void SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)
 
SLATECORE_API void SetClipping (EWidgetClipping InClipping)
 
EWidgetClipping GetClipping () const
 
SLATECORE_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)
 
EWidgetPixelSnapping GetPixelSnapping () const
 
void SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)
 
FMargin GetCullingBoundsExtension () const
 
void SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)
 
EFlowDirectionPreference GetFlowDirectionPreference () const
 
SLATECORE_API void SetToolTipText (const TAttribute< FText > &ToolTipText)
 
SLATECORE_API void SetToolTipText (const FText &InToolTipText)
 
SLATECORE_API void SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)
 
SLATECORE_API void SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)
 
template<typename MetaDataType >
TSharedPtr< MetaDataType > GetMetaData () const
 
template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > > GetAllMetaData () const
 
template<typename MetaDataType >
void AddMetadata (const TSharedRef< MetaDataType > &AddMe)
 
template<typename MetaDataType >
int32 RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)
 
SLATECORE_API void SetOnMouseButtonDown (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseButtonUp (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseMove (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseDoubleClick (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)
 
virtual SLATECORE_API FString ToString () const
 
SLATECORE_API FString GetTypeAsString () const
 
SLATECORE_API FName GetType () const
 
virtual SLATECORE_API FString GetReadableLocation () const
 
SLATECORE_API FName GetCreatedInLocation () const
 
virtual SLATECORE_API FName GetTag () const
 
virtual SLATECORE_API FSlateColor GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometryGetCachedGeometry () const
 
SLATECORE_API const FGeometryGetTickSpaceGeometry () const
 
SLATECORE_API const FGeometryGetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
virtual bool Advanced_IsWindow () const
 
virtual bool Advanced_IsInvalidationRoot () const
 
virtual const FSlateInvalidationRootAdvanced_AsInvalidationRoot () const
 
SLATECORE_API TSharedRef< FActiveTimerHandleRegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)
 
SLATECORE_API void UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)
 
bool HasActiveTimers () const
 
- Public Member Functions inherited from FSlateControlledConstruction
 FSlateControlledConstruction ()=default
 
virtual ~FSlateControlledConstruction ()=default
 
virtual const FSlateWidgetClassDataGetWidgetClass () const =0
 
void operator delete (void *mem)
 
- Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode > AsShared ()
 
TSharedRef< SWidget const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< SWidget, Mode > AsWeak ()
 
TWeakPtr< SWidget const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

SLATE_API FReply OnMenuItemButtonClicked ()
 
SLATE_API void OnClicked (bool bCheckBoxClicked)
 
SLATE_API bool IsEnabled () const
 
SLATE_API bool IsEnabledDuringEditMode () const
 
SLATE_API void OnCheckStateChanged (const ECheckBoxState NewCheckedState)
 
SLATE_API ECheckBoxState IsChecked () const
 
SLATE_API const FSlateBrushOnGetCheckImage () const
 
virtual SLATE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API void OnMouseLeave (const FPointerEvent &MouseEvent) override
 
virtual SLATE_API FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &KeyEvent) override
 
SLATE_API const FSlateBrushGetMenuBarButtonBorder () const
 
SLATE_API FSlateColor GetMenuBarForegroundColor () const
 
SLATE_API TSharedRef< SWidgetBuildMenuBarWidget (const FMenuEntryBuildParams &InBuildParams)
 
SLATE_API TSharedRef< SWidgetFindTextBlockWidget (TSharedRef< SWidget > Content)
 
SLATE_API TSharedRef< SWidgetBuildMenuEntryWidget (const FMenuEntryBuildParams &InBuildParams)
 
SLATE_API TSharedRef< SWidgetBuildSubMenuWidget (const FMenuEntryBuildParams &InBuildParams)
 
SLATE_API void RequestSubMenuToggle (bool bOpenMenu, const bool bClobber)
 
SLATE_API void CancelPendingSubMenu ()
 
SLATE_API bool ShouldSubMenuAppearHovered () const
 
SLATE_API FText GetFilteredToolTipText (TAttribute< FText > ToolTipText) const
 
SLATE_API EVisibility GetVisibility () const
 
SLATE_API FSlateColor TintOnHover () const
 
SLATE_API FSlateColor InvertOnHover () const
 
- Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D ComputeDesiredSize (float) const override
 
TSlateAttributeRef< FVector2DGetContentScaleAttribute () const
 
TSlateAttributeRef< FLinearColorGetColorAndOpacityAttribute () const
 
TSlateAttributeRef< FSlateColorGetForegroundColorAttribute () const
 
SLATECORE_API SCompoundWidget ()
 
virtual SLATECORE_API ~SCompoundWidget ()
 
- Protected Member Functions inherited from SWidget
void SetVolatilePrepass (bool bVolatile)
 
virtual bool CustomPrepass (float LayoutScaleMultiplier)
 
virtual SLATECORE_API void CacheDesiredSize (float InLayoutScaleMultiplier)
 
void SetHover (TAttribute< bool > InHovered)
 
bool IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const
 
SLATECORE_API void InvalidateChildRemovedFromTree (SWidget &Child)
 
bool Advanced_InvalidateVolatility ()
 
EFlowDirection ComputeFlowDirection () const
 
SLATECORE_API void SetDebugInfo (const ANSICHAR *InType, const ANSICHAR *InFile, int32 OnLine, size_t InAllocSize)
 
virtual SLATECORE_API TOptional< EMouseCursor::TypeGetCursor () const
 
SLATECORE_API SWidget ()
 
SLATECORE_API void SWidgetConstruct (const FSlateBaseNamedArgs &Args)
 
bool IsConstructed () const
 
SLATECORE_API bool FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API void FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API FGeometry FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const
 
bool ShouldBeEnabled (bool InParentEnabled) const
 
virtual SLATECORE_API const FSlateBrushGetFocusBrush () const
 
virtual bool ComputeVolatility () const
 
virtual SLATECORE_API void OnClippingChanged ()
 
float GetPrepassLayoutScaleMultiplier () const
 
SLATECORE_API void Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)
 
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
TSlateAttributeRef< boolGetEnabledStateAttribute () const
 
TSlateAttributeRef< boolGetHoveredAttribute () const
 
TSlateAttributeRef< EVisibilityGetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2DGetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassDataStaticWidgetClass ()
 
- Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32 FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)
 
static SLATECORE_API int32 FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)
 
static TAttribute< EVisibilityAccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)
 
- Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Protected Attributes inherited from SMultiBlockBaseWidget
TWeakPtr< SMultiBoxWidgetOwnerMultiBoxWidget
 
TSharedPtr< const FMultiBlockMultiBlock
 
TSharedPtr< SWidgetOptionsBlockWidget
 
EMultiBlockLocation::Type Location
 
bool bSectionContainsIcons
 
- Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot ChildSlot
 
- Protected Attributes inherited from SWidget
uint8 bCanSupportFocus: 1
 
uint8 bCanHaveChildren: 1
 
uint8 bClippingProxy: 1
 
uint8 bHasCustomPrepass: 1
 
uint8 bHasRelativeLayoutScale: 1
 
uint8 bVolatilityAlwaysInvalidatesPrepass: 1
 
EWidgetClipping Clipping
 
EWidgetPixelSnapping PixelSnappingMethod
 
FMargin CullingBoundsExtension
 
float RenderOpacity
 

Detailed Description

Menu entry MultiBlock widget

Member Function Documentation

◆ BuildMenuBarWidget()

TSharedRef< SWidget > SMenuEntryBlock::BuildMenuBarWidget ( const FMenuEntryBuildParams InBuildParams)
protected

Called to create content for a pull-down menu widget

Parameters
InBuildParamsParameters for how to build the widget
Returns
The widget content for the new menu

◆ BuildMenuEntryWidget()

TSharedRef< SWidget > SMenuEntryBlock::BuildMenuEntryWidget ( const FMenuEntryBuildParams InBuildParams)
protected

Called to create content for a menu entry inside a pull-down, context, or sub-menu

Parameters
InBuildParamsParameters for how to build the widget
Returns
The widget content for the new menu

◆ BuildMultiBlockWidget()

void SMenuEntryBlock::BuildMultiBlockWidget ( const ISlateStyle StyleSet,
const FName StyleName 
)
overridevirtual

Builds this MultiBlock widget up from the MultiBlock associated with it

Implements IMultiBlockBaseWidget.

◆ BuildSubMenuWidget()

TSharedRef< SWidget > SMenuEntryBlock::BuildSubMenuWidget ( const FMenuEntryBuildParams InBuildParams)
protected

Called to create content for a sub-menu widget (entry in a menu that opens another menu to the right of it)

Parameters
InBuildParamsParameters for how to build the widget
Returns
The widget content for the new menu

◆ CancelPendingSubMenu()

void SMenuEntryBlock::CancelPendingSubMenu ( )
protected

Cancels any open requests to toggle a sub-menu

◆ Construct()

void SMenuEntryBlock::Construct ( const FArguments &  InArgs)

Construct this widget

Parameters
InArgsThe declaration data for this widget

◆ FindTextBlockWidget()

TSharedRef< SWidget > SMenuEntryBlock::FindTextBlockWidget ( TSharedRef< SWidget Content)
protected

Finds the STextBlock that gets displayed in the UI

Parameters
ContentWidget to check for an STextBlock
Returns
The STextBlock widget found

◆ GetFilteredToolTipText()

FText SMenuEntryBlock::GetFilteredToolTipText ( TAttribute< FText ToolTipText) const
protected

Called to query the tool tip text for this widget, but will return an empty text for menu bar items when a menu for that menu bar is already open

Parameters
ToolTipTextTool tip text to display, if possible
Returns
Tool tip text, or an empty text if filtered out

◆ GetMenuBarButtonBorder()

const FSlateBrush * SMenuEntryBlock::GetMenuBarButtonBorder ( ) const
protected

Called to get the appropriate border for Buttons on Menu Bars based on whether or not submenu is open

Returns
The appropriate border to use

◆ GetMenuBarForegroundColor()

FSlateColor SMenuEntryBlock::GetMenuBarForegroundColor ( ) const
protected

◆ GetVisibility()

EVisibility SMenuEntryBlock::GetVisibility ( ) const
protected

◆ InvertOnHover()

FSlateColor SMenuEntryBlock::InvertOnHover ( ) const
protected

Get the inverted foreground color when the entry is hovered

◆ IsChecked()

ECheckBoxState SMenuEntryBlock::IsChecked ( ) const
protected

Called by slate to determine if this menu entry should appear checked

Returns
true if it should be checked, false if not.

Called by slate to determine if this menu entry should appear checked

Returns
ECheckBoxState::Checked if it should be checked, ECheckBoxState::Unchecked if not.

◆ IsEnabled()

bool SMenuEntryBlock::IsEnabled ( ) const
protected

Called by Slate to determine if this menu entry is enabled

Returns
True if the menu entry is enabled, false otherwise

◆ IsEnabledDuringEditMode()

bool SMenuEntryBlock::IsEnabledDuringEditMode ( ) const
protected

Called by Slate to determine if this menu entry is enabled (during menu editing)

Returns
True if the menu entry is enabled, false otherwise

◆ MakeNewMenuWidget()

TSharedRef< SWidget > SMenuEntryBlock::MakeNewMenuWidget ( ) const

Called to create content for a pull-down or sub-menu window when it's summoned by the user

Returns
The widget content for the new menu

◆ OnCheckStateChanged()

void SMenuEntryBlock::OnCheckStateChanged ( const ECheckBoxState  NewCheckedState)
protected

Called by Slate when this check box button is toggled in a menu entry

Called by Slate when this menu entry check box button is toggled

◆ OnClicked()

void SMenuEntryBlock::OnClicked ( bool  bCheckBoxClicked)
protected

Called when a checkbox in the menu item or the menu item itself is clicked

Parameters
bCheckBoxClickedtrue if a check box was clicked and not the menu item. We dont close the menu when a check box is clicked

Called by Slate when this menu entry's button is clicked

◆ OnGetCheckImage()

const FSlateBrush * SMenuEntryBlock::OnGetCheckImage ( ) const
protected

In the case that we have an icon to show. This function is called to get the image that indicates the menu item should appear checked If we can show an actual check box, this function is not called

◆ OnKeyDown()

FReply SMenuEntryBlock::OnKeyDown ( const FGeometry MyGeometry,
const FKeyEvent InKeyEvent 
)
overrideprotectedvirtual

Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Parameters
MyGeometryThe Geometry of the widget receiving the event
InKeyEventKey event
Returns
Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnMenuItemButtonClicked()

FReply SMenuEntryBlock::OnMenuItemButtonClicked ( )
protected

Called by Slate when this menu entry's button is clicked

◆ OnMouseEnter()

void SMenuEntryBlock::OnMouseEnter ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overrideprotectedvirtual

The system will use this event to notify a widget that the cursor has entered it. This event is NOT bubbled.

Parameters
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event

Reimplemented from SWidget.

◆ OnMouseLeave()

void SMenuEntryBlock::OnMouseLeave ( const FPointerEvent MouseEvent)
overrideprotectedvirtual

The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

Parameters
MouseEventInformation about the input event

Reimplemented from SWidget.

◆ RequestSubMenuToggle()

void SMenuEntryBlock::RequestSubMenuToggle ( bool  bOpenMenu,
const bool  bClobber 
)
protected

Requests that the sub-menu associated with this widget be toggled on or off. It does not immediately toggle the menu. After a set amount of time is passed the menu will toggle

Parameters
bOpenMenutrue to open the menu, false to close the menu if one is currently open
bClobbertrue if we want to open a menu when another menu is already open

◆ ShouldSubMenuAppearHovered()

bool SMenuEntryBlock::ShouldSubMenuAppearHovered ( ) const
protected

Returns whether or the sub-menu entry should appear hovered. If the sub-menu is open we will always show the menu as hovered to indicate which sub-menu is open In the case that the user is interacting in this menu we do not show the menu as hovered because we need to show what the user is actually selecting

◆ SLATE_BEGIN_ARGS()

SMenuEntryBlock::SLATE_BEGIN_ARGS ( SMenuEntryBlock  )
inline

◆ TintOnHover()

FSlateColor SMenuEntryBlock::TintOnHover ( ) const
protected

Get the selection color when the entry is hovered


The documentation for this class was generated from the following files: