1. Epic GamesDeveloper
  3. SPinTypeSelector

SPinTypeSelector

Widget for modifying the type for a variable or pin

Unreal Engine C++ API Reference > Editor > KismetWidgets

Inheritance Hierarchy

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

  Type Name Description
Protected variable TArray< FObjectReferenceListItem > AllowedObjectReferenceTypes Holds a cache of the allowed Object Reference types for the last sub-menu opened.
Protected variable bool bIsRightMousePressed TRUE when the right mouse button is pressed, keeps from handling a right click that does not begin in the widget
Protected variable bool bMenuContentIsSecondary True if GetMenuContent was last called with bForSecondaryType == true
Protected variable TArray< FObjectReferenceListItem > CurrentPinAllowedObjectReferenceTypes Holds a cache of the allowed Object Reference types for the current pin type, to be shown inline.
Protected variable TArray< TSharedPtr< class IPinTypeSelectorFilter > > CustomFilters An interface to optionally apply a custom filter to the available pin type items for display.
Protected variable TArray< FPinTypeTreeItem > FilteredTypeTreeRoot Array containing a filtered list, according to the text in the searchbox
Protected variable TSharedPtr< SSearchBox > FilterTextBox  
Protected variable 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)
Protected variable TSharedPtr< SMenuOwner > MenuContent Reference to the menu content that's displayed when the type button is clicked on
Protected variable int32 NumFilteredPinTypeItems Total number of filtered pin type items. This count excludes category items and reference subtypes.
Protected variable FOnPinTypeChanged OnTypeChanged Delegate that is called every time the pin type changes (before and after).
Protected variable FOnPinTypeChanged OnTypePreChanged  
Protected variable TWeakPtr< SMenuOwner > PinTypeSelectorMenuOwner  
Protected variable TAttribute< bool > ReadOnly Whether or not the type is read only and not editable (implies a different style)
Protected variable const UEdGraphSchema * Schema Schema in charge of determining available types for this pin
Protected variable TWeakPtr< const FEdGraphSchemaAction > SchemaAction Schema action related to the pin selection
Protected variable FText SearchText Type searching support
Protected variable TSharedPtr< SComboButton > SecondaryTypeComboButton  
Protected variable ESelectorType SelectorType Whether the selector is using the compact or full mode, or not a selector at all, but just the type image.
Protected variable TAttribute< FEdGraphPinType > TargetPinType The pin attribute that we're modifying with this widget
Protected variable TAttribute< FOptionalSize > TreeViewHeight Desired height of the tree view widget
Protected variable TAttribute< FOptionalSize > TreeViewWidth Desired width of the tree view widget
Protected variable TSharedPtr< SComboButton > TypeComboButton  
Protected variable ETypeTreeFilter TypeTreeFilter UEdgraphSchema::ETypeTreeFilter flags for filtering available types
Protected variable TArray< FPinTypeTreeItem > TypeTreeRoot Array containing the unfiltered list of all supported types this pin could possibly have
Protected variable TSharedPtr< SPinTypeTreeView > TypeTreeView  
Protected variable TWeakPtr< SListView< FObjectReferenceListItem > > WeakListView  

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs,
FGetPinTypeTree GetPinTypeTreeFunc
)

  
Public function Static TSharedRef< SWidget >  
Public function Static TSharedRef< SWidget >

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

  
Public function Static TSharedRef< SWidget >

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

  
Protected function Const TSharedRef< SWidget >

CreateObjectReferenceWidget ( FPinTypeTreeItem InItem,
FEdGraphPinType& InPinType,
const FSlateBrush* InIconBrush,
FText InSimpleTooltip
)

 Helper function to create widget for the sub-menu
Protected function Const void

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

 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
Protected function TSharedRef< ITableRow >

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

 Listview support functions for sub-menu
Protected function Virtual TSharedRef< ITableRow >

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

 Treeview support functions
Protected function TSharedRef< SWidget >

GetAllowedObjectTypes ( FPinTypeTreeItem InItem,
bool bForSecondaryType
)

 Gets the allowable object types for an tree item, used for building the sub-menu
Protected function 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
Protected function bool

GetChildrenWithSupportedTypes ( const TArray< FPinTypeTreeItem >& UnfilteredList,
TArray< FPinTypeTreeItem >& OutFilteredList
)

 Helper to generate the filtered list of types, based on the supported types of the schema
Protected function Const FText

GetCombinedTypeDescription ( bool bIncludeSubcategory
)

 Gets a combined description of the primary, container, and secondary types.
Protected function Virtual TSharedRef< SWidget >

GetMenuContent ( bool bForSecondaryType
)

  
Protected function TSharedRef< SWidget >  
Protected function Const FText Callback to get the display text for the total pin type item count
Protected function Const FText

GetSecondaryTypeDescription ( bool bIncludeSubcategory
)

 Gets the secondary type description. E.g. the value type for TMaps
Protected function Const FSlateColor Gets the secondary type-specific color for the type being manipulated
Protected function Const const FSlateBrush * Gets the secondary icon (for maps, otherwise null) for the type being manipulated
Protected function Const FText Callback to get the tooltip for the array button widget
Protected function Const FText Callback to get the tooltip text for the secondary pin type combo box
Protected function Const FText Callback to get the tooltip text for the pin type combo box
Protected function Const FText Callback to get the tooltip for the container type dropdown widget
Protected function void

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

  
Protected function Const FText

GetTypeDescription ( bool bIncludeSubcategory
)

 Gets a succinct type description for the type being manipulated
Protected function Const FSlateColor Gets the type-specific color for the type being manipulated
Protected function Const const FSlateBrush * Gets the icon (value, array, set, or map) for the type being manipulated
Protected function Const ECheckBoxState Array checkbox support functions
Protected function void

OnArrayCheckStateChanged ( ECheckBoxState NewState
)

  
Protected function void Toggles the variable type as an array
Protected function void

OnContainerTypeSelectionChanged ( EPinContainerType PinContainerType
)

 Updates the variable container type:
Protected function void Called whenever the custom filter options are changed.
Protected function void

OnFilterTextChanged ( const FText& NewText
)

  
Protected function void

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

  
Protected function void

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

  
Protected function void

OnSelectPinType ( FPinTypeTreeItem InItem,
FName InPinCategory,
bool bForSecondaryType
)

 When a pin type is selected, handle it
Protected function void

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

  

Overridden from SWidget

  Type Name Description
Public function Virtual 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.
Public function Virtual 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.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.

Classes

  Type Name Description
Public struct FArguments    

Enums

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page