1. Epic GamesDeveloper
  3. SDockTab

SDockTab

A tab widget that also holds on to some content that should be shown when this tab is selected.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Docking

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Include #include "Widgets/Docking/SDockTab.h"

Syntax

class SDockTab : public SBorder

Remarks

A tab widget that also holds on to some content that should be shown when this tab is selected. Intended to be used in conjunction with SDockingTabStack.

Variables

  Type Name Description
Protected variable bool bCanEverClose Determines whether the close button for the tab is shown.
Protected variable bool bShouldAutosize Should this tab be auto-sized based on its content?
Protected variable TSharedRef< SWidget > Content The stuff to show when this tab is selected
Protected variable TAttribute< FMargin > ContentAreaPadding  
Protected variable TSharedPtr< SDockingArea > DraggedOverDockingArea The dock area this tab is currently being dragged over. Used in nomad tabs to change style
Protected variable FCurveSequence FlashTabCurve Animation that causes the tab to flash
Protected variable const FDockTabStyle * GenericTabStyle  
Protected variable TAttribute< FLinearColor > IconColor Color of this tab's icon
Protected variable TSharedPtr< SImage > IconWidget Widget used to show the icon on the tab
Protected variable TSharedPtr< STextBlock > LabelSuffix  
Protected variable TSharedPtr< STextBlock > LabelWidget Widget used to show the label on the tab
Protected variable double LastActivationTime Time this tab was last activated
Protected variable FTabId LayoutIdentifier The tab's layout identifier
Protected variable const FDockTabStyle * MajorTabStyle The styles used to draw the tab in its various states
Protected variable TWeakPtr< FTabManager > MyTabManager The tab manager that created this tab.
Protected variable FCanCloseTab OnCanCloseTab Delegate to execute to determine if we can close this tab
Protected variable FExtendContextMenu OnExtendContextMenu  
Protected variable FOnPersistVisualState OnPersistVisualState Invoked during the Save Visual State pass; gives this tab a chance to save misc info about visual state.
Protected variable FOnTabActivatedCallback OnTabActivated Callback to call when this tab is activated
Protected variable FOnTabClosedCallback OnTabClosed Callback to call when this tab is destroyed
Protected variable FSimpleDelegate OnTabDraggedOverDockArea  
Protected variable FSimpleDelegate OnTabDrawerClosedEvent  
Protected variable FSimpleDelegate OnTabDrawerOpenedEvent  
Protected variable FSimpleDelegate OnTabRelocated  
Protected variable FOnTabRenamed OnTabRenamed Invoked when the tab is renamed
Protected variable TWeakPtr< SDockingTabWell > ParentPtr The tab's parent tab well. Null if it is a floating tab.
Protected variable FCurveSequence SpawnAnimCurve Animation that shows the tab opening up
Protected variable TAttribute< FLinearColor > TabColorScale Color of this tab
Protected variable TAttribute< const FSlateBrush * > TabIcon The icon on the tab
Protected variable TAttribute< FText > TabLabel The label on the tab
Protected variable TAttribute< FText > TabLabelSuffix A second text field at the end of the Label that takes precedence and isn't lost when space is restricted
Protected variable ETabRole TabRole Is this an MajorTab? A tool panel tab?
Protected variable TSharedRef< SWidget > TabWellContentLeft  
Protected variable TSharedRef< SWidget > TabWellContentRight  
Protected variable TSharedRef< SWidget > TitleBarContentRight  

Constructors

  Type Name Description
Public function   Protected constructor; Widgets may only be constructed via a FArguments (i.e.: SNew(SDockTab) )

Functions

  Type Name Description
Public function void

ActivateInParent ( ETabActivationCause InActivationCause
)

 Make this tab active in its tabwell
Public function Const bool  
Public function void

Construct ( const FArguments& InArgs
)

 Construct the widget from the declaration.
Public function void Draws attention to the tab.
Public function void

ExtendContextMenu ( FMenuBuilder& MenuBuilder
)

 Add any entries specific to this tab to the tab context menu
Public function void Flash the tab, used for drawing attention to it
Protected function Const EVisibility  
Protected function Const UE::Slate::FDeprecateVector2DResult  
Protected function Const FText The close button tooltip showing the appropriate close command shortcut
Protected function Const const FSlateBrush *  
Public function TSharedRef< SWidget >  
Public function Const const FSlateBrush * What should the content area look like for this type of tab? Documents, Apps, and Tool Panels have different backgrounds.
Public function Const FMargin Padding around the content when it is presented by the SDockingTabStack
Protected function Const const FDockTabStyle &  
Public function Const TSharedPtr< class SDockingArea > Gets the dock area that this resides in
Protected function Const FSlateColor  
Protected function Const const FSlateBrush *  
Protected function Const float Get the desired color of tab. These change during flashing.
Protected function Const FSlateColor  
Protected function Const const FSlateBrush *  
Public function double Returns the time this tab was last activated
Public function Const const FTabId Gets this tab's layout identifier
Public function TSharedRef< SWidget >  
Public function Const float The width that this tab will overlap with side-by-side tabs.
Public function Const TSharedPtr< SDockingTabWell > Gets the tab's tab well parent, or nothing, if it has none
Public function Const TSharedPtr< SDockingTabStack > Gets the dock tab stack this dockable tab resides within, if any
Public function Const TSharedPtr< SWindow > Get the window in which this tab's tabmanager has placed it
Public function TSharedRef< SWidget >  
Protected function Const FSlateColor  
Public function Const const FSlateBrush * Gets the tab icon
Protected function Const FMargin  
Protected function Const TOptional< FVector2D >  
Public function Const FText The label on the tab
Public function Const FText Get Label Suffix
Public function Const TSharedPtr< FTabManager > Get the tab manager currently managing this tab.
Protected function Const FMargin  
Public function Const ETabRole Is this an MajorTab? A tool panel tab?
Public function Const const FSlateBrush * Depending on the tabs we put into the tab well, we want a different background brush.
Public function TSharedRef< SWidget >  
Public function Const ETabRole Similar to GetTabRole() but returns the correct role for UI style and user input purposes
Protected function Const EVisibility  
Public function Const bool

HasSiblingTab ( const FTabId& SiblingTabId,
const bool TreatIndexNoneAsWildcard
)

 Check to see whether this tab has a sibling tab with the given tab ID
Public function Const bool  
Public function Const bool  
Protected function FReply Called when the close button is clicked on the tab.
Public function void A chance for the tab's content to save any internal layout info
Public function void Play an animation showing this tab as opening
Protected function void

ProvideDefaultIcon ( const FSlateBrush* InDefaultIcon
)

 Provide a default tab icon.
Public function void

ProvideDefaultLabel ( const FText& InDefaultLabel
)

 Provide a default tab label in case the spawner did not set one.
Public function void Pulls this tab out of it's parent tab stack and destroys it Note: This does not check if its safe to remove the tab.
Public function bool Requests that the tab be closed. Tabs may prevent closing depending on their state
Public function void

SetCanCloseTab ( const FCanCloseTab& InOnTabClosing
)

 Set the handler to be invoked when the user requests that this tab be closed.
Public function void

SetDraggedOverDockArea ( const TSharedPtr< SDockingArea >& Area
)

 Used by the drag/drop operation to signal to this tab what it is dragging over.
Public function void

SetLabel ( const TAttribute< FText >& InTabLabel
)

 The label that appears on the tab.
Protected function void

SetLayoutIdentifier ( const FTabId& TabId
)

 Specify the TabId that was used to spawn this tab.
Public function void

SetLeftContent ( TSharedRef< SWidget > InContent
)

 Content that appears in the TabWell to the left of the tabs
Public function void Set the handler for extending the tab context menu
Public function void Set the custom code to execute for saving visual state in this tab.
Public function void Set the handler that will be invoked when the tab is activated
Public function void

SetOnTabClosed ( const FOnTabClosedCallback& InDelegate
)

 Set the handler that will be invoked when the tab is closed
Public function void

SetOnTabDraggedOverDockArea ( const FSimpleDelegate InDelegate
)

 Set the handler that will be invoked when the tab is dragged over dock area
Public function void

SetOnTabDrawerClosed ( const FSimpleDelegate InDelegate
)

 Set the handler that will be invoked when the tab is closed from a drawer
Public function void

SetOnTabDrawerOpened ( const FSimpleDelegate InDelegate
)

 Set the handler that will be invoked when the tab is opened from a drawer
Public function void

SetOnTabRelocated ( const FSimpleDelegate InDelegate
)

 Set the handler that will be invoked when the tab is relocated to a new tab well
Public function void

SetOnTabRenamed ( const FOnTabRenamed& InDelegate
)

 Set the handler that will be invoked when the tab is renamed
Public function void

SetParent ( TSharedPtr< SDockingTabWell > Parent
)

 Sets the tab's tab well parent, or resets it if nothing is passed in
Public function void

SetParentDockTabStackTabWellHidden ( bool bIsTabWellHidden
)

  
Public function void Content that appears in the TabWell to the right of the tabs
Public function void

SetShouldAutosize ( const bool bNewShouldAutosize
)

 Set whether this tab should be sized based on its content.
Public function void

SetTabIcon ( const TAttribute< const FSlateBrush* > InTabIcon
)

 Sets the tab icon
Public function void

SetTabLabelSuffix ( const TAttribute< FText >& InTabLabelSuffix
)

 Set Label Suffix.
Public function void

SetTabManager ( const TSharedPtr< FTabManager >& InTabManager
)

 Set the tab manager that is controlling this tab
Public function void

SetTabToolTipWidget ( TSharedPtr< SToolTip > InTabToolTipWidget
)

 The tooltip text that appears on the tab.
Public function void Content that appears on the right side of the title bar in the window this stack is in
Public function Const bool Should this tab be sized based on its content.
Public function void Updates the 'last activated' time to the current time

Overridden from SBorder

  Type Name Description
Public function Virtual void

SetContent ( TSharedRef< SWidget > InContent
)

 Sets the content for this border

Overridden from SWidget

  Type Name Description
Public function Virtual Const FSlateColor  
Public function Virtual FReply

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

 Called when Slate detects that a widget started to be dragged.
Public function Virtual void

OnDragEnter ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
Public function Virtual void

OnDragLeave ( const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the drag leaves a widget.
Public function Virtual FReply

OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual FReply

OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when a mouse button is double clicked. Override this in derived classes.
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 FReply

OnTouchEnded ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is ended (finger lifted)
Public function Virtual FReply

OnTouchStarted ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is started (finger down)

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
FCanCloseTab Delegate called before a tab is closed. Returning false will prevent the tab from closing
FExtendContextMenu Invoked to add entries to the tab context menu
FOnPersistVisualState Invoked w`en this tab should save some information about its content.
FOnTabActivatedCallback Invoked when a tab is activated
FOnTabClosedCallback Invoked when a tab is closing
FOnTabRenamed Invoked when a tab is renamed

Deprecated Functions

  Type Name Description
Public function Const TSharedRef< FTabManager > The tab manager is not guaranteed to exist, which will cause GetTabManager() to crash. Use GetTabManagerPtr() instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page