Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Framework > Docking > STabDrawer

Light Theme

Dark Theme

STabDrawer

A tab drawer is a widget that contains the contents of a widget when that widget is in a sidebar

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

STabDrawer

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Include	#include "Framework/Docking/STabDrawer.h"

Syntax

class STabDrawer : public SCompoundWidget

Remarks

A tab drawer is a widget that contains the contents of a widget when that widget is in a sidebar

Destructors

	Name	Description
	~STabDrawer()

Functions

	Name	Description
void	Close()	Begins an animation which closes the drawer
void	Construct ( const FArguments& InArgs, TSharedRef< SDockTab > InTab, TWeakPtr< SWidget > InTabButton, ETabDrawerOpenDirection InOpenDirec... )
const TShare...	GetTab()
bool	IsClosing()
bool	IsOpen()
void	Open ( bool bAnimateOpen )	Opens the drawer
void	SetCurrentSize ( float InSize )	Sets the current size of the drawer, ignoring any open/close animation

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float LayoutScaleMultiplier )	Compute the ideal size necessary to display this widget.
void	OnArrangeChildren ( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildre... )	Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
FCursorReply	OnCursorQuery ( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent )	The system asks each widget under the mouse to provide a cursor. This event is bubbled.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
void	OnMouseLeave ( const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has left it.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
bool	SupportsKeyboardFocus()	SWidget interface

Classes

	Name	Description
	FArguments