SPinTypeSelector

Widget for modifying the type for a variable or pin

API > API/Editor > API/Editor/KismetWidgets

Widget for modifying the type for a variable or pin

   
Name SPinTypeSelector
Type class
Header File /Engine/Source/Editor/KismetWidgets/Public/SPinTypeSelector.h
Include Path #include "SPinTypeSelector.h"

Syntax

class SPinTypeSelector : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Enums

Public

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs,
FGetPinTypeTree GetPinTypeTreeFunc
)

   SPinTypeSelector.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SPinTypeSelector.h  

virtual FReply OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SPinTypeSelector.h  

virtual void OnMouseLeave ( const FPointerEvent& MouseEvent
)

   SPinTypeSelector.h  

Protected

Name Remarks Include Path Unreal Specifiers

TSharedRef< SWidget > CreateObjectReferenceWidget ( FPinTypeTreeItem InItem,
FEdGraphPinType& InPinType,
const FSlateBrush* InIconBrush,
FText InSimpleTooltip
) const

 Helper function to create widget for the sub-menu SPinTypeSelector.h  

void FilterUnsupportedTypes ( TArray< FPinTypeTreeItem >& UnfilteredList
)

 Helper to generate the filtered list of types, based on the supported types of the schema SPinTypeSelector.h  

void GenerateAllowedObjectTypesList ( TArray< FObjectReferenceListItem >& OutList,
FPinTypeTreeItem InItem,
bool bForSecondaryType
) const

 Fills the provided array with generated list items based on a pin type's allowed reference types, which could then be used as the item source for a list view SPinTypeSelector.h  

TSharedRef< ITableRow > GenerateObjectReferenceTreeRow ( FObjectReferenceListItem InItem,
const TSharedRef< STableViewBase >& OwnerTree
)

 Listview support functions for sub-menu SPinTypeSelector.h  

virtual TSharedRef< ITableRow > GenerateTypeTreeRow ( FPinTypeTreeItem InItem,
const TSharedRef< STableViewBase >& OwnerTree,
bool bForSecondaryType
)

 Treeview support functions SPinTypeSelector.h  

TSharedRef< SWidget > GetAllowedObjectTypes ( FPinTypeTreeItem InItem,
bool bForSecondaryType
)

 Gets the allowable object types for an tree item, used for building the sub-menu SPinTypeSelector.h  

bool GetChildrenMatchingSearch ( const FText& SearchText,
const TArray< FPinTypeTreeItem >& UnfilteredList,
TArray< FPinTypeTreeItem >& OutFilteredList,
FTopLevenshteinResult< FPinTypeTreeItem >& OutTopLevenshteinResult
)

 Helper to generate the filtered list of types, based on the search string matching SPinTypeSelector.h  

FText GetCombinedTypeDescription ( bool bIncludeSubcategory
) const

 Gets a combined description of the primary, container, and secondary types. SPinTypeSelector.h  

virtual TSharedRef< SWidget > GetMenuContent ( bool bForSecondaryType
)

   SPinTypeSelector.h  

TSharedRef< SWidget > GetPinContainerTypeMenuContent()

   SPinTypeSelector.h  

FText GetPinTypeItemCountText()

 Callback to get the display text for the total pin type item count SPinTypeSelector.h  

FText GetSecondaryTypeDescription ( bool bIncludeSubcategory
) const

 Gets the secondary type description. E.g. the value type for TMaps SPinTypeSelector.h  

FSlateColor GetSecondaryTypeIconColor()

 Gets the secondary type-specific color for the type being manipulated SPinTypeSelector.h  

const FSlateBrush * GetSecondaryTypeIconImage()

 Gets the secondary icon (for maps, otherwise null) for the type being manipulated SPinTypeSelector.h  

FText GetToolTipForArrayWidget()

 Callback to get the tooltip for the array button widget SPinTypeSelector.h  

FText GetToolTipForComboBoxSecondaryType()

 Callback to get the tooltip text for the secondary pin type combo box SPinTypeSelector.h  

FText GetToolTipForComboBoxType()

 Callback to get the tooltip text for the pin type combo box SPinTypeSelector.h  

FText GetToolTipForContainerWidget()

 Callback to get the tooltip for the container type dropdown widget SPinTypeSelector.h  

void GetTypeChildren ( FPinTypeTreeItem InItem,
TArray< FPinTypeTreeItem >& OutChildren
)

   SPinTypeSelector.h  

FText GetTypeDescription ( bool bIncludeSubcategory
) const

 Gets a succinct type description for the type being manipulated SPinTypeSelector.h  

FSlateColor GetTypeIconColor()

 Gets the type-specific color for the type being manipulated SPinTypeSelector.h  

const FSlateBrush * GetTypeIconImage()

 Gets the icon (value, array, set, or map) for the type being manipulated SPinTypeSelector.h  

ECheckBoxState IsArrayChecked()

 Array checkbox support functions SPinTypeSelector.h  

void OnArrayCheckStateChanged ( ECheckBoxState NewState
)

   SPinTypeSelector.h  

void OnArrayStateToggled()

 Toggles the variable type as an array SPinTypeSelector.h  

void OnContainerTypeSelectionChanged ( EPinContainerType PinContainerType
)

 Updates the variable container type: SPinTypeSelector.h  

void OnCustomFilterChanged()

 Called whenever the custom filter options are changed. SPinTypeSelector.h  

void OnFilterTextChanged ( const FText& NewText
)

   SPinTypeSelector.h  

void OnFilterTextCommitted ( const FText& NewText,
ETextCommit::Type CommitInfo
)

   SPinTypeSelector.h  

void OnObjectReferenceSelectionChanged ( FObjectReferenceListItem InItem,
ESelectInfo::Type SelectInfo,
bool bForSecondaryType
)

   SPinTypeSelector.h  

void OnSelectPinType ( FPinTypeTreeItem InItem,
FName InPinCategory,
bool bForSecondaryType
)

 When a pin type is selected, handle it SPinTypeSelector.h  

void OnTypeSelectionChanged ( FPinTypeTreeItem Selection,
ESelectInfo::Type SelectInfo,
bool bForSecondaryType
)

   SPinTypeSelector.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< SWidget > ConstructPinTypeImage ( UEdGraphPin* Pin
)

   SPinTypeSelector.h  

static TSharedRef< SWidget > ConstructPinTypeImage ( TAttribute< const FSlateBrush* > PrimaryIcon,
TAttribute< FSlateColor > PrimaryColor,
TAttribute< const FSlateBrush* > SecondaryIcon,
TAttribute< FSlateColor > SecondaryColor
)

   SPinTypeSelector.h  

static TSharedRef< SWidget > ConstructPinTypeImage ( const FSlateBrush* PrimaryIcon,
const FSlateColor& PrimaryColor,
const FSlateBrush* SecondaryIcon,
const FSlateColor& SecondaryColor,
TSharedPtr< SToolTip > InToolTip
)

   SPinTypeSelector.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page