1. Epic GamesDeveloper
  3. FNavigationToolItem

FNavigationToolItem

Base Implementation of [INavigationToolItem](API\Plugins\SequenceNavigator\INavigationToolItem)

API > API/Plugins > API/Plugins/SequenceNavigator

Base Implementation of INavigationToolItem

   
Name FNavigationToolItem
Type class
Header File /Engine/Plugins/Experimental/SequenceNavigator/Source/SequenceNavigator/Public/Items/NavigationToolItem.h
Include Path #include "Items/NavigationToolItem.h"

Syntax

class FNavigationToolItem :  
    public UE::SequenceNavigator::INavigationToolItem ,  
    public UE::SequenceNavigator::IColorExtension

Derived Classes

FNavigationToolItem derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FNavigationToolItem ( INavigationTool& InTool,
const FNavigationToolItemPtr& InParentItem
)

   Items/NavigationToolItem.h  

Typedefs

Name Type Remarks Include Path
FNavigationToolGetToolState TBaseDelegate_OneParam< FNavigationToolSaveState *, const FNavigationToolItemPtr >   Items/NavigationToolItem.h
FNavigationToolItemInherits TNavigationToolItemInherits< FNavigationToolItem, INavigationToolItem, IColorExtension >   Items/NavigationToolItem.h
Super INavigationToolItem   Items/NavigationToolItem.h

Functions

Public

Overridden from INavigationToolItem

Name Remarks Include Path Unreal Specifiers

virtual FReply AcceptDrop ( const FDragDropEvent& InDragDropEvent,
EItemDropZone InDropZone
)

 Processes the Drag and Drop Event for this Item Items/NavigationToolItem.h  

virtual bool AddChild ( const FNavigationToolAddItemParams& InAddItemParams
)

 Adds another Child under this Item if such Item is supported. Items/NavigationToolItem.h  

virtual void AddFlags ( ENavigationToolItemFlags Flags
)

   Items/NavigationToolItem.h  

virtual TOptional< EItemDropZone > CanAcceptDrop ( const FDragDropEvent& InDragDropEvent,
EItemDropZone InDropZone
)

 Determines if and where the incoming Drag Drop Event can be processed by this item Items/NavigationToolItem.h  

virtual bool CanAddChild ( const FNavigationToolItemPtr& InChild
) const

 Determines whether the given Child is supported and can be added under this Item Items/NavigationToolItem.h  

virtual bool CanAutoExpand()

 Whether the Item is able to expand when AutoExpand functionality is enabled Items/NavigationToolItem.h  

virtual bool CanBeTopLevel ()

 Whether this Item can be at the Top Level just beneath the Root, or it needs to always be under some other Item E.g. Items/NavigationToolItem.h  

virtual bool CanDelete()

 Whether this Item can be deleted or not Items/NavigationToolItem.h  

virtual bool CanReceiveParentVisibilityPropagation()

 Whether a change in Parent Visibility should also affect this Item's Visibility Items/NavigationToolItem.h  

virtual bool Delete()

 The implementation to delete the item Items/NavigationToolItem.h  

virtual void FindChildren ( TArray< FNavigationToolItemPtr >& OutChildren,
const bool bInRecursive
)

 Figures out the Children of this Item. Items/NavigationToolItem.h  

virtual TArray< FNavigationToolItemPtr > FindPath ( const TArray< FNavigationToolItemPtr >& Items
) const

 Tries to Find the First Path of Descendants (not including self) that lead to a given Item in the Set. Items/NavigationToolItem.h  

virtual void FindValidChildren ( TArray< FNavigationToolItemPtr >& OutChildren,
const bool bInRecursive
)

   Items/NavigationToolItem.h  

virtual TSharedRef< SWidget > GenerateLabelWidget ( const TSharedRef< SNavigationToolTreeRow >& InRow
)

 Function responsible of Generating the Label Widget for this Item (i.e. the column containing the Icon and the Name) Items/NavigationToolItem.h  

virtual IndexType GetChildIndex ( const FNavigationToolItemPtr& ChildItem
) const

 Gets the Index that the given Child Item is at. Items/NavigationToolItem.h  

virtual const TArray< FNavigationToolItemPtr > & GetChildren()

 Gets the current Child Items of this Item Items/NavigationToolItem.h  

virtual TArray< FNavigationToolItemPtr > & GetChildrenMutable()

 Gets the current Child Items of this Item Items/NavigationToolItem.h  

virtual FText GetClassName()

 Gets the Class/Type of this Item (e.g. for Items that represent UObjects, it will be the UObject class) Items/NavigationToolItem.h  

virtual FText GetDisplayName()

 Gets the Display NameText of the Item Items/NavigationToolItem.h  

virtual ENavigationToolItemFlags GetFlags()

   Items/NavigationToolItem.h  

virtual const FSlateBrush * GetIconBrush()

   Items/NavigationToolItem.h  

virtual FSlateColor GetIconColor()

 Gets the color for the item icon Items/NavigationToolItem.h  

virtual FNavigationToolItemId GetItemId()

 Gets the Id of this Item Items/NavigationToolItem.h  

virtual FSlateColor GetItemLabelColor()

 Gets the color to use for the item label Items/NavigationToolItem.h  

virtual FLinearColor GetItemTintColor()

 Gets the color to use to tint the entire item row (all column content) Items/NavigationToolItem.h  

virtual INavigationTool & GetOwnerTool()

 Gets the Navigation Tool that owns this item Items/NavigationToolItem.h  

virtual FNavigationToolItemPtr GetParent ()

 Gets the Parent of this Item. Items/NavigationToolItem.h  

virtual TSharedPtr< FNavigationToolProvider > GetProvider()

 Gets the module provider responsible for the creation of this item Items/NavigationToolItem.h  

virtual FNavigationToolSaveState * GetProviderSaveState()

 Gets the providers saved state Items/NavigationToolItem.h  

virtual ENavigationToolItemViewMode GetSupportedViewModes ( const INavigationToolView& InToolView
) const

 Gets the View Modes that this Item Supports Items/NavigationToolItem.h  

virtual TArray< FName > GetTags()

 Gets the Tags found for this Item (e.g. for Actors, actor tags and for Components Component Tags) Items/NavigationToolItem.h  

virtual bool GetVisibility()

 Whether this Item is currently visible or not for the Given Type Items/NavigationToolItem.h  

virtual bool HasAllFlags ( ENavigationToolItemFlags Flags
) const

   Items/NavigationToolItem.h  

virtual bool HasAnyFlags ( ENavigationToolItemFlags Flags
) const

   Items/NavigationToolItem.h  

virtual bool IsAllowedInTool()

 Returns whether this Item (and what it represents) should be allowed to be registered in Navigation Tool Items/NavigationToolItem.h  

virtual bool IsExpanded()

 Gets whether this item is expanded Items/NavigationToolItem.h  

virtual bool IsItemValid()

 Determines whether the Item properties are in a valid state Items/NavigationToolItem.h  

virtual FOnExpansionChanged & OnExpansionChanged()

 Called when Expansion state (Expanded/Collapsed) has been changed Items/NavigationToolItem.h  

virtual FOnRenameAction & OnRenameAction()

 Broadcasts whenever a rename action takes place from a given view (e.g. when pressing "F2" to rename, or committing the rename text) Items/NavigationToolItem.h  

virtual void RefreshChildren()

 Refreshes what the Parent and Children are of this Item. (not recursive!) Items/NavigationToolItem.h  

virtual bool RemoveChild ( const FNavigationToolRemoveItemParams& InRemoveItemParams
)

 Removes the given child from this Item if it was ever indeed a child. Items/NavigationToolItem.h  

virtual void RemoveFlags ( ENavigationToolItemFlags Flags
)

   Items/NavigationToolItem.h  

virtual void ResetChildren()

 Resets both the Cached Visible Children and Children (before doing so, sets all child's parents to null) Items/NavigationToolItem.h  

virtual void SetExpansion ( const bool bInIsExpanded
)

 Sets the expansion state of this item Items/NavigationToolItem.h  

virtual void SetFlags ( ENavigationToolItemFlags InFlags
)

   Items/NavigationToolItem.h  

virtual void SetParent ( FNavigationToolItemPtr InParent
)

 Sets the Parent. Note that the Parent must've already have this instance as a child (check is done) Items/NavigationToolItem.h  

virtual bool ShouldSort ()

 Determines whether this item can be sorted by the Navigation Tool or not. Items/NavigationToolItem.h  

virtual bool ShowVisibility()

 Whether this Item supports Visibility for the Given Type Items/NavigationToolItem.h  

Overridden from INavigationToolItemTypeCastable

Name Remarks Include Path Unreal Specifiers

virtual const void * CastTo_Impl ( FNavigationToolItemTypeId InCastToType
) const

   Items/NavigationToolItem.h  

virtual FNavigationToolItemTypeId GetTypeId()

   Items/NavigationToolItem.h  

Overridden from IColorExtension

Name Remarks Include Path Unreal Specifiers

virtual TOptional< FColor > GetColor()

   Items/NavigationToolItem.h  

virtual void SetColor ( const TOptional< FColor >& InColor
)

   Items/NavigationToolItem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddChildChecked ( const FNavigationToolAddItemParams& InAddItemParams
)

 The actual implementation of putting the given Item under the Children array Items/NavigationToolItem.h  

FNavigationToolItemId CalculateItemId()

 Gets the Item Id with the latest information (e.g. parent, object, etc) Items/NavigationToolItem.h  

void HandleNewSortableChildren ( TArray< FNavigationToolItemPtr > InSortableChildren
)

 Careful handling of multiple children being detected and added to this item children array Items/NavigationToolItem.h  

void RecalculateItemId()

 Sets the ItemId member var to what CalculateItemId returns Items/NavigationToolItem.h  

bool RemoveChildChecked ( const FNavigationToolRemoveItemParams& InRemoveItemParams
)

 The actual implementation of removing the given item from the Children array Items/NavigationToolItem.h  

void SetProvider ( const TWeakPtr< FNavigationToolProvider >& InWeakProvider
)

   Items/NavigationToolItem.h  

Static

Name Remarks Include Path Unreal Specifiers

static FNavigationToolItemTypeId GetStaticTypeId()

   Items/NavigationToolItem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page