1. Epic GamesDeveloper
  3. FOperatorStackEditorHeaderBuilder

FOperatorStackEditorHeaderBuilder

Header builder for item

API > API/Plugins > API/Plugins/OperatorStackEditor > API/Plugins/OperatorStackEditor/Builders

References

   
Module OperatorStackEditor
Header /Engine/Plugins/Experimental/OperatorStack/Source/OperatorStack/Public/Builders/OperatorStackEditorHeaderBuilder.h
Include #include "Builders/OperatorStackEditorHeaderBuilder.h"

Syntax

struct FOperatorStackEditorHeaderBuilder

Remarks

Header builder for item

Variables

  Type Name Description
Protected variable bool bDraggable Allow drag operation on this item
Protected variable bool bExpandable Allow expandable header to show the body and footer
Protected variable FLinearColor BorderColor The border color surrounding the item
Protected variable bool bSearchAllowed Allow use of search bar to filter content
Protected variable bool bStartsExpanded Starts expanded or not
Protected variable TSharedPtr< FUICommandList > CommandList Commands executable for this item
Protected variable FName ContextMenuName Context menu available on this item
Protected variable TSharedPtr< SWidget > CustomWidget Widget that overrides the whole stack generated widget
Protected variable const FSlateBrush * Icon On the left
Protected variable FText Label On the left, after to icon
Protected variable TAttribute< FText > MessageBoxText The text content of the message box
Protected variable TAttribute< EOperatorStackEditorMessageType > MessageBoxType The type of message box we want to show
Protected variable TSharedPtr< FCustomDetailsViewItemId > Property On the right, property id to expose in the header
Protected variable TSet< FString > SearchKeywords Keywords to test against search input
Protected variable TSet< FString > SearchPinnedKeywords Pinned keywords for search, will appear below search box, only for root stack
Protected variable FName ToolbarMenuName Menu on the right before property, should not contain a lot of entries and only icons
Protected variable const FSlateBrush * ToolMenuIcon Menu icon in the header
Protected variable FText ToolMenuLabel Menu label in the header as a tooltip and label
Protected variable FName ToolMenuName Menu present in the header for additional actions
Protected variable FText Tooltip Shown on the header

Functions

  Type Name Description
Public function Const const FLinearColor &  
Public function Const const TSharedPtr< FUICommandList > &  
Public function Const const FName &  
Public function Const TSharedPtr< SWidget >  
Public function Const bool  
Public function Const bool  
Public function Const const FSlateBrush *

GetIcon ()

  
Public function Const const FText &  
Public function Const const TAttribute< FText > &  
Public function Const const TAttribute< EOperatorStackEditorMessageType > &  
Public function Const const TSharedPtr< FCustomDetailsViewItemId > &  
Public function Const bool  
Public function Const const TSet< FString > &  
Public function Const const TSet< FString > &  
Public function Const bool  
Public function Const const FName &  
Public function Const const FSlateBrush *  
Public function Const const FText &  
Public function Const const FName &  
Public function Const const FText &  
Public function FOperatorStackEditorHeaderBuilder &

SetBorderColor ( const FLinearColor& InColor
)

 Sets the border color surrounding the item
Public function FOperatorStackEditorHeaderBuilder &

SetCommandList ( TSharedPtr< FUICommandList > InCommands
)

 Sets available commands on this item
Public function FOperatorStackEditorHeaderBuilder &

SetContextMenu ( const FName& InToolMenuName
)

 Sets context menu name on this item
Public function FOperatorStackEditorHeaderBuilder &

SetCustomWidget ( TSharedPtr< SWidget > InWidget
)

 Sets the custom widget replacing the stack generated widget
Public function FOperatorStackEditorHeaderBuilder &

SetDraggable ( bool bInDraggable
)

 Whether the item is draggable
Public function FOperatorStackEditorHeaderBuilder &

SetExpandable ( bool bInExpandable
)

 Whether the item is expandable
Public function FOperatorStackEditorHeaderBuilder &

SetIcon ( const FSlateBrush* InIcon
)

 Set the icon to display for this item header
Public function FOperatorStackEditorHeaderBuilder &

SetLabel ( const FText& InLabel
)

 Set the label to display for this item header
Public function FOperatorStackEditorHeaderBuilder &

SetMessageBox ( const TAttribute< EOperatorStackEditorMessageType >& InType,
const TAttribute< FText >& InText
)

 Sets whether to show a message box in the header for warning, error, success operations
Public function FOperatorStackEditorHeaderBuilder &

SetProperty ( FProperty* InProperty
)

 Set a single property to expose in the header, like a boolean
Public function FOperatorStackEditorHeaderBuilder &

SetSearchAllowed ( bool bInSearchable
)

 Allow search on this item, if the stack header is searchable a search box will appear
Public function FOperatorStackEditorHeaderBuilder &

SetSearchKeywords ( const TSet< FString >& InKeywords
)

 Sets keywords for this item, if the keyword is contained inside this item will show
Public function FOperatorStackEditorHeaderBuilder &

SetSearchPinnedKeywords ( const TSet< FString >& InKeywords
)

 Sets pinned keywords on root item, they will appear on top of the search bar
Public function FOperatorStackEditorHeaderBuilder &

SetStartsExpanded ( bool bInExpanded
)

 Whether the item starts expanded or collapsed
Public function FOperatorStackEditorHeaderBuilder &

SetToolbarMenu ( const FName& InActionMenuName
)

 Set a small menu that contains icon entries on the right
Public function FOperatorStackEditorHeaderBuilder &

SetToolMenu ( const FName& InToolMenuName,
const FText& InToolMenuLabel,
const FSlateBrush* InToolMenuIcon
)

 Set a menu that appears when we press a button with a label and icon in the header
Public function FOperatorStackEditorHeaderBuilder &

SetTooltip ( const FText& InTooltip
)

 Set the tooltip to display for this item header

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page