SSubMenuHandler

Wrapper for any widget that is used in a table view that wants to handle sub-menus with the same functionality as a normal multibox menu

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Input/SSubMenuHandler.h

Include

#include "Widgets/Input/SSubMenuHandler.h"

Syntax

class SSubMenuHandler : public SCompoundWidget

Remarks

Wrapper for any widget that is used in a table view that wants to handle sub-menus with the same functionality as a normal multibox menu

Variables

Name Description

Protected variable

TWeakPtr < FActi...

 

ActiveTimerHandle

The handle to the active timer to update the sub-menu state

Protected variable

TWeakPtr < SMenu ...

 

MenuAnchor

For pull-down or sub-menu entries, this stores a weak reference to the menu anchor widget that we'll use to summon the menu

Protected variable

TWeakPtr < class...

 

MenuOwnerWidget

Weak reference back to the MenuOwner widget that owns us

Functions

Name Description

Public function

void

 

CancelPendingSubMenu()

Cancels any open requests to toggle a sub-menu

Public function

void

 

Construct

(
    const FArguments & InArgs,
    TWeakPtr < SMenuOwner > InMenuOwner
)

Public function Const

bool

 

HasSubMenu()

Returns TRUE if there is a sub-menu available for this item

Public function Const

bool

 

IsSubMenuOpen()

Returns TRUE if the sub-menu is open

Public function

void

 

RequestSubMenuToggle

(
    bool bOpenMenu,
    const bool bClobber,
    const bool bImmediate
)

Requests that the sub-menu associated with this widget be toggled on or off.

Public function Const

bool

 

ShouldSubMenuAppearHovered()

Returns whether or the sub-menu entry should appear hovered.

Protected function

EActiveTimer ...

 

UpdateSubMenuState

(
    double InCurrentTime,
    float InDeltaTime,
    bool bWantsOpen
)

One-off delayed active timer to update the open/closed state of the sub menu.

Overridden from SWidget

Name Description

Public function Virtual

void

 

OnMouseEnter

(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
)

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

Public function Virtual

void

 

OnMouseLeave

(
    const FPointerEvent & MouseEvent
)

The system will use this event to notify a widget that the cursor has left it.

Classes

Name

Description

Public struct

FArguments

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback