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

Inheritance Hierarchy

References

   
Module GraphEditor
Header /Engine/Source/Editor/GraphEditor/Public/SGraphActionMenu.h
Include #include "SGraphActionMenu.h"

Syntax

class SGraphActionMenu :  
    public SCompoundWidget,  
    public FGCObject

Remarks

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

Variables

  Type Name Description
Protected variable TSharedPtr< FGraphActionListBuilderBase > AllActions List of all actions we can browser
Protected variable bool bAllowPreselectedItemActivation Whether we allow pre-selected items to be activated with a left-click
Protected variable bool bAlphaSortItems Don't sort items alphabetically
Protected variable bool bAutoExpandActionMenu Should we auto-expand categories
Protected variable bool bIgnoreUIUpdate Allows us to set selection (via keyboard) without triggering action
Protected variable bool bShowFilterTextBox Should we display the filter text box
Protected variable bool bSortItemsRecursively If only the top entries should be sorted or subentries as well
Protected variable bool bUseSectionStyling Should the rows and sections be styled like the details panel?
Protected variable TArray< TSharedPtr< FGraphActionNode > > FilteredActionNodes Flattened list of all actions passing the filter
Protected variable TSharedPtr< FGraphActionNode > FilteredRootAction Root of filtered actions tree
Protected variable TSharedPtr< SSearchBox > FilterTextBox Text box used for searching for actions
Protected variable FOnActionDoubleClicked OnActionDoubleClicked Delegate to call when action is double clicked
Protected variable FOnActionDragged OnActionDragged Delegate to call when an action is dragged.
Protected variable FOnActionMatchesName OnActionMatchesName Delegate to check if an action matches a specified name (used for renaming items etc.)
Protected variable FOnActionSelected OnActionSelected Delegate to call when action is selected
Protected variable FCanRenameSelectedAction OnCanRenameSelectedAction Delegate to call to check if a selected action is valid for renaming
Protected variable FOnCategoryDragged OnCategoryDragged Delegate to call when a category is dragged.
Protected variable FOnCategoryTextCommitted OnCategoryTextCommitted Delegate to call to handle any post-category rename events
Protected variable FOnCollectAllActions OnCollectAllActions Delegate to call to collect all actions
Protected variable FOnCollectStaticSections OnCollectStaticSections Delegate to call to collect all always visible sections
Protected variable FOnCreateCustomRowExpander OnCreateCustomRowExpander Delegate to call for creating a custom "expander" widget for indenting a menu row with
Protected variable FOnCreateWidgetForAction OnCreateWidgetForAction Delegate to call to create widget for an action
Protected variable FOnGetActionList OnGetActionList Delegate to call to get a custom action list
Protected variable FGetFilterText OnGetFilterText Delegate to get the filter text if supplied from an external source
Protected variable FGetSectionTitle OnGetSectionTitle Delegate to get the name of a section separator.
Protected variable FGetSectionToolTip OnGetSectionToolTip Delegate to get the tooltip of a section separator.
Protected variable FGetSectionWidget OnGetSectionWidget Delegate to get the widgets of a section separator.
Protected variable int32 SelectedSuggestion Used to track selected action for keyboard interaction
Protected variable float SelectedSuggestionScore Stored score for our current selection, so that we can quickly maintain selection when building the list asynchronously
Protected variable int32 SelectedSuggestionSourceIndex Stored index in the AllActions list builder that we think is the best fit
Protected variable TSharedPtr< STreeView< TSharedPtr< FGraphActionNode > > > TreeView Tree view for showing actions

Functions

  Type Name Description
Protected function Const bool Checks if the passed in node is safe for renaming
Public function Const bool Queries if a rename on the selected action node is possible
Public function void

Construct ( const FArguments& InArgs,
bool bIsReadOnly
)

  
Public function void

ExpandCategory ( const FText& CategoryName
)

 Expands any category with the associated name
Public function void

GenerateFilteredItems ( bool bPreserveExpansion
)

 Regenerated filtered results (FilteredRootAction and FilteredActionNodes) based on filter text
Public function Const void Get category child actions for the passed in action
Protected function Const FText Get current filter text
Public function TSharedRef< SEditableTextBox > Get filter text box widget
Public function Const void

GetSectionExpansion ( TMap< int32, bool >& SectionExpansion
)

 Returns a map of all top level sections and their current expansion state.
Public function Const void Get action that is currently selected
Public function Const FString Get category that is currently selected
Public function Const void Get category child actions that is currently selected
Protected function 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
Protected function TSharedRef< ITableRow >

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

 Create widget for the supplied node
Protected function void Change the selection to reflect the active suggestion
Protected function void

OnFilterTextChanged ( const FText& InFilterText
)

 Called when filter text changes
Protected function void

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

 Called when enter is hit in search box
Protected function void Get children
Protected function void Called when tree item is double clicked
Protected function FReply

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

 Called when tree item dragged
Protected function 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
Protected function void

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

 Called when tree item is selected
Public function bool Handler for mouse button going down
Protected function void

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

 Callback when rename text is committed
Public function void Initiates a rename on the selected action node, if possible
Protected function void

OnSetExpansionRecursive ( TSharedPtr< FGraphActionNode > InTreeNode,
bool bInIsItemExpanded
)

 Callback for expanding tree items recursively
Public function void

RefreshAllActions ( bool bPreserveExpansion,
bool bHandleOnSelectionEvent
)

 Refreshes the actions that this widget should display
Protected function FScoreResults

ScoreAndAddActions ( int32 StartingIndex
)

  
Public function 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
Public function void

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

 Sets the sections to be expanded of all top level sections.
Protected function Const bool Returns true if the tree should be autoexpanded
Protected function bool Try to spawn the node reflected by the active suggestion
Protected function void Helper function to update the active selection after updating the displayed tree
Public function void

UpdateForNewActions ( int32 IdxStart
)

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

Overridden from SWidget

  Type Name Description
Public function Virtual FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Overridden from FGCObject

  Type Name Description
Public function Virtual void FGCObject override.
Public function Virtual Const FString Overload this method to report a name for your referencer

Classes

  Type Name Description
Public struct FArguments    
Protected struct FScoreResults Helper function for adding and scoring actions from our builder  

Typedefs

Name Description
FCanRenameSelectedAction Delegate executed to check if the selected action is valid for renaming
FGetFilterText Delegate to get the filter text
FGetSectionTitle Delegate to get the name of a section if the widget is a section separator.
FGetSectionToolTip Delegate to get the tooltip of a section if the widget is a section separator.
FGetSectionWidget Delegate to get the widget that appears on the section bar in the section separator.
FOnActionDoubleClicked Delegate executed when an action is double clicked
FOnActionDragged Delegate executed when an action is dragged
FOnActionMatchesName Delegate to check if an action matches a specified name (used for renaming items etc.)
FOnActionSelected Delegate executed when an action is selected
FOnCategoryDragged Delegate executed when a category is dragged
FOnCategoryTextCommitted Delegate executed when a category is being renamed so any post-rename actions can be handled
FOnCollectAllActions Delegate executed when the list of all actions needs to be refreshed
FOnCollectStaticSections 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.
FOnCreateCustomRowExpander Delegate that can be used to create a custom "expander" widget for a particular row
FOnCreateWidgetForAction Delegate that can be used to create a widget for a particular action
FOnGetActionList Delegate that can be used to create and/or get a custom action list.

Constants

Name Description
LastUsedFilterText The last typed action within the graph action menu

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page