1. Epic GamesDeveloper
  3. STabDrawer

STabDrawer

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

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Docking

Inheritance Hierarchy

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

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

Close ()

 Begins an animation which closes the drawer
Public function void

Construct ( const FArguments& InArgs,
TSharedRef< SDockTab > InTab,
TWeakPtr< SWidget > InTabButton,
ETabDrawerOpenDirection InOpenDirection
)

  
Public function Const const TSharedRef< SDockTab >

GetTab ()

  
Public function Const bool  
Public function Const bool

IsOpen ()

  
Public function void

Open ( bool bAnimateOpen
)

 Opens the drawer
Public function void

SetCurrentSize ( float InSize
)

 Sets the current size of the drawer, ignoring any open/close animation

Overridden from SWidget

  Type Name Description
Public function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.
Public function Virtual Const void

OnArrangeChildren ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
)

 Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
Public function Virtual Const FCursorReply

OnCursorQuery ( const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
)

 The system asks each widget under the mouse to provide a cursor. This event is bubbled.
Public function Virtual 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.
Public function Virtual 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.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

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

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
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.
Public function Virtual Const bool SWidget interface

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page