Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > KismetWidgets > SPinTypeSelector

Light Theme

Dark Theme

SPinTypeSelector

Widget for modifying the type for a variable or pin

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SPinTypeSelector

References

Module	KismetWidgets
Header	/Engine/Source/Editor/KismetWidgets/Public/SPinTypeSelector.h
Include	#include "SPinTypeSelector.h"

Syntax

class SPinTypeSelector : public SCompoundWidget

Remarks

Widget for modifying the type for a variable or pin

Variables

	Name	Description
TArray< FObject...	AllowedObjectReferenceTypes	Holds a cache of the allowed Object Reference types for the last sub-menu opened.
bool	bIsRightMousePressed	TRUE when the right mouse button is pressed, keeps from handling a right click that does not begin in the widget
bool	bMenuContentIsSecondary	True if GetMenuContent was last called with bForSecondaryType == true
TArray< FPinTyp...	FilteredTypeTreeRoot	Array containing a filtered list, according to the text in the searchbox
TSharedPtr< SSe...	FilterTextBox
FGetPinTypeTree	GetPinTypeTree	Delegate for the type selector to retrieve the pin type tree (passed into the Construct so the tree can depend on the situation)
TSharedPtr< SMe...	MenuContent	Reference to the menu content that's displayed when the type button is clicked on
FOnPinTypeChang...	OnTypeChanged	Delegate that is called every time the pin type changes (before and after).
FOnPinTypeChang...	OnTypePreChanged
TWeakPtr< SMenu...	PinTypeSelectorMenuOwner
UEdGraphSchema_...	Schema	Schema in charge of determining available types for this pin
FText	SearchText	Type searching support
TSharedPtr< SCo...	SecondaryTypeComboButton
ESelectorType	SelectorType	Whether the selector is using the compact or full mode, or not a selector at all, but just the type image.
TAttribute< FEd...	TargetPinType	The pin attribute that we're modifying with this widget
TAttribute< FOp...	TreeViewHeight	Desired height of the tree view widget
TAttribute< FOp...	TreeViewWidth	Desired width of the tree view widget
TSharedPtr< SCo...	TypeComboButton
ETypeTreeFilter	TypeTreeFilter	UEdgraphSchema::ETypeTreeFilter flags for filtering available types
TArray< FPinTyp...	TypeTreeRoot	Array containing the unfiltered list of all supported types this pin could possibly have
TSharedPtr< SPi...	TypeTreeView
TWeakPtr< SList...	WeakListView

Functions

	Name	Description
void	Construct ( const FArguments& InArgs, FGetPinTypeTree GetPinTypeTreeFunc )
TSharedRef< ...	ConstructPinTypeImage ( UEdGraphPin* Pin )
TSharedRef< ...	ConstructPinTypeImage ( TAttribute< const FSlateBrush..., TAttribute< FSlateColor > PrimaryCo..., TAttribute< const FSlateBrush..., TAttribute< FSlateColor > Secondary... )
TSharedRef< ...	ConstructPinTypeImage ( const FSlateBrush* PrimaryIcon, const FSlateColor& PrimaryColor, const FSlateBrush* SecondaryIc..., const FSlateColor& SecondaryColor, TSharedPtr< SToolTip > InToolTip )
TSharedRef< ...	CreateObjectReferenceWidget ( FPinTypeTreeItem InItem, FEdGraphPinType& InPinType, const FSlateBrush* InIconBrush, FText InSimpleTooltip )	Helper function to create widget for the sub-menu
TSharedRef< ...	GenerateObjectReferenceTreeRow ( FObjectReferenceListItem InItem, const TSharedRef< STableViewBase > ... )	Listview support functions for sub-menu
TSharedRef< ...	GenerateTypeTreeRow ( FPinTypeTreeItem InItem, const TSharedRef< STableViewBase > ..., bool bForSecondaryType )	Treeview support functions
TSharedRef< ...	GetAllowedObjectTypes ( FPinTypeTreeItem InItem, bool bForSecondaryType )	Gets the allowable object types for an tree item, used for building the sub-menu
bool	GetChildrenMatchingSearch ( const FText& SearchText, const TArray< FPinTypeTreeItem >& ..., TArray< FPinTypeTreeItem >& OutFil... )	Helper to generate the filtered list of types, based on the search string matching
TSharedRef< ...	GetMenuContent ( bool bForSecondaryType )
FText	GetSecondaryTypeDescription()	Gets the secondary type description. E.g. the value type for TMaps
FSlateColor	GetSecondaryTypeIconColor()	Gets the secondary type-specific color for the type being manipulated
const FSlate...	GetSecondaryTypeIconImage()	Gets the secondary icon (for maps, otherwise null) for the type being manipulated
FText	GetToolTipForArrayWidget()	Callback to get the tooltip for the array button widget
FText	GetToolTipForComboBoxSecondaryType()	Callback to get the tooltip text for the secondary pin type combo box
FText	GetToolTipForComboBoxType()	Callback to get the tooltip text for the pin type combo box
FText	GetToolTipForContainerWidget()	Callback to get the tooltip for the container type dropdown widget
void	GetTypeChildren ( FPinTypeTreeItem InItem, TArray< FPinTypeTreeItem >& OutChi... )
FText	GetTypeDescription()	Gets a succinct type description for the type being manipulated
FSlateColor	GetTypeIconColor()	Gets the type-specific color for the type being manipulated
const FSlate...	GetTypeIconImage()	Gets the icon (value, array, set, or map) for the type being manipulated
ECheckBoxSta...	IsArrayChecked()	Array checkbox support functions
void	OnArrayCheckStateChanged ( ECheckBoxState NewState )
void	OnArrayStateToggled()	Toggles the variable type as an array
void	OnContainerTypeSelectionChanged ( EPinContainerType PinContainerType )	Updates the variable container type:
void	OnFilterTextChanged ( const FText& NewText )
void	OnFilterTextCommitted ( const FText& NewText, ETextCommit::Type CommitInfo )
void	OnObjectReferenceSelectionChanged ( FObjectReferenceListItem InItem, ESelectInfo::Type SelectInfo, bool bForSecondaryType )
void	OnSelectPinType ( FPinTypeTreeItem InItem, FName InPinCategory, bool bForSecondaryType )	When a pin type is selected, handle it
void	OnTypeSelectionChanged ( FPinTypeTreeItem Selection, ESelectInfo::Type SelectInfo, bool bForSecondaryType )

Overridden from SWidget

	Name	Description
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.
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.
void	OnMouseLeave ( const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has left it.

Classes

	Name	Description
	FArguments

Enums

	Name	Description
	ESelectorType	Which type of selector should be used: compact or full mode, or not a selector at all, but just the type image.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss