1. Epic GamesDeveloper
  3. SGraphActionMenu

SGraphActionMenu

Class that displays a list of graph actions and them to be searched and selected

API > API/Editor > API/Editor/GraphEditor

Class that displays a list of graph actions and them to be searched and selected

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

Syntax

class SGraphActionMenu :  
    public SCompoundWidget,  
    public FGCObject

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FCanRenameSelectedAction TBaseDelegate_OneParam< bool, TWeakPtr< FGraphActionNode > > Delegate executed to check if the selected action is valid for renaming SGraphActionMenu.h
FGetFilterText TBaseDelegate_NoParams< FText > Delegate to get the filter text SGraphActionMenu.h
FGetSectionTitle TBaseDelegate_OneParam< FText, int32 > Delegate to get the name of a section if the widget is a section separator. SGraphActionMenu.h
FGetSectionToolTip TBaseDelegate_OneParam< TSharedPtr< IToolTip >, int32 > Delegate to get the tooltip of a section if the widget is a section separator. SGraphActionMenu.h
FGetSectionWidget TBaseDelegate_TwoParams< TSharedRef< SWidget >, TSharedRef< SWidget >, int32 > Delegate to get the widget that appears on the section bar in the section separator. SGraphActionMenu.h
FOnActionDoubleClicked TBaseDelegate_OneParam< void, const TArray< TSharedPtr< FEdGraphSchemaAction > > & > Delegate executed when an action is double clicked SGraphActionMenu.h
FOnActionDragged TBaseDelegate_TwoParams< FReply, const TArray< TSharedPtr< FEdGraphSchemaAction > > &, const FPointerEvent & > Delegate executed when an action is dragged SGraphActionMenu.h
FOnActionMatchesName TBaseDelegate_TwoParams< bool, FEdGraphSchemaAction *, const FName & > Delegate to check if an action matches a specified name (used for renaming items etc.) SGraphActionMenu.h
FOnActionSelected TBaseDelegate_TwoParams< void, const TArray< TSharedPtr< FEdGraphSchemaAction > > &, ESelectInfo::Type > Delegate executed when an action is selected SGraphActionMenu.h
FOnCategoryDragged TBaseDelegate_TwoParams< FReply, const FText &, const FPointerEvent & > Delegate executed when a category is dragged SGraphActionMenu.h
FOnCategoryTextCommitted TBaseDelegate_ThreeParams< void, const FText &, ETextCommit::Type, TWeakPtr< FGraphActionNode > > Delegate executed when a category is being renamed so any post-rename actions can be handled SGraphActionMenu.h
FOnCollectAllActions TBaseDelegate_OneParam< void, FGraphActionListBuilderBase & > Delegate executed when the list of all actions needs to be refreshed SGraphActionMenu.h
FOnCollectStaticSections TBaseDelegate_OneParam< void, TArray< int32 > & > Delegate executed when the list of all actions needs to be refreshed, should return any sections that should always be visible, even if they don't have children. SGraphActionMenu.h
FOnCreateCustomRowExpander TBaseDelegate_OneParam< TSharedRef< SExpanderArrow >, FCustomExpanderData const & > Delegate that can be used to create a custom "expander" widget for a particular row SGraphActionMenu.h
FOnCreateWidgetForAction TBaseDelegate_OneParam< TSharedRef< SWidget >, FCreateWidgetForActionData *const > Delegate that can be used to create a widget for a particular action SGraphActionMenu.h
FOnGetActionList TBaseDelegate_NoParams< TSharedRef< FGraphActionListBuilderBase > > Delegate that can be used to create and/or get a custom action list. SGraphActionMenu.h

Constants

Name Type Remarks Include Path
LastUsedFilterText FString The last typed action within the graph action menu SGraphActionMenu.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DraggedFromPins TArray< UEdGraphPin * > The pins that have been dragged off of to prompt the creation of this action menu. SGraphActionMenu.h  
GraphObj UEdGraph * The graph that this menu is being constructed in SGraphActionMenu.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

 FGCObject override. SGraphActionMenu.h  

bool CanRequestRenameOnActionNode()

 Queries if a rename on the selected action node is possible SGraphActionMenu.h  

void Construct ( const FArguments& InArgs,
bool bIsReadOnly
)

   SGraphActionMenu.h  

void ExpandCategory ( const FText& CategoryName
)

 Expands any category with the associated name SGraphActionMenu.h  

void GenerateFilteredItems ( bool bPreserveExpansion
)

 Regenerated filtered results (FilteredRootAction) based on filter text SGraphActionMenu.h  

void GetCategorySubActions ( TWeakPtr< FGraphActionNode > InAction,
TArray< TSharedPtr< FEdGraphSchemaAction > >& OutActions
) const

 Get category child actions for the passed in action SGraphActionMenu.h  

TSharedRef< SEditableTextBox > GetFilterTextBox()

 Get filter text box widget SGraphActionMenu.h  

virtual FString GetReferencerName()

   SGraphActionMenu.h  

void GetSectionExpansion ( TMap< int32, bool >& SectionExpansion
) const

 Returns a map of all top level sections and their current expansion state. SGraphActionMenu.h  

void GetSelectedActions ( TArray< TSharedPtr< FEdGraphSchemaAction > >& OutSelectedActions
) const

 Get action that is currently selected SGraphActionMenu.h  

FString GetSelectedCategoryName()

 Get category that is currently selected SGraphActionMenu.h  

void GetSelectedCategorySubActions ( TArray< TSharedPtr< FEdGraphSchemaAction > >& OutActions
) const

 Get category child actions that is currently selected SGraphActionMenu.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& KeyEvent
)

   SGraphActionMenu.h  

bool OnMouseButtonDownEvent ( TWeakPtr< FEdGraphSchemaAction > InAction
)

 Handler for mouse button going down SGraphActionMenu.h  

void OnRequestRenameOnActionNode()

 Initiates a rename on the selected action node, if possible SGraphActionMenu.h  

void RefreshAllActions ( bool bPreserveExpansion,
bool bHandleOnSelectionEvent
)

 Refreshes the actions that this widget should display SGraphActionMenu.h  

bool SelectItemByName ( const FName& ItemName,
ESelectInfo::Type SelectInfo,
int32 SectionId,
bool bIsCategory
)

 Selects an non-creation item in the list, searching by FName, deselects if name is none SGraphActionMenu.h  

void SetSectionExpansion ( const TMap< int32, bool >& SectionExpansion
)

 Sets the sections to be expanded of all top level sections. SGraphActionMenu.h  

void UpdateForNewActions ( int32 IdxStart
)

 Updates the displayed list starting from IdxStart, useful for async building the display list of actions SGraphActionMenu.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool CanRenameNode ( TWeakPtr< FGraphActionNode > InNode
) const

 Checks if the passed in node is safe for renaming SGraphActionMenu.h  

const TArray< TSharedPtr< FGraphActionNode > > & GetFilteredActionNodes ( int32* OutSelectedIndex
)

   SGraphActionMenu.h  

FText GetFilterText()

 Get current filter text SGraphActionMenu.h  

TSharedPtr< FGraphActionNode > GetFirstAction()

 General helper functions for accessing the filtered tree SGraphActionMenu.h  

int32 GetTotalLeafNodes()

   SGraphActionMenu.h  

bool HandleSelection ( TSharedPtr< FGraphActionNode >& InSelectedItem,
ESelectInfo::Type InSelectionType
)

 Executes the selection delegate providing it has been bound, and the provided action node given is valid and is an action node SGraphActionMenu.h  

TSharedRef< ITableRow > MakeWidget ( TSharedPtr< FGraphActionNode > InItem,
const TSharedRef< STableViewBase >& OwnerTable,
bool bIsReadOnly
)

 Create widget for the supplied node SGraphActionMenu.h  

void MarkActiveSuggestion()

 Change the selection to reflect the active suggestion SGraphActionMenu.h  

void OnFilterTextChanged ( const FText& InFilterText
)

 Called when filter text changes SGraphActionMenu.h  

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

 Called when enter is hit in search box SGraphActionMenu.h  

void OnGetChildrenForCategory ( TSharedPtr< FGraphActionNode > InItem,
TArray< TSharedPtr< FGraphActionNode > >& OutChildren
)

 Get children SGraphActionMenu.h  

void OnItemDoubleClicked ( TSharedPtr< FGraphActionNode > InClickedItem
)

 Called when tree item is double clicked SGraphActionMenu.h  

FReply OnItemDragDetected ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Called when tree item dragged SGraphActionMenu.h  

void OnItemScrolledIntoView ( TSharedPtr< FGraphActionNode > InActionNode,
const TSharedPtr< ITableRow >& InWidget
)

 Handler for when an item has scrolled into view after having been requested to do so SGraphActionMenu.h  

void OnItemSelected ( TSharedPtr< FGraphActionNode > InSelectedItem,
ESelectInfo::Type SelectInfo
)

 Called when tree item is selected SGraphActionMenu.h  

void OnNameTextCommitted ( const FText& NewText,
ETextCommit::Type InTextCommit,
TWeakPtr< FGraphActionNode > InAction
)

 Callback when rename text is committed SGraphActionMenu.h  

void OnSetExpansionRecursive ( TSharedPtr< FGraphActionNode > InTreeNode,
bool bInIsItemExpanded
)

 Callback for expanding tree items recursively SGraphActionMenu.h  

void ScoreAndAddActions ( int32 StartingIndex
)

 Helper function for adding and scoring actions from our builder SGraphActionMenu.h  

void SelectFirstAction()

   SGraphActionMenu.h  

void SelectLastAction()

   SGraphActionMenu.h  

void SelectNextAction ( int32 Num
)

   SGraphActionMenu.h  

void SelectPreviousAction ( int32 Num
)

 Helper functions for keyboard interaction SGraphActionMenu.h  

bool ShouldExpandNodes()

 Returns true if the tree should be autoexpanded SGraphActionMenu.h  

bool TryToSpawnActiveSuggestion()

 Try to spawn the node reflected by the active suggestion SGraphActionMenu.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page