className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
FVisualGraphElement::GetColor
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
[TOptional](API\Runtime\Core\IO\TOptional)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > GetColor() const
|
[] |
|
FVisualGraphElement::GetDisplayName
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
[FName](API\Runtime\Core\UObject\FName) GetDisplayName() const
|
[] |
|
FVisualGraphElement::GetIndex
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
int32 GetIndex() const
|
[] |
|
FVisualGraphElement::GetName
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
[FName](API\Runtime\Core\UObject\FName) GetName() const
|
[] |
|
FVisualGraphElement::GetStyle
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
[TOptional](API\Runtime\Core\IO\TOptional)< EVisualGraphStyle > GetStyle() const
|
[] |
|
FVisualGraphElement::SetColor
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
void SetColor ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) InValue )
|
[] |
|
FVisualGraphElement::GetTooltip
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
[TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > GetTooltip() const
|
[] |
|
FVisualGraphElement::SetStyle
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
void SetStyle ( EVisualGraphStyle InValue )
|
[] |
|
FVisualGraphElement::SetTooltip
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
void SetTooltip ( const [FString](API\Runtime\Core\Containers\FString) & InTooltip ) const
|
[] |
|
FVisualGraphElement::FVisualGraphElement
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
FVisualGraphElement()
|
[] |
|
FVisualGraphElement::~FVisualGraphElement
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
virtual ~FVisualGraphElement()
|
[] |
|
FVisualGraphElement
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphElement.h
|
VisualGraphUtils
|
class FVisualGraphElement
|
[
{
"type": "TOptional<FLin...",
"name": "Color",
"description": ""
},
{
"type": "TOptional<FNam...",
"name": "DisplayName",
"description": ""
},
{
"type": "int32",
"name": "Index",
"description": ""
},
{
"type": "FName",
"name": "Name",
"description": ""
},
{
"type": "TOptional< EVis...",
"name": "Style",
"description": ""
},
{
"type": "TOptional<FStr...",
"name": "Tooltip",
"description": ""
}
] |
|
FVisualGraphNode::DumpDot
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphNode.h
|
FVisualGraphNode.
|
VisualGraphUtils
|
virtual [FString](API\Runtime\Core\Containers\FString) DumpDot ( const [FVisualGraph](API\Developer\VisualGraphUtils\FVisualGraph) * InGraph, int32 InIndendation ) const
|
[] |
FVisualGraphNode::GetShape
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphNode.h
|
VisualGraphUtils
|
[TOptional](API\Runtime\Core\IO\TOptional)< EVisualGraphShape > GetShape() const
|
[] |
|
FVisualGraphNode::SetShape
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphNode.h
|
VisualGraphUtils
|
void SetShape ( EVisualGraphShape InValue )
|
[] |
|
FVisualGraphNode::FVisualGraphNode
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphNode.h
|
VisualGraphUtils
|
FVisualGraphNode()
|
[] |
|
FVisualGraphNode::~FVisualGraphNode
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphNode.h
|
VisualGraphUtils
|
virtual ~FVisualGraphNode()
|
[] |
|
FVisualGraphNode
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphNode.h
|
VisualGraphUtils
|
class FVisualGraphNode : public [FVisualGraphElement](API\Developer\VisualGraphUtils\FVisualGraphElement)
|
[
{
"type": "TOptional< EVis...",
"name": "Shape",
"description": ""
},
{
"type": "int32",
"name": "SubGraphIndex",
"description": ""
}
] |
|
FVisualGraphObjectUtils::TraverseTickOrder
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphObjectUtils.h
|
VisualGraphUtils
|
static [FVisualGraph](API\Developer\VisualGraphUtils\FVisualGraph) TraverseTickOrder ( const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & InObjects )
|
[] |
|
FVisualGraphObjectUtils::TraverseUObjectReferences
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphObjectUtils.h
|
FVisualGraphObjectUtils.
|
VisualGraphUtils
|
static [FVisualGraph](API\Developer\VisualGraphUtils\FVisualGraph) TraverseUObjectReferences ( const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & InObjects, const [TArray](API\Runtime\Core\Containers\TArray)< [UClass](API\Runtime\CoreUObject\UObject\UClass) * > & InClassesToSkip, const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & InOutersToSkip, const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & InOutersToUse, bool bTraverseObjectsInOuter, bool bCollectReferencesBySerialize, bool bRecursive )
|
[] |
FVisualGraphObjectUtils
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraphObjectUtils.h
|
VisualGraphUtils
|
class FVisualGraphObjectUtils
|
[] |
|
FVisualGraphSubGraph::GetNodes
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraph.h
|
VisualGraphUtils
|
const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetNodes() const
|
[] |
|
FVisualGraphSubGraph::GetParentGraphIndex
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraph.h
|
VisualGraphUtils
|
int32 GetParentGraphIndex() const
|
[] |
|
FVisualGraphSubGraph::FVisualGraphSubGraph
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraph.h
|
VisualGraphUtils
|
FVisualGraphSubGraph()
|
[] |
|
FVisualGraphSubGraph::~FVisualGraphSubGraph
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraph.h
|
VisualGraphUtils
|
virtual ~FVisualGraphSubGraph()
|
[] |
|
FVisualGraphSubGraph
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraph.h
|
VisualGraphUtils
|
class FVisualGraphSubGraph : public [FVisualGraphElement](API\Developer\VisualGraphUtils\FVisualGraphElement)
|
[
{
"type": "TArray< int32 >",
"name": "Nodes",
"description": ""
},
{
"type": "int32",
"name": "ParentGraphIndex",
"description": ""
}
] |
|
FVisualGraphSubGraph::DumpDot
|
/Engine/Source/Developer/VisualGraphUtils/Public/VisualGraph.h
|
FVisualGraphSubGraph.
|
VisualGraphUtils
|
virtual [FString](API\Runtime\Core\Containers\FString) DumpDot ( const [FVisualGraph](API\Developer\VisualGraphUtils\FVisualGraph) * InGraph, int32 InIndendation ) const
|
[] |
FEditablePalette::AddCommandToPalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
void AddCommandToPalette ( const [FString](API\Runtime\Core\Containers\FString) CommandNameString )
|
[] |
|
FEditablePalette::GetPaletteCommandNames
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
[TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetPaletteCommandNames() const
|
[] |
|
FEditablePalette::IsInPalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Given a reference to aFUICommandInfo, returns whether it is in the current Palette
|
WidgetRegistration
|
bool IsInPalette ( const [FName](API\Runtime\Core\UObject\FName) CommandName ) const
|
[] |
FEditablePalette::LoadFromConfig
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
void LoadFromConfig()
|
[] |
|
FEditablePalette::RemoveCommandFromPalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
void RemoveCommandFromPalette ( const [FString](API\Runtime\Core\Containers\FString) CommandNameString )
|
[] |
|
FEditablePalette::SaveToConfig
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
void SaveToConfig()
|
[] |
|
FEditablePalette::FEditablePalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
FEditablePalette ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > InLoadToolPaletteAction, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > InAddToPaletteAction, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > InRemoveFromPaletteAction, [FName](API\Runtime\Core\UObject\FName) InEditablePaletteName, FGetEditableToolPaletteConfigManager InGetConfigManager )
|
[] |
|
FEditablePalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
AnFToolPaletteto which you can add and remove actions
|
WidgetRegistration
|
struct FEditablePalette : public [FToolPalette](API\Developer\WidgetRegistration\FToolPalette)
|
[
{
"type": "constTSharedPt...",
"name": "AddToPaletteAction",
"description": "TheFUICommandInfowhich adds an action to this palette"
},
{
"type": "FName",
"name": "EditablePaletteName",
"description": "The (unique) name attached to this palette, enables saving the palette contents into config if provided"
},
{
"type": "FGetEditableToo...",
"name": "GetConfigManager",
"description": "Delegate used to check if we have a config manager and get it"
},
{
"type": "FSimpleDelegate",
"name": "OnPaletteEdited",
"description": "Delegate used byFToolkitBuilderthat is called when an item is added/removed from the palette"
},
{
"type": "TArray<FString...",
"name": "PaletteCommandNameArray",
"description": "TheTArrayof Command names that are the current FuiCommandInfo actions in this Palette"
},
{
"type": "constTSharedPt...",
"name": "RemoveFromPaletteAction",
"description": "TheFUICommandInfowhich removes an action to this palette"
}
] |
FEditableToolPaletteSettings
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilderConfig.h
|
The actual struct that contains the properties saved for an FEditableToolPalette.
|
WidgetRegistration
|
struct FEditableToolPaletteSettings
|
[
{
"type": "TArray<FString...",
"name": "PaletteCommandNames",
"description": ""
}
] |
FToolbarRegistrationArgs::FToolbarRegistrationArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolbarRegistrationArgs.h
|
The constructor forFToolbarRegistrationArgs
|
WidgetRegistration
|
FToolbarRegistrationArgs ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FToolBarBuilder](API\Runtime\Slate\Framework\MultiBox\FToolBarBuilder) > InToolBarBuilder )
|
[] |
FToolbarRegistrationArgs::GenerateWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolbarRegistrationArgs.h
|
Generates theTSharedPtrfor a toolbar
the theTSharedPtrfor a toolbar
|
WidgetRegistration
|
virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget()
|
[] |
FToolElement::GenerateWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
A convenience pass through method to theFToolElementRegistrationArgsGenerateWidget method which generates theTSharedReftheTSharedRefwhich makes up the UI for this tool element
|
WidgetRegistration
|
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget()
|
[] |
FToolbarRegistrationArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolbarRegistrationArgs.h
|
A class that provides theFToolbarRegistrationArgsfor a UE toolbar
|
WidgetRegistration
|
class FToolbarRegistrationArgs : public [FToolElementRegistrationArgs](API\Developer\WidgetRegistration\FToolElementRegistrationArgs)
|
[
{
"type": "TSharedRef<FTo...",
"name": "ToolBarBuilder",
"description": "TheFToolBarBuilderobject used to build up a toolbar widget"
}
] |
FToolElement::SetRegistrationArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Sets theFToolElementRegistrationArgsfor the this tool element to RegistrationArgs
|
WidgetRegistration
|
void SetRegistrationArgs ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FToolElementRegistrationArgs](API\Developer\WidgetRegistration\FToolElementRegistrationArgs) > RegistrationArgs )
|
[] |
FToolElement::FToolElement
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
FToolElementconstructor
|
WidgetRegistration
|
FToolElement ( const [FName](API\Runtime\Core\UObject\FName) InName, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FToolElementRegistrationArgs](API\Developer\WidgetRegistration\FToolElementRegistrationArgs) > InBuilderArgs )
|
[] |
FToolElement
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Represents one Tool Element, and is responsible for displaying the UI for that element
|
WidgetRegistration
|
class FToolElement : public [FToolElementRegistrationKey](API\Developer\WidgetRegistration\FToolElementRegistrationKey), public [TSharedFromThis< FToolElement >](API\Runtime\Core\Templates\TSharedFromThis)
|
[] |
FToolElementRegistrationArgs::GenerateWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Implements the generation of theTSharedPtr
|
WidgetRegistration
|
virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget()
|
[] |
FToolElementRegistrationArgs::ResetWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Resets the widget to its initial state
|
WidgetRegistration
|
virtual void ResetWidget()
|
[] |
FToolElementRegistrationArgs::UpdateWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Updates/reloads this widget. This should be called after a consumer has changed any Data in this
|
WidgetRegistration
|
virtual void UpdateWidget()
|
[] |
FToolElementRegistrationArgs::FToolElementRegistrationArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
The constructor, which takes an EToolElement which will define the type of Tool Element
|
WidgetRegistration
|
FToolElementRegistrationArgs ( EToolElement InToolElementType )
|
[] |
FToolElementRegistrationArgs::~FToolElementRegistrationArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Default destructor in case any subclasses need to provide a destructor
|
WidgetRegistration
|
virtual ~FToolElementRegistrationArgs()
|
[] |
FToolElementRegistrationArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
A class which provides the data necessary to generate a widget. This class should be extended and used to hold whatever information is needed to generate or update the widgets that make up the tool, and implement the virtual widget methods
|
WidgetRegistration
|
class FToolElementRegistrationArgs : public [TSharedFromThis< FToolElementRegistrationArgs >](API\Runtime\Core\Templates\TSharedFromThis)
|
[
{
"type": "const EToolElem...",
"name": "ToolElementType",
"description": "The type of tool element this is Registration args for"
}
] |
FToolElementRegistrationKey::GetKeyString
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
WidgetRegistration
|
[FString](API\Runtime\Core\Containers\FString) GetKeyString()
|
[] |
|
FToolElementRegistrationKey
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Serves as a key into theFToolElementRegistryof FToolElements
|
WidgetRegistration
|
class FToolElementRegistrationKey : public [TSharedFromThis< FToolElementRegistrationKey >](API\Runtime\Core\Templates\TSharedFromThis)
|
[
{
"type": "FName",
"name": "Name",
"description": "TheFNamethat will be part of the compound key for theFToolElementthis denotes"
},
{
"type": "EToolElement",
"name": "ToolElementType",
"description": "The EToolElementType that will be part of the compound key for theFToolElementthis denotes"
}
] |
FToolElementRegistrationKey::FToolElementRegistrationKey
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Constructor forFToolElementRegistrationKey.
|
WidgetRegistration
|
FToolElementRegistrationKey ( [FName](API\Runtime\Core\UObject\FName) InName, EToolElement InToolElementType )
|
[] |
FToolElementRegistry::GenerateWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Generates the widget for the tool element denoted by theFToolElementRegistrationKey, using the specified TSharedPtrif provided (otherwise it will use the default registered registration arguments. If bUpdateRegistrationArgs is set to true and RegistrationArgsSP is not nullptr, the specified registration args will replace the existing ones for the tool element.
|
WidgetRegistration
|
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FToolElementRegistrationKey](API\Developer\WidgetRegistration\FToolElementRegistrationKey) > ToolElementKeySR, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FToolElementRegistrationArgs](API\Developer\WidgetRegistration\FToolElementRegistrationArgs) > RegistrationArgsSP, bool bUpdateRegistrationArgs )
|
[] |
FToolElementRegistry::Get
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
WidgetRegistration
|
static [FToolElementRegistry](API\Developer\WidgetRegistration\FToolElementRegistry) & Get()
|
[] |
|
FToolElementRegistry::GetToolElementSP
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Gets theTSharedPtrfor the givenFToolElementRegistrationKey& tool element key
|
WidgetRegistration
|
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FToolElement](API\Developer\WidgetRegistration\FToolElement) > GetToolElementSP ( [FToolElementRegistrationKey](API\Developer\WidgetRegistration\FToolElementRegistrationKey) & ToolElementKey )
|
[] |
FToolElementRegistry::RegisterElement
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Registers theFToolElementToolElement
|
WidgetRegistration
|
void RegisterElement ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FToolElement](API\Developer\WidgetRegistration\FToolElement) > ToolElement )
|
[] |
FToolElementRegistry::UnregisterElement
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
Unregisters theFToolElementToolElement
|
WidgetRegistration
|
void UnregisterElement ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FToolElement](API\Developer\WidgetRegistration\FToolElement) > ToolElement )
|
[] |
FToolElementRegistry::FToolElementRegistry
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
WidgetRegistration
|
FToolElementRegistry()
|
[] |
|
FToolElementRegistry
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
|
A Registry for FToolElements, where the FToolElements will generate the UI for a certain tool
|
WidgetRegistration
|
class FToolElementRegistry
|
[] |
FToolkitBuilder::AddPalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Adds theFToolPalettePalette to thisFToolkitBuilder
|
WidgetRegistration
|
void AddPalette ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FToolPalette](API\Developer\WidgetRegistration\FToolPalette) > Palette )
|
[] |
FToolkitBuilder::AddPalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Adds theFEditablePalettePalette to thisFToolkitBuilder
|
WidgetRegistration
|
void AddPalette ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEditablePalette](API\Developer\WidgetRegistration\FEditablePalette) > Palette )
|
[] |
FToolkitBuilder::CreateToolbarWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Creates the Toolbar for the widget with the FUICommandInfos that load the Palettes
|
WidgetRegistration
|
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateToolbarWidget() const
|
[] |
ECategoryReclickBehavior
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Used to specify what happens when you click the category button of a category that is already active.
|
WidgetRegistration
|
enum ECategoryReclickBehavior { NoEffect, ToggleOff, TreatAsChanged, }
|
[] |
FToolkitBuilder::GenerateWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Implements the generation of theTSharedPtr
|
WidgetRegistration
|
virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget()
|
[] |
FToolkitBuilder::GetActivePaletteCommandsVisibility
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
the Visibility state of the active palette command buttons
|
WidgetRegistration
|
[EVisibility](API\Runtime\SlateCore\Layout\EVisibility) GetActivePaletteCommandsVisibility() const
|
[] |
FToolkitBuilder::GetActiveToolDisplayName
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
the display name for the active tool
|
WidgetRegistration
|
[FText](API\Runtime\Core\Internationalization\FText) GetActiveToolDisplayName() const
|
[] |
FToolkitBuilder::GetActivePaletteName
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
the name of the Active Palette if one is available, else it returns NAME_NONE
|
WidgetRegistration
|
[FName](API\Runtime\Core\UObject\FName) GetActivePaletteName() const
|
[] |
FToolkitBuilder::GetCommandsForEditablePalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Fills the OutCommandsTArraywithTSharedPtrinstances that are present in theFEditablePaletteEditablePalette
|
WidgetRegistration
|
void GetCommandsForEditablePalette ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FEditablePalette](API\Developer\WidgetRegistration\FEditablePalette) > EditablePalette, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) >> & OutCommands )
|
[] |
FToolkitBuilder::GetLoadPaletteToolbar
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Returns a TSharedPointer to the FToolbarBuilder with the FUICommandInfos that load the Palettes
|
WidgetRegistration
|
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FToolBarBuilder](API\Runtime\Slate\Framework\MultiBox\FToolBarBuilder) > GetLoadPaletteToolbar()
|
[] |
FToolkitBuilder::GetToolPaletteWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Returns a TSharedPointer to the FToolbarBuilder with the FUICommandInfos that load the Palettes
|
WidgetRegistration
|
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetToolPaletteWidget() const
|
[] |
FToolkitBuilder::HasActivePalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Returns true is there is an active palette selected, else it returns false
|
WidgetRegistration
|
bool HasActivePalette() const
|
[] |
FToolkitBuilder::HasSelectedToolSet
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Returns true if the Toolkit builder has some tools that are currently active/selected
|
WidgetRegistration
|
bool HasSelectedToolSet() const
|
[] |
FToolkitBuilder::InitCategoryToolbarContainerWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Initializes the category toolbar container VBox, and the children inside it. On any repeat calls, theSVerticalBoxcreated on the first pass will be emptied and the children repopulated.
|
WidgetRegistration
|
void InitCategoryToolbarContainerWidget()
|
[] |
FToolkitBuilder::InitializeCategoryToolbar
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Initializes the data to necessary to build the category toolbar
|
WidgetRegistration
|
void InitializeCategoryToolbar ( bool InitLoadToolPaletteMap )
|
[] |
FToolkitBuilder::IsActiveToolPalette
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Returns true if theFUICommandInfowith the name CommandName is the active tool palette, else it returns false
|
WidgetRegistration
|
ECheckBoxState IsActiveToolPalette ( [FName](API\Runtime\Core\UObject\FName) CommandName ) const
|
[] |
FToolkitBuilder::RefreshCategoryToolbarWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
RefreshCategoryToolbarWidget refreshes the UI display of the category toolbar
|
WidgetRegistration
|
void RefreshCategoryToolbarWidget()
|
[] |
FToolkitBuilder::ResetWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Cleans up any previously set data in thisFToolkitBuilderand reset the members to their initial values
|
WidgetRegistration
|
virtual void ResetWidget()
|
[] |
FToolkitBuilder::SetActivePaletteCommandsVisibility
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Configure whether or not the tool buttons in the active palette should be visible. This can be dynamically toggled without rebuilding/regenerating the widget.
|
WidgetRegistration
|
void SetActivePaletteCommandsVisibility ( [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) Visibility )
|
[] |
FToolkitBuilder::SetActivePaletteOnLoad
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Loads the palette for theFUICommandInfoCommand on first visit to the mode.
|
WidgetRegistration
|
void SetActivePaletteOnLoad ( const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) * Command )
|
[] |
FToolkitBuilder::SetActiveToolDisplayName
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Sets the display name for the active tool
|
WidgetRegistration
|
void SetActiveToolDisplayName ( [FText](API\Runtime\Core\Internationalization\FText) InActiveToolDisplayName )
|
[] |
FToolkitBuilder::SetCategoryButtonLabelVisibility
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Sets category button label visibility to Visibility. It also reinitializes the category toolbar data, as the toolbar's LabelVisibility member is now stale.
|
WidgetRegistration
|
void SetCategoryButtonLabelVisibility ( [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) Visibility )
|
[] |
FToolkitBuilder::SetCategoryButtonLabelVisibility
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Sets category button label visibility to Visiblity. It also reinitializes the category toolbar data, as the toolbar's LabelVisibility member is now stale.
|
WidgetRegistration
|
void SetCategoryButtonLabelVisibility ( bool bIsCategoryButtonLabelVisible )
|
[] |
ToolRegistry
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
The tool element registry this class will use to register UI tool elements
|
WidgetRegistration
|
static [FToolElementRegistry](API\Developer\WidgetRegistration\FToolElementRegistry) ToolRegistry = FToolElementRegistry::Get();
|
[] |
FToolkitBuilder::UpdateWidget
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
Updates the Toolkit. This should be called after any changes to the data of thisFToolkitBuilder, and the UI will be regenerated to reflect it.
|
WidgetRegistration
|
virtual void UpdateWidget()
|
[] |
FToolkitBuilder::FToolkitBuilder
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
FToolkitBuilder ( const [FToolkitBuilderArgs](API\Developer\WidgetRegistration\FToolkitBuilderArgs) & Args )
|
[] |
|
FToolkitBuilder::FToolkitBuilder
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
FToolkitBuilder ( [FName](API\Runtime\Core\UObject\FName) ToolbarCustomizationName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > ToolkitCommandList, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FToolkitSections](API\Developer\WidgetRegistration\FToolkitSections) > ToolkitSections )
|
[] |
|
FToolkitBuilder
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
TheFToolElementRegistrationArgswhich is specified for Toolkits
|
WidgetRegistration
|
class FToolkitBuilder : public [FToolElementRegistrationArgs](API\Developer\WidgetRegistration\FToolElementRegistrationArgs)
|
[
{
"type": "FSimpleMulticas...",
"name": "OnActivePaletteChanged",
"description": "OnActivePaletteChanged is broadcast when the active palette changes to a different palette"
},
{
"type": "TSharedPtr<FTo...",
"name": "VerticalToolbarElement",
"description": "Returns a TSharedPointer to the FToolbarBuilder with the FUICommandInfos that load the Palettes"
}
] |
FToolkitBuilder::~FToolkitBuilder
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
virtual ~FToolkitBuilder()
|
[] |
|
FToolkitBuilderArgs::FToolkitBuilderArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
FToolkitBuilderArgs ( const [FName](API\Runtime\Core\UObject\FName) & InToolbarCustomizationName )
|
[] |
|
FToolkitSections
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
WidgetRegistration
|
struct FToolkitSections
|
[
{
"type": "TSharedPtr<IDe...",
"name": "DetailsView",
"description": ""
},
{
"type": "TSharedPtr<SWi...",
"name": "Footer",
"description": ""
},
{
"type": "TSharedPtr<STe...",
"name": "ModeWarningArea",
"description": ""
},
{
"type": "TSharedPtr<SWi...",
"name": "ToolPresetArea",
"description": ""
},
{
"type": "TSharedPtr<STe...",
"name": "ToolWarningArea",
"description": ""
}
] |
|
FToolkitBuilderArgs
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h
|
A simple struct to carry initialization data for anFToolkitBuilder
|
WidgetRegistration
|
struct FToolkitBuilderArgs
|
[
{
"type": "bool",
"name": "bShowCategoryButtonLabels",
"description": "If bShowCategoryButtonLabels == true, the category button labels should be, else they are not displayed"
},
{
"type": "FToolkitBuilder...",
"name": "CategoryReclickBehavior",
"description": "Specifies what happens if you click the category button of an already-active catogory"
},
{
"type": "EVisibility",
"name": "SelectedCategoryTitleVisibility",
"description": "If SelectedCategoryTitleVisibility == EVisibility::Visible, the selected category title is visible, else it is not displayed"
},
{
"type": "constFName&",
"name": "ToolbarCustomizationName",
"description": "Name of the toolbar this mode uses and can be used by external systems to customize that mode toolbar"
},
{
"type": "TSharedPtr<FUI...",
"name": "ToolkitCommandList",
"description": "A TSharedPointer to theFUICommandListfor the current mode"
},
{
"type": "TSharedPtr<FTo...",
"name": "ToolkitSections",
"description": "TheFToolkitSectionswhich holds the sections defined for this Toolkit"
}
] |
FToolkitStyle::Get
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
WidgetRegistration
|
static const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) & Get()
|
[] |
|
FToolkitStyle::GetStyleSetName
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
The name used to identity this style set
|
WidgetRegistration
|
virtual const [FName](API\Runtime\Core\UObject\FName) & GetStyleSetName() const
|
[] |
FToolkitStyle::Initialize
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
WidgetRegistration
|
static void Initialize()
|
[] |
|
FToolkitStyle::Shutdown
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
WidgetRegistration
|
static void Shutdown()
|
[] |
|
StyleName
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
WidgetRegistration
|
static [FName](API\Runtime\Core\UObject\FName) StyleName;
|
[] |
|
StyleSet
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
WidgetRegistration
|
static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > StyleSet = nullptr;
|
[] |
|
FToolkitStyle::FToolkitStyle
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
WidgetRegistration
|
FToolkitStyle()
|
[] |
|
FToolkitStyle
|
/Engine/Source/Developer/WidgetRegistration/Public/ToolkitStyle.h
|
FToolkitStyleis theFSlateStyleSetthat defines styles for FToolkitBuilders
|
WidgetRegistration
|
class FToolkitStyle : public [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet)
|
[] |
FToolkitWidgetStyle::GetDefault
|
/Engine/Source/Developer/WidgetRegistration/Public/FToolkitWidgetStyle.h
|
WidgetRegistration
|
static const [FToolkitWidgetStyle](API\Developer\WidgetRegistration\FToolkitWidgetStyle) & GetDefault()
|
[] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.