Navigation
API > API/Runtime > API/Runtime/Slate
A node in the Docking/Tabbing hierarchy. Any SDockingNode can be either a stack of tabs or a splitter.
| Name | SDockingNode |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Docking/SDockingNode.h |
| Include Path | #include "Framework/Docking/SDockingNode.h" |
Syntax
class SDockingNode : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SDockingNode
- FSlateControlledConstruction → SWidget → SCompoundWidget → SDockingNode
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SDockingNode() |
Framework/Docking/SDockingNode.h |
Structs
| Name | Remarks |
|---|---|
| FOverlayManagement | Tracking for the docking cross, content, and background of the TabStack |
Enums
Public
| Name | Remarks |
|---|---|
| ECleanupRetVal | |
| ELayoutModification | A tab can be removed from a stack when a uset drags it away or when the user closes it |
| RelativeDirection | Direction relative to some DockNode. |
| Type |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FTabManager::FLayoutNode > GatherPersistentLayout() |
Framework/Docking/SDockingNode.h | ||
Type GetNodeType() |
Framework/Docking/SDockingNode.h | ||
float GetSizeCoefficient() |
Framework/Docking/SDockingNode.h | ||
void SetSizeCoefficient
(
float InSizeCoefficient |
Set the coefficient size | Framework/Docking/SDockingNode.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual SDockingNode::ECleanupRetVal CleanUpNodes() |
Framework/Docking/SDockingNode.h | ||
virtual TArray< TSharedRef< SDockTab > > GetAllChildTabs() |
Recursively searches through all children looking for child tabs | Framework/Docking/SDockingNode.h | |
virtual TSharedPtr< SDockingArea > GetDockArea () |
Gets the dock area that this resides in | Framework/Docking/SDockingNode.h | |
virtual TSharedPtr< const SDockingArea > GetDockArea () |
Framework/Docking/SDockingNode.h | ||
virtual float GetNodeMinSize() |
Minimum pixel size for this node when it is a slot in a parent splitter. Zero means no minimum. | Framework/Docking/SDockingNode.h | |
virtual int32 GetNumTabs() |
Gets the number of tabs in all children recursively | Framework/Docking/SDockingNode.h | |
virtual SSplitter::ESizeRule GetSizeRule() |
Should this node auto-size or be a percentage of its parent size; this setting is usually determined by users | Framework/Docking/SDockingNode.h | |
virtual FReply OnUserAttemptingDock
(
SDockingNode::RelativeDirection Direction, |
Attempt to dock the TabWidget from the DragDropEvent next to this node. | Framework/Docking/SDockingNode.h | |
virtual void SetParentNode
(
TSharedRef< SDockingSplitter > InParent |
All DockNodes are aware of their parent DockNode (unless they are a root node; a.k.a DockArea) The parent is set whenever a node is inserted into a docking hierarchy. | Framework/Docking/SDockingNode.h |
Protected
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnLiveTabAdded() |
A live tab was added to this node or one of its descendants | Framework/Docking/SDockingNode.h | |
virtual void OnResized() |
Framework/Docking/SDockingNode.h |